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

Uploaded Source

Built Distribution

check_jsonschema-0.29.1-py3-none-any.whl (228.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for check_jsonschema-0.29.1.tar.gz
Algorithm Hash digest
SHA256 0e70f4e1f8f322711b4dafcddaaa380f0a4c65a85dfa333d8fb53f2e9586c7b2
MD5 c5c111185446b313dce65459b5abf1cf
BLAKE2b-256 97e14a2e5d2113f685f316be2365caf3ffd3f9cd7c90ebcdfc433576942a1a91

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.29.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d5b05aec874971eb5818bd692021588a32551aa5bd14bbb12a2bef013b86b9c
MD5 9f16117f17a515229a33a173b45bca69
BLAKE2b-256 f276708b2493e1ae8e6dcc3f082f1b0b276a89f463a001626f3b8765487fb92e

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