Custom paginations for Django REST Framework
Project description
Custom paginations for django rest framework
Compatibility
- work with :
Python 2.7 / 3.4
Dango 1.6 / 1.7
Django Rest Framework 2.4 / 3.0 / 3.1 / 3.2 / 3.3
Installation
Install the package from pypi:
pip install djangorestframework-custom-paginations
Add the application in your django settings:
DJANGO_APPS = ('rest_framework_custom_paginations',)
Configure your rest framework for DRF >= 3.1:
REST_FRAMEWORK = { 'DEFAULT_PAGINATION_CLASS': 'rest_framework_custom_paginations.classes.SporePagination', }
or configure your rest framework for DRF < 3.1:
REST_FRAMEWORK = { 'DEFAULT_PAGINATION_SERIALIZER_CLASS': 'rest_framework_custom_paginations.paginations.SporePaginationSerializer' }
Usage
Add the following parameters in a ListAPIView :
class PersonList(generics.ListAPIView): """ list of person """ ... paginate_by = 100 paginate_by_param = 'page_size' max_paginate_by = 500
Example
Results of Spore Pagination :
{ "count": 532, "next": "http://myurls/persons.json?structure=mystructure&page=3", "next_params": { "page": 3, "structure": "mystructure" }, "num_pages": 6, "previous": "http://myurls/persons.json?structure=mystructure&page=1", "previous_params": { "page": 1, "structure": "mystructure" }, "results": [ ... ] }
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
Close
Hashes for djangorestframework-custom-paginations-1.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35d5189e36d050ccdfeafd5c68fd5b4ae2111b7f7c48f00fab204fc6b2b178af |
|
MD5 | f8367ac1299f3cc20ce24b454372c771 |
|
BLAKE2b-256 | bb5c65b70c02bf0e4432af060d5ba29d19ff6ad6d3509dce199d4d1218f4b02d |