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

Uploaded Source

Built Distribution

check_jsonschema-0.27.0-py3-none-any.whl (217.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for check-jsonschema-0.27.0.tar.gz
Algorithm Hash digest
SHA256 57a78e78e1865e5f965a344db92816034dba1135468ad622efb6e410d2adf823
MD5 4832f233af0641d3896618b3ea9f6864
BLAKE2b-256 f27a4c76d3622aa72b9c47a26e70a6ee9c0ea93658dfea02cf8092b5a7d01c33

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17ff8010ff178554d5c687691cc7ef9ea1328f2e7683f609e17074e63bc28af7
MD5 68a51fa721199177fb6a8d1fc9e1cf16
BLAKE2b-256 1215c07326c3b0a907304905ac5f16835200af56b3dc0f8c5479cc48298c3c21

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