check-datapackage: Ensure the compliance of your Data Package metadata

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

• 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 properties that must and should be included.

[!WARNING]

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.

[!TIP]

This Python package was generated from the template-python-package Seedcase template :tada:

Project files and folders

• .github/: Contains GitHub-specific files, such as issue and pull request templates, workflows, dependabot configuration, pull request templates, and a CODEOWNERS file.
• tools/vulture-allowlist.py: List of variables that shouldn’t be flagged by Vulture as unused.
• tools/get-contributors.sh: Script to get list of project contributors.
• tests/: Test files for the package.
• src/: Source code for the package.
• docs/: Documentation about using and developing the Python package.
• _renderer.py: Custom quartodoc renderer.
• pytest.ini: Pytest configuration file.
• mypy.ini: mypy configuration file for type checking Python code.
• .copier-answers.yml: Contains the answers you gave when copying the project from the template. You should not modify this file directly.
• .cz.toml: Commitizen configuration file for managing versions and changelogs.
• .pre-commit-config.yaml: Pre-commit configuration file for managing and running checks before each commit.
• .typos.toml: typos spell checker configuration file.
• justfile: just configuration file for scripting project tasks.
• .editorconfig: Editor configuration file for EditorConfig to maintain consistent coding styles across different editors and IDEs.
• CHANGELOG.md: Changelog file for tracking changes in the project.
• CITATION.cff: Structured citation metadata for your project.
• CONTRIBUTING.md: Guidelines for contributing to the project.
• _metadata.yml: Quarto metadata file for the website, including information about the project, such as the titles and GitHub names.
• pyproject.toml: Main Python project configuration file defining metadata and dependencies.
• _quarto.yml: Quarto configuration file for the website, including settings for the website, such as the theme, navigation, and other options.
• ruff.toml: Ruff configuration file for linting and formatting Python code.
• uv.lock: Lockfile used by uv to record exact versions of installed dependencies.
• .rumdl.toml: rumdl configuration file for formatting Markdown files so that they are standardized and consistent

Contributing

Check out our contributing document for information on how to contribute to the project, including how to set up your development environment.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributors

The following people have contributed to this project by submitting pull requests :tada:

@lwjohnst86, @signekb, @joelostblom, @martonvago

Licensing

This project is licensed under the MIT License.

Changelog

For a list of changes, see our changelog page.

Citing

This project is part of the Seedcase Project, which is a collaborative effort to create a framework for data management and analysis in research. If you use this project in your work, please cite it as follows:

Johnston L.W., Brødbæk S.K., Beicher K., Vago M., Ostblom J. (2025). Check Data Package: Ensure the correctness and compliance of your Data Package DOI: 10.5281/zenodo.17733655 URL: https://check-datapackage.seedcase-project.org

Or as a BibTeX entry:

@misc{YourReferenceHere,
author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton and Ostblom, Joel},
doi = {10.5281/zenodo.17733655},
month = {11},
title = {Check Data Package: Ensure the correctness and compliance of your Data Package},
url = {https://check-datapackage.seedcase-project.org},
year = {2025}
}