Skip to main content

Implements JSON Schema, JSON Pointer and JSON Reference.

Project description

This library implements several JSON specs, like JSON Schema, JSON Reference and JSON Pointer:

  • It works on python 3.6 and above

  • It is release under the BSD license


This library has only weak dependencies. You can simply use pip:

$ pip install json-spec

Regading you needs, you can install more features. For example, this command will enable colorated messages:

$ pip install json-spec[cli]

This one will enable ip format for json schema:

$ pip install json-spec[ip]

CLI Usage

This module expose 2 cli commands.

json-extract will extract parts of your json document:

$ json-extract '#/foo/1' --document-json='{"foo": ["bar", "baz"]}'
$ echo '{"foo": ["bar", "baz"]}' | json-extract '#/foo/1'
$ json-extract '#/foo/1' --document-file=doc.json
$ json-extract '#/foo/1' < doc.json

json-validate will validate your document against a schema:

$ json-validate --schema-file=schema.json --document-json='{"foo": ["bar", "baz"]}'
$ echo '{"foo": ["bar", "baz"]}' | json-validate --schema-file=schema.json
$ json-validate --schema-file=schema.json --document-file=doc.json
$ json-validate --schema-file=schema.json < doc.json

Library usage

Let say you want to fetch / validate JSON like objects in you python scripts.

You can extract member of an object with JSON Pointer:

from jsonspec.pointer import extract

obj = {
    'foo': ['bar', 'baz', 'quux']
assert 'baz' == extract(obj, '/foo/1')

You can resolve member of any object with JSON Reference:

from jsonspec.reference import resolve

obj = {
    'foo': ['bar', 'baz', {
        '$ref': '#/sub'
    'sub': 'quux'

assert 'quux' == resolve(obj, '#/foo/2')

You can describe you data with JSON Schema:

from jsonspec.validators import load

# data will validate against this schema
validator = load({
    'title': 'Example Schema',
    'type': 'object',
    'properties': {
        'age': {
            'description': 'Age in years',
            'minimum': 0,
            'type': 'integer'
        'firstName': {
            'type': 'string'
        'lastName': {
            'type': 'string'
    'required': [

# validate this data
    'firstName': 'John',
    'lastName': 'Noone',
    'age': 33,

Other examples can be found in the documentation or in the tests.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

json_spec-0.11.0.tar.gz (30.1 kB view hashes)

Uploaded source

Built Distribution

json_spec-0.11.0-py3-none-any.whl (41.3 kB view hashes)

Uploaded py3

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