|
1 | 1 | --- |
2 | 2 | title: "Overview" |
3 | 3 | --- |
| 4 | + |
| 5 | +## What is `check-datapackage`? |
| 6 | + |
| 7 | +`check-datapackage` is a simple Python package that checks your [Data |
| 8 | +Package's](https://datapackage.org) `datapackage.json` file for |
| 9 | +compliance with the [Data Package |
| 10 | +specification](https://datapackage.org/standard/data-package/). |
| 11 | + |
| 12 | +## Why use it? |
| 13 | + |
| 14 | +[Frictionless Data](https://frictionlessdata.io), who initially |
| 15 | +started and developed the Data Package specification, has several tools |
| 16 | +(listed on the [Frictionless](https://frictionlessdata.io/universe/) and |
| 17 | +[Data Package](https://datapackage.org/overview/software/) websites) for |
| 18 | +working with Data Packages, including a Python package called |
| 19 | +[`frictionless`](https://pypi.org/project/frictionless/). However, the |
| 20 | +`frictionless` package is a large package that does many things, and it |
| 21 | +can be difficult to navigate the documentation and interface to find and |
| 22 | +use the specific functionality you need. It also still implements Data |
| 23 | +Package version 1, while the latest is version 2. |
| 24 | + |
| 25 | +Since we found ourselves missing a tool we needed for our project, the |
| 26 | +[Seedcase Project](https://github.com/seedcase-project), we decided to |
| 27 | +build this package. We wanted a small, well-designed, and easy-to-use |
| 28 | +package that only checks the compliance of a Data Package against the |
| 29 | +current standard. We designed it for future CLI support, for instance |
| 30 | +using it in a [pre-commit](https://pre-commit.com/) hook or in CI |
| 31 | +pipelines like [GitHub Actions](https://docs.github.com/en/actions). |
| 32 | + |
| 33 | +## Learning more |
| 34 | + |
| 35 | +This website contains documentation on `check-datapackage`'s design, how |
| 36 | +to use it, and details about the interface. |
| 37 | + |
| 38 | +- [How-to guide](/docs/guide/index.qmd): The guide section provides a |
| 39 | + step-by-step introduction to `check-datapackage`, including |
| 40 | + installing and using it. |
| 41 | +- [Reference](/docs/reference/index.qmd): The reference section |
| 42 | + contains detailed information about the `check-datapackage` API, |
| 43 | + specifically the documentation of individual classes and functions. |
| 44 | +- [Design](/docs/design/index.qmd): The design section describes the |
| 45 | + architecture and interface of `check-datapackage`, the requirements, |
| 46 | + use-cases, and [C4 model](https://c4model.com/) diagrams. |
| 47 | + |
| 48 | +## Contributors |
| 49 | + |
| 50 | +{{< include /docs/includes/_contributors.qmd >}} |
0 commit comments