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

Uploaded Source

Built Distribution

check_jsonschema-0.28.4-py3-none-any.whl (218.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for check_jsonschema-0.28.4.tar.gz
Algorithm Hash digest
SHA256 e6acd2e89a7cbc41d2813a5b00fb5dfb7a14a5e72f4898a62bc761cf0899ad97
MD5 a74bc21cef6f7e0f7e8b3a45d6e7a3f5
BLAKE2b-256 53bbc8c1d02b38cbc4726b08db61ba36d9f1aa8c99c62d5de515966eb35dfa09

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4a005c440b1fcab06d35124f84e334d3b018d9f901aed94a05029213dcc484a1
MD5 aee68622d8c9d22e54a2eb05262fcf74
BLAKE2b-256 87290ed50fdec7daa730395e1f0e328950d3075e76f01f9a7a6af9baca313060

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