Skip to main content

Class implementing limit/offset pagination in headers with optional enveloping.

Project description

===================================================
Hedju - Header Pagination for Django REST Framework
===================================================


.. image:: https://img.shields.io/pypi/v/hedju.svg
:target: https://pypi.python.org/pypi/hedju

.. image:: https://img.shields.io/travis/sunscrapers/hedju.svg
:target: https://travis-ci.org/sunscrapers/hedju

.. image:: https://readthedocs.org/projects/hedju/badge/?version=latest
:target: https://hedju.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status


Replacement for Django REST Framework's pagination classes implementing
Link header as defined in RFC5988_ with optional enveloping.

Inspired by `this paragraph from excellent article<https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pagination>`_ by Vinay Sahni

.. note:: This is pre-alpha code. Use at your own discretion.

* Free software: MIT license
* Documentation: https://hedju.readthedocs.io.


Features
--------

* Provides ``first``, ``prev``, ``next`` and ``last`` links via headers.
* Optional enveloping for clients without header support - returns structure
compatible with original class but with extra ``first`` and ``last`` links.


Credits
-------

Developed by SUNSCRAPERS_ with passion & patience.

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _SUNSCRAPERS: https://sunscrapers.com/
.. _RFC5988: http://tools.ietf.org/html/rfc5988#page-6


=======
History
=======

0.1.0 (2019-02-05)
------------------

* Add remaining pagination classes


0.0.4 (2019-02-05)
------------------

* Working tests
* Some doc updates

0.0.1 (2019-02-04)
------------------

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hedju-0.1.0.tar.gz (9.8 kB view hashes)

Uploaded Source

Built Distribution

hedju-0.1.0-py2.py3-none-any.whl (4.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page