Metadata-Version: 1.1
Name: drf_timeordered_pagination
Version: 0.1.1
Summary: Utility classes to provide time-ordered pagination over 
Home-page: https://github.com/andrewdodd/drf-timeordered-pagination
Author: Andrew Dodd
Author-email: andrew.john.dodd@gmail.com
License: MIT
Description: drf-timeordered-pagination
        ======================================
        
        |build-status-image| |pypi-version|
        
        Overview
        --------
        
        Pagination utilities for Django REST Framework to allow for pagination by a mutable, but time-ordered field (like 'modified').
        
        Requirements
        ------------
        
        -  Python (2.7, 3.3, 3.4)
        -  Django (1.8+)
        -  Django REST Framework (3.1+)
        
        Important notes
        ---------------
        
        The layout of the docs and the Git project were borrowed from:
        - drf-proxy-pagination
        - django-nsync (which was borrowed from other people too!)
        
        Installation
        ------------
        
        Install using ``pip``\ …
        
        .. code:: bash
        
            $ pip install drf-timeordered-pagination
        
        In ``views.py``, hook up your own integration into the pagination, or use one of the provided ones like so:
        
        .. code:: python
        
            class ExampleClass(django.Model):
                ...
                modified = DateTimeField(...)
                ...
        
        
            from timeordered_pagination.views import TimeOrderedPaginationViewSetMixin
            class ExampleClassView(
                TimeOrderedPaginationViewSetMixin,
                ...,
                viewsets.ModelViewSet)
                ...
        
        
        
        Example
        -------
        
        - http://api.example.org/examples/ gives default pagination.
        - http://api.example.org/examples/?modified_after=1900-01-01T00:00:00Z gives all examples, modified after (greater than) Midnight, 1 Jan 1900, in modified order
        - http://api.example.org/examples/?modified_from=1900-01-01T00:00:00Z gives all examples, modified from (greater than or equal to) Midnight, 1 Jan 1900, in modified order
        
        Testing
        -------
        
        Install testing requirements.
        
        .. code:: bash
        
            $ pip install -r requirements.txt
        
        Run with pytest.
        
        .. code:: bash
        
            $ py.test
        
        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/andrewdodd/drf-timeordered-pagination.svg?branch=master
           :target: http://travis-ci.org/andrewdodd/drf-timeordered-pagination?branch=master
        .. |pypi-version| image:: https://img.shields.io/pypi/v/drf-timeordered-pagination.svg
           :target: https://pypi.python.org/pypi/drf-timeordered-pagination
        
Keywords: Django Rest Framework,Django,Pagination
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
