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

Uploaded Source

Built Distribution

check_jsonschema-0.30.0-py3-none-any.whl (254.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for check_jsonschema-0.30.0.tar.gz
Algorithm Hash digest
SHA256 c912ef9cf204c17d2e9d832b9088040f1c0c3f178ebda9805a56e5f35b29f5f2
MD5 2ca9d2e2add2eec60d4d127d7977c876
BLAKE2b-256 845207a76a51fba27592c2b24ebc0426e1bb84af77220c89deed2e03fd67f40c

See more details on using hashes here.

Provenance

The following attestation bundles were made for check_jsonschema-0.30.0.tar.gz:

Publisher: publish_to_pypi.yaml on python-jsonschema/check-jsonschema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7fb2de2017ab81a85b08c7332d6f074b0565d41d068de25a6e42a8a6a0b723d
MD5 4369af0b2b3f12d396d643eb2c20ccfd
BLAKE2b-256 cce9105b76db771ab17a4069bce2c9aced9993f83ed1f11e1bb875f0638e5676

See more details on using hashes here.

Provenance

The following attestation bundles were made for check_jsonschema-0.30.0-py3-none-any.whl:

Publisher: publish_to_pypi.yaml on python-jsonschema/check-jsonschema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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