Skip to content

dnephin/jsonschema

This branch is 1 commit ahead of, 2111 commits behind python-jsonschema/jsonschema:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7b9b6f3 · Feb 27, 2015
Jan 7, 2015
Dec 7, 2014
Feb 27, 2015
Jul 23, 2013
Oct 16, 2014
Aug 19, 2014
Feb 17, 2013
May 17, 2013
Feb 25, 2015
Feb 25, 2013
Nov 24, 2013
May 8, 2014
Nov 24, 2014

Repository files navigation

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

jsonschema uses the wonderful Tox for its test suite. (It really is wonderful, if for some reason you haven't heard of it, you really should use it for your projects).

Assuming you have tox installed (perhaps via pip install tox or your package manager), just run tox in the directory of your source checkout to 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.

About

An(other) implementation of JSON Schema for Python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%