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

Uploaded Source

Built Distribution

check_jsonschema-0.28.3-py3-none-any.whl (218.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check_jsonschema-0.28.3.tar.gz
  • Upload date:
  • Size: 231.1 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.3.tar.gz
Algorithm Hash digest
SHA256 ffd55ec4e1cf6aec2860cab18f0d0f1aa4a886d01b81395f6be50d0cc0201159
MD5 527a88f3a2e7c5cc3d833de2835f8173
BLAKE2b-256 a0cf7dd56b2153e42604a5d9e13983dea7d2979c0d587e0a6936978f6a3fd8a5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e9b17c413956f40a197e61369a7ccd501a5438219dc0cac6c57f84aea019ed2a
MD5 de6779a5882fd3590c0cf928c2aa53d5
BLAKE2b-256 14ce4a1f91a845e493ffb609f201530841af7a4890b43a1ecd5c21472fd254ec

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