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.27.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.27.1.tar.gz (223.8 kB view details)

Uploaded Source

Built Distribution

check_jsonschema-0.27.1-py3-none-any.whl (217.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check-jsonschema-0.27.1.tar.gz
  • Upload date:
  • Size: 223.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for check-jsonschema-0.27.1.tar.gz
Algorithm Hash digest
SHA256 e640479f16f106b9c6a3d2e47a82105c726ab0cc17e27e05e02e2269f2785e18
MD5 a8497a8df1c1942e8c3e17c9cad22ff0
BLAKE2b-256 58d93fd4aebc9325d4baf6ecc4c095bf2cf6ea9e366cbd450c76cd9ad297365e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.27.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f9afaf24a60f1792a1b8f216dc373c762a8db3d7d1c946782d532ce57f94b9
MD5 3a1ffcfc375d0e70df6610b8f20e311f
BLAKE2b-256 5711e0c5e07b5786e5d22478dd9ec9589305acba96f9a7f8f9fc6c483438700e

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