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

Uploaded Source

Built Distribution

check_jsonschema-0.28.2-py3-none-any.whl (244.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check-jsonschema-0.28.2.tar.gz
  • Upload date:
  • Size: 250.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for check-jsonschema-0.28.2.tar.gz
Algorithm Hash digest
SHA256 6bb5a7aa16ca9854a6fd45b6037c28bc548612aedec1df57b154ecfce1441bea
MD5 87ea10850ed39c6806ff1c4232e20432
BLAKE2b-256 9aaba2e1fa47c34fa64caae166afcf6b54466713bf17ebe960944fd16c6de140

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7c276904a04effe510b19fdc0ea9a0e30a943b92e5bfd731c76b5eee36b91e44
MD5 03382c8bc30aad8b9349bff409b6c783
BLAKE2b-256 c1766a189c8c5370b3b6fb269bd7fdb39fe41269ae4808cb9d5b57a5891657eb

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