README.md

drf-nested-resource

This project is currently under heavy development and should not be used until this notice has been removed.

Overview

The inspiration for this package was taken from django-rest-framework-nested-resource, and hence the problem that both these packages are trying to solve is the same. It's just that this package will address it in it's own way.

Requirements

• Python (2.7, 3.2, 3.3, 3.4)
• Django (1.6, 1.7)
• Django REST Framework (3.0+)

Installation

Install using pip...

$ pip install drf-nested-resource

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