RETIRED, further work has moved to Debian project infrastructure
Go to file
Julian Berman e2a604f7eb
Switch to vcversioner, use repoze.lru only on 2.6, and add extras_require for format.
2015-03-15 11:45:34 -04:00
docs Fix Draft4Validator example code in validate.rst 2015-01-07 13:56:02 +11:00
json Merge commit '45cf1fb8a6a0b7ea1ab8de8ea9fc7addb0ffd149' 2014-12-07 12:22:37 -05:00
jsonschema Switch to vcversioner, use repoze.lru only on 2.6, and add extras_require for format. 2015-03-15 11:45:34 -04:00
.gitignore Switch to vcversioner, use repoze.lru only on 2.6, and add extras_require for format. 2015-03-15 11:45:34 -04:00
.travis.yml Support pypy3 2014-10-16 14:04:58 -07:00
CHANGELOG.rst Release notes for v2.4.0 2014-08-18 20:53:47 -04: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 It's hard to be enthusiastic about tox anymore. 2015-03-14 21:23:13 -04:00
bench.py Add benchmark script. 2015-03-01 19:16:41 -05:00
perftest Simple 2013-02-24 19:48:44 -05:00
setup.cfg Build universal wheels. 2013-11-23 20:25:50 -05:00
setup.py Switch to vcversioner, use repoze.lru only on 2.6, and add extras_require for format. 2015-03-15 11:45:34 -04:00
tox.ini 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

image

jsonschema

jsonschema is an implementation of JSON Schema for Python (supporting 2.6+ 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'

Features

Release Notes

  • A simple CLI was added for validation
  • Validation errors now keep full absolute paths and absolute schema paths in their absolute_path and absolute_schema_path attributes. The path and schema_path attributes are deprecated in favor of relative_path and relative_schema_path.

Note: Support for Python 3.2 was dropped in this release, and installation now uses setuptools.

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.