RETIRED, further work has moved to Debian project infrastructure
Go to file
Julian Berman 09a05bd038 Merge pull request #338 from dlax/fix-doctest
Dedent examples in validate.rst to fix sphinx doctest
2017-06-08 23:13:21 -04:00
benchmarks Probably should combine these at some point, but for now move them. 2015-03-15 12:27:15 -04:00
docs Dedent examples in validate.rst to fix sphinx doctest 2017-06-08 22:11:14 +02:00
json Temporarily remove these until I resolve upstream. 2015-06-05 08:51:53 -04:00
jsonschema Switch to ebb-lint, and cry a bit inside. 2017-06-04 11:19:29 -04:00
.gitignore Remove VCVersioner stuff from VCS. 2015-06-05 08:29:36 -04:00
.travis.yml Install Python 3.5 2016-10-15 08:53:59 -04:00
CHANGELOG.rst Properly commit the changelog. 2017-02-06 10:53:00 +01:00
COPYING Update copyright. 2013-02-17 15:32:44 -05:00
MANIFEST.in Switch to vcversioner, use repoze.lru only on 2.6, and add extras_require for format. 2015-03-15 11:45:34 -04:00
README.rst And here. 2017-02-06 10:54:58 +01:00
setup.cfg Build universal wheels. 2013-11-23 20:25:50 -05:00
setup.py Use newer vcversioner, and py35. 2016-08-27 22:29:58 -04:00
tox.ini Switch to ebb-lint, and cry a bit inside. 2017-06-04 11:19:29 -04:00

README.rst

image

image

image

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.6.0 drops support for Python 2.6.X (ha ha) and contains a number of small improvements in error messages, as well as a bug fix for ErrorTree.

Running the Test Suite

If you have tox installed (perhaps via pip install tox or your package manager), runningtox 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.