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

Uploaded Source

Built Distribution

check_jsonschema-0.28.6-py3-none-any.whl (227.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: check_jsonschema-0.28.6.tar.gz
  • Upload date:
  • Size: 239.8 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.28.6.tar.gz
Algorithm Hash digest
SHA256 b4df7b94df5b0ac181969687ad519491b5f47e6c76230c846a05e06623bbb5c6
MD5 604ac09deb34d65a6b5f316c4193844e
BLAKE2b-256 c3fddc07a94d3cc000b2dd9a1a7180d198814d6befd36662676aae8d05b78ca7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for check_jsonschema-0.28.6-py3-none-any.whl
Algorithm Hash digest
SHA256 34cf368d5ba78a94ec0053d39cf35e3bde41b19e350b5a80eec823730ba61ce1
MD5 d7cdedcad98ad39cf01a785717de2fc2
BLAKE2b-256 da957036630a66999d1cd6f51d876d5a617b10c5c0b9cc8e3fc363cc30d5bd2a

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