djangorestframework-json-schema

HEADS UP

This is alpha quality software and is a work in progress. Use at your discretion.

Overview

JSON Schema utilities for Django Rest Framework

Requirements

• Python (2.7, 3.3, 3.4)
• Django (1.6, 1.7, 1.8)
• Django REST Framework (3.0, 3.1)

Installation

Install using pip…

$ pip install djangorestframework-json-schema

Example

TODO: Write example.

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build