check-jsonschema0.29.4
check-jsonschema0.29.4
Published
A jsonschema CLI and pre-commit hook
pip install check-jsonschema
Package Downloads
Authors
Project URLs
Requires Python
>=3.8
Dependencies
- ruamel.yaml
==0.18.6 - jsonschema
<5.0,>=4.18.0 - regress
>=0.4.0 - requests
<3.0 - click
<9,>=8 - tomli
>=2.0; python_version < "3.11" - importlib-resources
>=1.4.0; python_version < "3.9" - pytest
<9; extra == "dev" - coverage
<8; extra == "dev" - pytest-xdist
<4; extra == "dev" - responses
==0.25.3; extra == "dev" - click-type-test
==0.0.7; python_version >= "3.10" and extra == "dev" - sphinx
<9; extra == "docs" - sphinx-issues
<5; extra == "docs" - furo
==2024.8.6; extra == "docs"
check-jsonschema
A JSON Schema CLI and pre-commit hook built on jsonschema. The schema may be specified as a local or remote (HTTP or HTTPS) file.
Remote files are automatically downloaded and cached if possible.
Usage
check-jsonschema can be installed and run as a CLI tool, or via pre-commit.
Example pre-commit config
The following configuration uses check-jsonschema to validate Github Workflow
files.
- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.29.4
hooks:
- id: check-github-workflows
args: ["--verbose"]
Installing and Running as a CLI Tool
Install with pipx or brew:
pipx install check-jsonschema
or
brew install check-jsonschema
Then run, as in
check-jsonschema --schemafile schema.json instance.json
Documentation
Full documentation can be found at https://check-jsonschema.readthedocs.io/