README.rst

drf-nested-routers

Overview

Nested resources for the Django Rest Framework

Requirements

• Python (2.7, 3.3, 3.4, 3.5, 3.6)
• Django (1.8, 1.9, 1.10)
• Django REST Framework (2.4.3, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5)

Installation

Install using pip…

$ pip install drf-nested-routers

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