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

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.27.4.tar.gz (238.0 kB view details)

Uploaded Source

Built Distribution

check_jsonschema-0.27.4-py3-none-any.whl (231.1 kB view details)

Uploaded Python 3

File details

Details for the file check-jsonschema-0.27.4.tar.gz.

File metadata

  • Download URL: check-jsonschema-0.27.4.tar.gz
  • Upload date:
  • Size: 238.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for check-jsonschema-0.27.4.tar.gz
Algorithm Hash digest
SHA256 253043be1ea51cd4918723caf5358d76eec5140967fb2d1834396fe6ddb5f067
MD5 0ace2f9ffdf2a44e8896c9a39237b3f4
BLAKE2b-256 f9a8469129f40d8c8010183dab1e187d516eeaa428d58ca93128d7c250f33b90

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.27.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7be2e18618b6d270163e2cf289e21efcc9796797460471b673e85f1c0ea9bfdc
MD5 066a3cee1c4b9ed06c53604f4b3c4651
BLAKE2b-256 6897e80ff6e73a44b2e9ba0140868b776d8f258c3ce998a51b2e9147c27e2079

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