Overview
What is check-datapackage?
check-datapackage is a simple Python package that checks your Data Package’s datapackage.json file for compliance with the Data Package specification.
Why use it?
Frictionless Data, who initially started and developed the Data Package specification, has several tools (listed on the Frictionless and Data Package websites) for working with Data Packages, including a Python package called frictionless. However, the frictionless package is a large package that does many things, and it can be difficult to navigate the documentation and interface to find and use the specific functionality you need. It also still implements Data Package version 1, while the latest is version 2.
Since we found ourselves missing a tool we needed for our project, the Seedcase Project, we decided to build this package. We wanted a small, well-designed, and easy-to-use package that only checks the compliance of a Data Package against the current standard. We designed it for future CLI support, for instance using it in a pre-commit hook or in CI pipelines like GitHub Actions.
Learning more
This website contains documentation on check-datapackage’s design, how to use it, and details about the interface.
- How-to guide: The guide section provides a step-by-step introduction to
check-datapackage, including installing and using it. - Reference: The reference section contains detailed information about the
check-datapackageAPI, specifically the documentation of individual classes and functions. - Design: The design section describes the architecture and interface of
check-datapackage, the requirements, use-cases, and C4 model diagrams.
Contributors
The following people have contributed to this project by submitting pull requests 🎉