Check datapackage logo.

Check datapackage font.

Ensure the compliance of your Data Package metadata

Overview Explore guide

Copier Python Version from PEP 621 TOML GitHub License GitHub Release Build documentation Check package OpenSSF Scorecard CodeQL code coverage pre-commit.ci status lifecycle Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

check-datapackage is a Python package that checks your Data Package’s metadata against the Data Package standard, to ensure that your metadata is compliant with the standard.

Key features ✨

  • Checks your metadata in datapackage.json against the Data Package standard.
  • Enables you to configure which components of the metadata should or should not be checked.
  • Enables you to turn off specific checks defined in the standard.
  • Supports user-defined, custom checks.
  • Provides clear and user-friendly messages that point directly to where issues occur in the metadata.
  • Supports a strict mode that enforces full compliance with the standard, including not only the checks defined by the Data Package specification as “MUST” but also those marked as “SHOULD”.

⚠️ Note that check-datapackage only checks the metadata in your datapackage.json file against the Data Package standard—it does not check the data itself against the metadata.

About the Seedcase Project

check-datapackage is part of the Seedcase Project, which helps research projects manage and process data in line with the FAIR principles.

This package works as a standalone tool but is also integrated in Seedcase Sprout, a Python package that provides a framework for growing structured, organised, and FAIR data.

Check out Sprout

Want to contribute?

We would love your feedback or contributions! Head over to the GitHub repository to share your ideas or contribute code. Your input makes us better!