djangorestframework-serializer-query-optimizations

Adds the possibility to do `select_related()` and `prefetch_related()` queries on querysets provided to Django REST Framework (DRF) model serializers.


License
MIT
Install
pip install djangorestframework-serializer-query-optimizations==0.1.0

Documentation

djangorestframework-serializer-query-optimizations

build-status-image pypi-version

Overview

Adds the possibility to do select_related() and prefetch_related() queries in Django REST Framework model serializers.

Requirements

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

Installation

Install using pip

$ pip install djangorestframework-serializer-query-optimizations

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