Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ from pypi.org.
- [Registry examples](#registry-examples)
- [Local rules](#local-rules)
- [PRONOM](#pronom)
- [JSONID for PRONOM Signature Development](#jsonid-for-pronom-signature-development)
- [Output format](#output-format)
- [Agent out](#agent-out)
- [Lookup](#lookup)
Expand Down Expand Up @@ -469,6 +470,37 @@ compatible snippet can be output as follows (UTF-8 shown for brevity):
</FFSignatureFile>
```

##### Installing json2pronom

You can install the standalone utility using pip as follows:

```cli
# optionally setup a virtual environment.
python -m venv venv
source venv/bin/activate
# install JSONID via pip.
python -m pip install jsonid
```

Once installed, invoke the following to see the command line options:

```cli
json2pronom -h
```

Given a custom patterns file named `patterns.json` you will run:

```cli
json2pronom --path patterns.json
```

and the output will be sent to `stdout` so will need to be piped to a file to
be used with DROID, e.g.

```cli
json2pronom --path patterns.json > jsonid_pronom.xml
```

<!--markdownlint-enable-->

Feedback on this utility is welcome. Hopefully we can build on this
Expand Down