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.29.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.29.2.tar.gz (243.4 kB view details)

Uploaded Source

Built Distribution

check_jsonschema-0.29.2-py3-none-any.whl (228.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check_jsonschema-0.29.2.tar.gz
  • Upload date:
  • Size: 243.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for check_jsonschema-0.29.2.tar.gz
Algorithm Hash digest
SHA256 a633aae257f16e5298853edf18fd30ab94878fd88bd6b91902cd7158151c675d
MD5 13f0e80c8779ed109768a7031bcb899a
BLAKE2b-256 3a6346ada3bfef271aa4c5ccc86a01a2ca521bfa3a0d7b083dbe76e8adcc460c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.29.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6470ff23d848a26b1e77db1141827002f5fff3138295d3345c19b2410d345aa0
MD5 b048b4c669baded86be0ae066ffd17e0
BLAKE2b-256 1d57c1b4894a5e7618180e15d54f3d7457c261e8af01b9c6a0676c017b91275e

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