Skip to content

Commit caaaf39

Browse files
committed
style: 🎨 reformat Markdown
1 parent 9dcffef commit caaaf39

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

posts/published-check-datapackage/index.qmd

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,28 @@ Package](https://decisions.seedcase-project.org/why-frictionless-data/)
1717
is correct and compliant with the [Data Package
1818
standard](https://datapackage.org). Since we are and will be working
1919
with and managing many Data Packages over the coming years, this is an
20-
important tool for us to have! Generally, this will be a helpful tool for anyone working with and managing Data Packages.
20+
important tool for us to have! Generally, this will be a helpful tool
21+
for anyone working with and managing Data Packages.
2122

2223
## What's `check-datapackage`?
2324

2425
As with all our packages and software tools, we have a dedicated website
2526
for
2627
[`check-datapackage`](https://check-datapackage.seedcase-project.org).
2728
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:
3031

3132
> Ensure the compliance of your Data Package metadata
3233
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.
3942

4043
For now, `check-datapackage` is only a few Python functions and classes
4144
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.
4649

4750
## Why use it?
4851

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
5154
include extra dependencies or features that you might not need. We
5255
wanted it lightweight and easy to use.
5356

@@ -57,7 +60,8 @@ Packages, such as the
5760
didn't want all the extras that came with these packages. Nor are these
5861
tools easy to configure for our needs. In this regard, there were no
5962
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!
6165

6266
Eventually, when we develop `check-datapackage` as a CLI, you could
6367
include it as a [pre-commit hook](https://pre-commit.com/) or part of
@@ -73,9 +77,10 @@ your configuration.
7377
We have a detailed
7478
[guide](https://check-datapackage.seedcase-project.org/docs/guide/) on
7579
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
83+
checks it against the standard.
7984

8085
``` python
8186
import check_datapackage as cdp
@@ -118,7 +123,8 @@ cdp.check(properties, error=True)
118123

119124
If you want to exclude certain checks, you can do that by using the
120125
`Config` and `Exclusion` classes. For example, if you want to exclude
121-
all required checks, you can define the exclusion, add it to the configuration, and pass it to the check function like so:
126+
all required checks, you can define the exclusion, add it to the
127+
configuration, and pass it to the check function like so:
122128

123129
``` python
124130
exclusion_required = cdp.Exclusion(type="required")

0 commit comments

Comments
 (0)