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

Uploaded Source

Built Distribution

check_jsonschema-0.28.1-py3-none-any.whl (239.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check-jsonschema-0.28.1.tar.gz
  • Upload date:
  • Size: 246.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for check-jsonschema-0.28.1.tar.gz
Algorithm Hash digest
SHA256 0dbeb24a5c0cfca366906df835131acfeeeff58ce9d6ec7ec3ff7dd4b989d4a1
MD5 224e1e59eda9cea9832a08b2343bfe2a
BLAKE2b-256 1dbbe3d153097528f5672f13c954c658367a0996f84366cbbf511bd3bf1ad755

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.1-py3-none-any.whl
Algorithm Hash digest
SHA256 48adb15099c8becddf522e9e93881f5b04da90b0e3de619dbfd42e68bcf3af8f
MD5 6779d5cf00de31e7ec0d51a93abfba67
BLAKE2b-256 80b385df197b1a3bbe6f0c79481018b038bb61edf26c216d86b231f37e74ae9a

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