提供时间顺序分页的实用程序类
drf_timeordered_pagination的Python项目详细描述
概述
django rest framework的分页实用程序,允许按可变但时间顺序的字段(如“modified”)进行分页。
要求
- Python(2.7,3.3,3.4)
- Django(1.8+)
- django rest框架(3.1+)
重要注意事项
文档和git项目的布局借鉴自: -DRF代理分页 -Django Nsync(也是从别人那里借的!)
安装
使用pip…
安装$ pip install drf-timeordered-pagination
在views.py中,将您自己的集成连接到分页中,或者使用提供的集成之一,如so:
classExampleClass(django.Model):...modified=DateTimeField(...)...fromtimeordered_pagination.viewsimportTimeOrderedPaginationViewSetMixinclassExampleClassView(TimeOrderedPaginationViewSetMixin,...,viewsets.ModelViewSet)...
示例
- http://api.example.org/examples/提供默认分页。
- http://api.example.org/examples/?modified_after=1900-01-01T00:00:00Z给出了1900年1月1日午夜之后(大于)按修改顺序修改的所有示例
- http://api.example.org/examples/?modified_from=1900-01-01T00:00:00Z给出了所有示例,按修改顺序从(大于或等于)1900年1月1日午夜开始修改
测试
安装测试要求。
$ pip install -r requirements.txt
使用pytest运行。
$ py.test
您还可以使用优秀的tox测试工具来运行测试 针对所有受支持的python和django版本。安装TOX 全局,然后简单地运行:
$ tox
文档
要构建文档,您需要安装mkdocs。
$ pip install mkdocs
预览文档:
$ mkdocs serve Running at: http://127.0.0.1:8000/
构建文档:
$ mkdocs build