Ravenports generated: 02 Feb 2018 09:28
[ravenports.git] / bucket_03 / python-django-pure-pagination
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-django-pure-pagination
4 VERSION=                0.3.0
5 KEYWORDS=               python devel
6 VARIANTS=               py35 py36
7 SDESC[py35]=            Django-pure-pagination provides advanced p (PY 35)
8 SDESC[py36]=            Django-pure-pagination provides advanced p (PY 36)
9 HOMEPAGE=               https://github.com/jamespacileo/django-pure-pagination/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPI/d/django-pure-pagination
14 DISTFILE[1]=            django-pure-pagination-0.3.0.tar.gz:main
15 DF_INDEX=               1
16 SPKGS[py35]=            single
17 SPKGS[py36]=            single
18
19 OPTIONS_AVAILABLE=      PY35 PY36
20 OPTIONS_STANDARD=       none
21 VOPTS[py35]=            PY35=ON PY36=OFF
22 VOPTS[py36]=            PY35=OFF PY36=ON
23
24 DISTNAME=               django-pure-pagination-0.3.0
25
26 LICENSE=                BSDGROUP:single
27 LICENSE_SCHEME=         solo
28 LICENSE_FILE=           BSDGROUP:{{WRKSRC}}/LICENSE.txt
29
30 GENERATED=              yes
31
32 [PY35].USES_ON=                         python:py35
33
34 [PY36].USES_ON=                         python:py36
35
36 post-patch:
37         ${REINPLACE_CMD} 's/[\d128-\d255]//g' ${WRKSRC}/README.rst
38
39 [FILE:2828:descriptions/desc.single]
40 ======================
41 django-pure-pagination
42 ======================
43
44 .. image:: https://travis-ci.org/hovel/django-pure-pagination.svg?branch=master
45     :target: https://travis-ci.org/hovel/django-pure-pagination
46
47 Description
48 ======================
49
50 :Author:
51     James Pacileo `@ignighted <http://twitter.com/ignighted>`_
52
53 :Version:
54     0.3.0
55
56 :Description:
57     django-pure-pagination provides advanced pagination features and is fully compatible with existing code based on Django's core pagination module. (aka no need to rewrite code!)
58
59 :Requirements:
60     Django 1.7+
61
62 :Contributors:
63     `juandecarrion (Juande Carrion) <https://github.com/juandecarrion>`_, `twidi (Stéphane Angel) <https://github.com/twidi>`_, `bebraw (Juho Vepsäläinen) <https://github.com/bebraw>`_, `lampslave () <https://github.com/lampslave>`_, `GeyseR (Sergey Fursov) <https://github.com/GeyseR>`_, `zeus (Pavel Zhukov) <https://github.com/zeus>`_
64
65
66 Introduction
67 ============
68
69 The django app offers advanced pagination features without forcing major code changes within an existing project.
70
71 Django-pure-pagination is based upon Django's core pagination module and is therefore compatible with the existing api.
72
73 `Documentation for Django core pagination module <http://docs.djangoproject.com/en/dev/topics/pagination/>`_
74
75 Features
76 --------
77
78 1. Uses same API as **django.core.pagination** and therefore is fully compatible with existing code.
79
80 2. Has dynamic query string creation, which takes into consideration existing GET parameters.
81
82 3. Out-of-the-box html rendering of the pagination
83
84 4. Additional methods make it easier to render more advanced pagination templates.
85
86
87 Installation
88 ------------
89
90 Install package from PYPI:
91
92 ::
93
94     pip install django-pure-pagination
95
96 or clone and install from repository:
97
98 ::
99
100     git clone git@github.com:jamespacileo/django-pure-pagination.git
101     cd django-pure-pagination
102     python setup.py install
103
104 Add `pure_pagination` to INSTALLED_APPS
105
106 ::
107
108     INSTALLED_APPS = (
109         ...
110         'pure_pagination',
111     )
112
113 Finally substitute **from django.core.paginator import Paginator** with **from pure_pagination import Paginator**
114
115 Settings
116 --------
117
118 A few settings can be set within settings.py
119
120 ::
121
122     PAGINATION_SETTINGS = {
123         'PAGE_RANGE_DISPLAYED': 10,
124         'MARGIN_PAGES_DISPLAYED': 2,
125
126         'SHOW_FIRST_PAGE_WHEN_INVALID': True,
127     }
128
129 **PAGE_RANGE_DISPLAYED** is the number of pages neighbouring the current page which will be displayed (default is 10)
130
131 **MARGIN_PAGES_DISPLAYED** is the number of pages neighbouring the first and last page which will be displayed (default is 2)
132
133 Set **SHOW_FIRST_PAGE_WHEN_INVALID** to True when you want to just show first page when provided invalid page instead of 404 error
134
135 .. image:: http://i.imgur.com/LCqrt.gif
136
137 Usage example
138 -------------
139
140
141
142 [FILE:114:distinfo]
143 02b42561b8afb09f1fb6ac6dc81db13374f5f748640f31c8160a374274b54713        10857 django-pure-pagination-0.3.0.tar.gz
144