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 this package does and why you might want to use it. It
29
-
can be summarised by its tagline:
29
+
a very quick overview of what this package does and why you might want
30
+
to use it. It can be summarised by its tagline:
30
31
31
32
> Ensure the compliance of your Data Package metadata
32
33
33
-
The "only" thing `check-datapackage` does is to check the content of a `datapackage.json`
34
-
file against the standard. Nothing fancy. But we designed it to be
35
-
configurable, so that if you have specific needs for your Data Package,
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
-
set up the checks to enforce that.
34
+
The "only" thing `check-datapackage` does is to check the content of a
35
+
`datapackage.json` file against the standard. Nothing fancy. But we
36
+
designed it to be configurable, so that if you have specific needs for
37
+
your Data Package, you can adjust the checks accordingly. It's possible
38
+
to both add checks on top of the standard or ignore certain checks from
39
+
the standard. For example, if you want to ensure that certain fields
40
+
that aren't required by the standard are always present in the metadata,
41
+
you can set up the checks to enforce that.
39
42
40
43
For now, `check-datapackage` is only a few Python functions and classes
41
44
that you can use within your own Python scripts. But in the future, we
@@ -46,8 +49,8 @@ into typical build tools and automated check workflows.
46
49
47
50
## Why use it?
48
51
49
-
We wanted this package to be incredibly simple and focused.
50
-
If you install or use it, you know exactly what it does. It also doesn't
52
+
We wanted this package to be incredibly simple and focused. If you
53
+
install or use it, you know exactly what it does. It also doesn't
51
54
include extra dependencies or features that you might not need. We
52
55
wanted it lightweight and easy to use.
53
56
@@ -57,7 +60,8 @@ Packages, such as the
57
60
didn't want all the extras that came with these packages. Nor are these
58
61
tools easy to configure for our needs. In this regard, there were no
59
62
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!
63
+
does exactly what we need. Hopefully, it will be useful for other people
64
+
too!
61
65
62
66
Eventually, when we develop `check-datapackage` as a CLI, you could
63
67
include it as a [pre-commit hook](https://pre-commit.com/) or part of
@@ -73,9 +77,10 @@ your configuration.
73
77
We have a detailed
74
78
[guide](https://check-datapackage.seedcase-project.org/docs/guide/) on
75
79
how to use `check-datapackage`. But I'll briefly show how you might use
76
-
`check-datapackage`. The main function of the package is `check()`, which
77
-
takes as input the properties of a Data Package (i.e., the contents of
78
-
the `datapackage.json` file) as a Python dictionary and checks it against the standard.
80
+
`check-datapackage`. The main function of the package is `check()`,
81
+
which takes as input the properties of a Data Package (i.e., the
82
+
contents of the `datapackage.json` file) as a Python dictionary and
0 commit comments