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

Uploaded Source

Built Distribution

check_jsonschema-0.28.5-py3-none-any.whl (218.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for check_jsonschema-0.28.5.tar.gz
Algorithm Hash digest
SHA256 8100ff34ed042189c486866b0448ab9930825dc6ad1acb86c1ffb000f4648b42
MD5 6636b3864380722a5845a57339e8abeb
BLAKE2b-256 e4e309ffb25031e090ef48e87e13695d2ca7b75b8d691167d8336e0fa631ebcb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5b8a0de1ff64f40d08dccef3a2a767efcfa34a5c18000b8c3b2c1711ccb9739c
MD5 6a94e272c95ddebff4280cf4427aa0ba
BLAKE2b-256 c2de9cbaa2e87ad905232990db3b6c0d96393e02b2c469e5c12d5ea509fe993e

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