|build-status-image| |pypi-version|
Overview
Extra paginations for the rest framework
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
\ …
.. code:: bash
$ pip install django-rest-framework-paginations
Example
TODO: Write example.
Testing
Install testing requirements.
.. code:: bash
$ pip install -r requirements.txt
Run with runtests.
.. code:: bash
$ ./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:
.. code:: bash
$ tox
Documentation
To build the documentation, you’ll need to install mkdocs
.
.. code:: bash
$ pip install mkdocs
To preview the documentation:
.. code:: bash
$ mkdocs serve
Running at: http://127.0.0.1:8000/
To build the documentation:
.. code:: bash
$ mkdocs build
.. _tox: http://tox.readthedocs.org/en/latest/
.. |build-status-image| image:: https://secure.travis-ci.org/variable/django-rest-framework-paginations.svg?branch=master
:target: http://travis-ci.org/variable/django-rest-framework-paginations?branch=master
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-rest-framework-paginations.svg
:target: https://pypi.python.org/pypi/django-rest-framework-paginations