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.
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
Release history Release notifications | RSS feed
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 details)
Built Distribution
File details
Details for the file hedju-0.1.0.tar.gz
.
File metadata
- Download URL: hedju-0.1.0.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.3 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1f5aa3d201996cfe8afa65d30933a7446c81d614dea74988fbe5eae0518af3f |
|
MD5 | 2890b4b70bb4747c2dad014737f6996d |
|
BLAKE2b-256 | d97d854ecc0ba7f70224d85bc862aae9498938bec22f137d76727540a74f042d |
File details
Details for the file hedju-0.1.0-py2.py3-none-any.whl
.
File metadata
- Download URL: hedju-0.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 4.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.3 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | da68f1917064261e50ad22cdef5a3c2f05868bf795be61d2c2e9ee790356dd3a |
|
MD5 | ff0e56a37fa069155badbc9e9946b3a1 |
|
BLAKE2b-256 | 443b195246f6faf9a89005b5d74b858032b1888eab001cdaaedbb14b161c0072 |