Skip to main content

A jsonschema CLI and pre-commit hook

Project description

pypi version supported pythons build pre-commit.ci status readthedocs documentation

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.3
  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/

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

check_jsonschema-0.29.3.tar.gz (244.3 kB view details)

Uploaded Source

Built Distribution

check_jsonschema-0.29.3-py3-none-any.whl (229.2 kB view details)

Uploaded Python 3

File details

Details for the file check_jsonschema-0.29.3.tar.gz.

File metadata

  • Download URL: check_jsonschema-0.29.3.tar.gz
  • Upload date:
  • Size: 244.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for check_jsonschema-0.29.3.tar.gz
Algorithm Hash digest
SHA256 3838b6d6da536496516d08a1779e7a11737628f84b444fe95d397b96fc8cc73f
MD5 c3218edbd17b0bbc7c9c737f661c1c2d
BLAKE2b-256 6160de055ac749fd6445e0a1c852ea5fc4726632fa3c19bd040f8e1315b87156

See more details on using hashes here.

Provenance

File details

Details for the file check_jsonschema-0.29.3-py3-none-any.whl.

File metadata

File hashes

Hashes for check_jsonschema-0.29.3-py3-none-any.whl
Algorithm Hash digest
SHA256 58d0486e951811744549fa40411e64a6d74bd88c94d9d7fd061e5bf635ff689c
MD5 a25836631da2f36910e79f27e85e9b6c
BLAKE2b-256 2699f3d050bac59230c769ce6b01e901ac380dbe7f4570a1aecb1a4b7dbfe6ed

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page