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.37.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.37.0.tar.gz (399.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

check_jsonschema-0.37.0-py3-none-any.whl (383.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check_jsonschema-0.37.0.tar.gz
  • Upload date:
  • Size: 399.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for check_jsonschema-0.37.0.tar.gz
Algorithm Hash digest
SHA256 f1fef56b041e8cd1ad42e340f8422c1f27e00877e29c4f34bce357955b262e9d
MD5 ffb18be0467788abba2c7f579fbe1dbe
BLAKE2b-256 f39b384b1a7df9b28b702cb940d96cea0cad77031f408a8859b9641abea5d671

See more details on using hashes here.

Provenance

The following attestation bundles were made for check_jsonschema-0.37.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.37.0-py3-none-any.whl.

File metadata

File hashes

Hashes for check_jsonschema-0.37.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9a1476746627daf1d3b362d15ea70b4e176588a2de9dbfb6933315553bcb393
MD5 76f0f7777194912dcb2a010309a87987
BLAKE2b-256 3c20515f96aa04ce0e74c479a90649f18e2eae80d4df34707b0f4ba831b574ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for check_jsonschema-0.37.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 Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page