https://github.com/python-jsonschema/check-jsonschema

A CLI and set of pre-commit hooks for jsonschema validation with built-in support for GitHub Workflows, Renovate, Azure Pipelines, and more!
https://github.com/python-jsonschema/check-jsonschema

cli json-schema pre-commit python

Last synced: about 1 month ago
JSON representation

A CLI and set of pre-commit hooks for jsonschema validation with built-in support for GitHub Workflows, Renovate, Azure Pipelines, and more!

• Host: GitHub
• URL: https://github.com/python-jsonschema/check-jsonschema
• Owner: python-jsonschema
• License: other
• Created: 2021-01-08T05:35:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-12T21:02:06.000Z (3 months ago)
• Last Synced: 2024-08-15T10:40:40.930Z (3 months ago)
• Topics: cli, json-schema, pre-commit, python
• Language: Python
• Homepage: https://check-jsonschema.readthedocs.io/en/stable
• Size: 1.52 MB
• Stars: 197
• Watchers: 7
• Forks: 41
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![pypi version](https://img.shields.io/pypi/v/check-jsonschema.svg)](https://pypi.org/project/check-jsonschema/)

[![supported pythons](https://img.shields.io/pypi/pyversions/check-jsonschema.svg)](https://pypi.org/project/check-jsonschema/)

[![build](https://github.com/python-jsonschema/check-jsonschema/actions/workflows/build.yaml/badge.svg)](https://github.com/python-jsonschema/check-jsonschema/actions/workflows/build.yaml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/python-jsonschema/check-jsonschema/main.svg)](https://results.pre-commit.ci/latest/github/python-jsonschema/check-jsonschema/main)

[![readthedocs documentation](https://readthedocs.org/projects/check-jsonschema/badge/?version=stable&style=flat)](https://check-jsonschema.readthedocs.io/en/stable)

# check-jsonschema

A JSON Schema CLI and [pre-commit](https://pre-commit.com/) hook built on [jsonschema](https://github.com/python-jsonschema/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.

```yaml

- 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/