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

Uploaded Source

Built Distribution

check_jsonschema-0.29.4-py3-none-any.whl (239.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check_jsonschema-0.29.4.tar.gz
  • Upload date:
  • Size: 254.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for check_jsonschema-0.29.4.tar.gz
Algorithm Hash digest
SHA256 984864fabc82a108e30cb1ff63b6b7e6f43a7eb7df8d95a603051b0ca625184d
MD5 8d922b60f65dd4c136a7f02022e9461d
BLAKE2b-256 5c5fad3749efba6e8d64ffafcd09e0dd382457aa978870b4da2b6bcc17e1c0e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.29.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7cecf505b4d2aba02e260daa4834346566b1ef3c22720b40cc78cbc72a27fe3e
MD5 962704dd95407b63a2f08842bbf6d413
BLAKE2b-256 6e7615e8840b8fdbd2026c533d66c584cb4870037c07af8fe0abc375cffbd6cf

See more details on using hashes here.

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