https://github.com/tuffnatty/drf-proxy-pagination

Pagination class for Django REST Framework to choose pagination class by query parameter
https://github.com/tuffnatty/drf-proxy-pagination

Last synced: 11 days ago
JSON representation

Pagination class for Django REST Framework to choose pagination class by query parameter

• Host: GitHub
• URL: https://github.com/tuffnatty/drf-proxy-pagination
• Owner: tuffnatty
• License: mit
• Created: 2016-10-22T11:53:54.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-12T04:55:28.000Z (over 1 year ago)
• Last Synced: 2024-10-13T00:52:54.591Z (27 days ago)
• Language: Python
• Size: 24.4 KB
• Stars: 14
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django-rest-framework - drf-proxy-pagination

README

        
drf-proxy-pagination

======================================

|build-status-image| |pypi-version|

Overview

--------

Pagination class for Django REST Framework to choose pagination class by query parameter

Requirements

------------

-  Python (2.7, 3.4+)

-  Django (1.8+)

-  Django REST Framework (3.1+)

Installation

------------

Install using ``pip``\ …

.. code:: bash

    $ pip install drf-proxy-pagination

In ``settings.py``, choose `ProxyPagination` as your default pagination class

and configure it:

.. code:: python

    REST_FRAMEWORK = {

        ...

        'DEFAULT_PAGINATION_CLASS': 'proxy_pagination.ProxyPagination',

    }

    PROXY_PAGINATION_PARAM = 'pager'

    PROXY_PAGINATION_DEFAULT = 'rest_framework.pagination.LimitOffsetPagination'

    PROXY_PAGINATION_MAPPING = {

        'cursor': 'rest_framework.pagination.CursorPagination',

    }

Example

-------

http://api.example.org/accounts/ gives default pagination.

http://api.example.org/accounts/?pager=cursor gives CursorPagination for heavy queries.

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/tuffnatty/drf-proxy-pagination.svg?branch=master

   :target: http://travis-ci.org/tuffnatty/drf-proxy-pagination?branch=master

.. |pypi-version| image:: https://img.shields.io/pypi/v/drf-proxy-pagination.svg

   :target: https://pypi.python.org/pypi/drf-proxy-pagination