Skip to main content

An implementation of JSON Schema validation for Python

Project description

https://travis-ci.org/Julian/jsonschema.svg?branch=master

jsonschema

jsonschema is an implementation of JSON Schema for Python (supporting 2.7+ including Python 3).

>>> from jsonschema import validate

>>> # A sample schema, like what we'd get from json.load()
>>> schema = {
...     "type" : "object",
...     "properties" : {
...         "price" : {"type" : "number"},
...         "name" : {"type" : "string"},
...     },
... }

>>> # If no exception is raised by validate(), the instance is valid.
>>> validate({"name" : "Eggs", "price" : 34.99}, schema)

>>> validate(
...     {"name" : "Eggs", "price" : "Invalid"}, schema
... )                                   # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
    ...
ValidationError: 'Invalid' is not of type 'number'

It can also be used from console:

$ jsonschema -i sample.json sample.schema

Features

Release Notes

Version 2.5.0 is mainly a performance release. The interface for RefResolver was extended to add methods that improve performance on CPython.

Support for custom RefResolver objects with the legacy interface should not be affected. If you notice something amiss please file an issue ticket.

Running the Test Suite

If you have tox installed (perhaps via pip install tox or your package manager), running``tox`` in the directory of your source checkout will run jsonschema’s test suite on all of the versions of Python jsonschema supports. Note that you’ll need to have all of those versions installed in order to run the tests on each of them, otherwise tox will skip (and fail) the tests on that version.

Of course you’re also free to just run the tests on a single version with your favorite test runner. The tests live in the jsonschema.tests package.

Community

There’s a mailing list for this implementation on Google Groups.

Please join, and feel free to send questions there.

Contributing

I’m Julian Berman.

jsonschema is on GitHub.

Get in touch, via GitHub or otherwise, if you’ve got something to contribute, it’d be most welcome!

You can also generally find me on Freenode (nick: tos9) in various channels, including #python.

If you feel overwhelmingly grateful, you can woo me with beer money on Gittip or via Google Wallet with the email in my GitHub profile.

Project details


Release history Release notifications

This version
History Node

2.6.0

History Node

2.5.1

History Node

2.5.0

History Node

2.4.0

History Node

2.3.0

History Node

2.2.0

History Node

2.1.0

History Node

2.0.0

History Node

1.3.0

History Node

1.2.0

History Node

1.1.0

History Node

1.0.0

History Node

0.8.0

History Node

0.7

History Node

0.6

History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.1a

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
jsonschema-2.6.0-py2.py3-none-any.whl (39.5 kB) Copy SHA256 hash SHA256 Wheel 2.7 Feb 5, 2017
jsonschema-2.6.0.tar.gz (53.3 kB) Copy SHA256 hash SHA256 Source None Feb 5, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page