You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So, rather than repeat what is already in that website, this post gives
28
-
a very quick overview of what it is and why you might want to use it. It
28
+
a very quick overview of what this package does and why you might want to use it. It
29
29
can be summarised by its tagline:
30
30
31
31
> Ensure the compliance of your Data Package metadata
32
32
33
-
The "only" thing it does is checks the content of a `datapackage.json`
33
+
The "only" thing `check-datapackage` does is to check the content of a `datapackage.json`
34
34
file against the standard. Nothing fancy. But we designed it to be
35
35
configurable, so that if you have specific needs for your Data Package,
36
-
you can adjust the checks accordingly. For example, if you want to
37
-
ensure that certain fields are always present in the metadata, you can
36
+
you can adjust the checks accordingly. It's possible to both add checks on top of the standard or ignore certain checks from the standard. For example, if you want to
37
+
ensure that certain fields that aren't required by the standard are always present in the metadata, you can
38
38
set up the checks to enforce that.
39
39
40
40
For now, `check-datapackage` is only a few Python functions and classes
41
41
that you can use within your own Python scripts. But in the future, we
42
42
plan to develop a command-line interface (CLI) so that you can use it
43
43
directly from your terminal without needing to write any code. Along
44
44
with including a config file, we hope to incorporate `check-datapackage`
45
-
into typical build tools or automated check workflows.
45
+
into typical build tools and automated check workflows.
46
46
47
47
## Why use it?
48
48
49
-
We wanted this package to be incredibly simple and focused in its scope.
49
+
We wanted this package to be incredibly simple and focused.
50
50
If you install or use it, you know exactly what it does. It also doesn't
51
51
include extra dependencies or features that you might not need. We
52
52
wanted it lightweight and easy to use.
@@ -56,32 +56,33 @@ Packages, such as the
56
56
[frictionless-py](https://pypi.org/project/frictionless/) package, we
57
57
didn't want all the extras that came with these packages. Nor are these
58
58
tools easy to configure for our needs. In this regard, there were no
59
-
tools available that fit ours needs. So we built our own package that
60
-
does exactly what we need. And hopefully it might be useful for you too!
59
+
tools available that fit ours needs. So, we built our own package that
60
+
does exactly what we need. Hopefully, it will be useful for other people too!
61
61
62
62
Eventually, when we develop `check-datapackage` as a CLI, you could
63
63
include it as a [pre-commit hook](https://pre-commit.com/) or part of
0 commit comments