README.rst

drf-jsonapi

⚠️ THIS PROJECT IS NOT MAINTAINED

Please consider using or contributing to https://github.com/django-json-api/django-rest-framework-json-api/

---

Overview

Django Rest Framework tools which are compliant with the JSONAPI 1.0 specification.

Documentation: django-rest-framework-jsonapi.rtfd.org

Requirements

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

Installation

Install using pip…

$ pip install drf-jsonapi

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

The documentation is browsable on Read the Docs: django-rest-framework-jsonapi.rtfd.org

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