The files in the subdirectories of this folder are organized by the type of file, and then named by the version of that file's schema. These YAML files are in the Kwalify format—see that site for documentation.
To validate your OpenControl files, do the following from your project root directory:
-
Install Python (2 or 3).
-
Ignore the
schemas/
directory from version control (e.g..gitignore
). -
Clone (or update) the schemas repository.
git clone https://github.com/opencontrol/schemas.git # or cd schemas && git pull origin master && cd ..
-
Install the dependencies.
pip install -r pip install -r schemas/kwalify/requirements.txt
-
Run the tests.
pytest
For a more advanced setup, see 18F's cloud.gov compliance repository as an example of using these tests as part of continuous integration.