Rockefeller Archive Center JSON Schemas.
- Python 3.9 or higher
- rac-schema-validator
- tox (for running tests)
- pre-commit (for running linters before committing)
After installing pre-commit, install the git-hook scripts:
$ pre-commit install
These schemas are intended for use with the validators from rac-schema-validators
but they are also valid JSONSchema files and can be used with other JSONSchema
validators.
All schemas are located in the schemas/ directory.
rac_schemas comes with unit tests as well as linting. The easiest way to make sure all tests pass is to run tox from the root of the repository. This will execute all tests, and will also run autopep8 and flake8 linters against the codebase.
Automatically generated HTML documentation in the docs/ directory based upon .json files in the schemas/ subdirectory of the rac_schemas/ directory.
A simplified overview of the data model is below:
- Python 3.9 or higher
- json-schema-for-humans
Running generate_docs.py will iterate over the schemas/ subdirectory and write updated docs files to the docs/ directory.
Code is released under an MIT license. SeeLICENSE.md.