Ravenports generated: 04 Feb 2018 11:38
[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::
45 https://travis-ci.org/hovel/django-pure-pagination.svg?branch=master
46     :target: https://travis-ci.org/hovel/django-pure-pagination
47
48 Description
49 ======================
50
51 :Author:
52     James Pacileo `@ignighted <http://twitter.com/ignighted>`_
53
54 :Version:
55     0.3.0
56
57 :Description:
58     django-pure-pagination provides advanced pagination features and is
59 fully compatible with existing code based on Django's core pagination
60 module. (aka no need to rewrite code!)
61
62 :Requirements:
63     Django 1.7+
64
65 :Contributors:
66     `juandecarrion (Juande Carrion) <https://github.com/juandecarrion>`_,
67 `twidi (Stéphane Angel) <https://github.com/twidi>`_, `bebraw (Juho
68 Vepsäläinen) <https://github.com/bebraw>`_, `lampslave ()
69 <https://github.com/lampslave>`_, `GeyseR (Sergey Fursov)
70 <https://github.com/GeyseR>`_, `zeus (Pavel Zhukov)
71 <https://github.com/zeus>`_
72
73
74 Introduction
75 ============
76
77 The django app offers advanced pagination features without forcing major
78 code changes within an existing project.
79
80 Django-pure-pagination is based upon Django's core pagination module and
81 is therefore compatible with the existing api.
82
83 `Documentation for Django core pagination module
84 <http://docs.djangoproject.com/en/dev/topics/pagination/>`_
85
86 Features
87 --------
88
89 1. Uses same API as **django.core.pagination** and therefore is fully
90 compatible with existing code.
91
92 2. Has dynamic query string creation, which takes into consideration
93 existing GET parameters.
94
95 3. Out-of-the-box html rendering of the pagination
96
97 4. Additional methods make it easier to render more advanced pagination
98 templates.
99
100
101 Installation
102 ------------
103
104 Install package from PYPI:
105
106 ::
107
108     pip install django-pure-pagination
109
110 or clone and install from repository:
111
112 ::
113
114     git clone git@github.com:jamespacileo/django-pure-pagination.git
115     cd django-pure-pagination
116     python setup.py install
117
118 Add `pure_pagination` to INSTALLED_APPS
119
120 ::
121
122     INSTALLED_APPS = (
123         ...
124         'pure_pagination',
125     )
126
127 Finally substitute **from django.core.paginator import Paginator** with
128 **from pure_pagination import Paginator**
129
130 Settings
131 --------
132
133 A few settings can be set within settings.py
134
135 ::
136
137     PAGINATION_SETTINGS = {
138         'PAGE_RANGE_DISPLAYED': 10,
139         'MARGIN_PAGES_DISPLAYED': 2,
140
141         'SHOW_FIRST_PAGE_WHEN_INVALID': True,
142     }
143
144 **PAGE_RANGE_DISPLAYED** is the number of pages neighbouring the current
145 page which will be displayed (default is 10)
146
147 **MARGIN_PAGES_DISPLAYED** is the number of pages neighbouring the first
148 and last page which will be displayed (default is 2)
149
150 Set **SHOW_FIRST_PAGE_WHEN_INVALID** to True when you want to just show
151 first page when provided invalid page instead of 404 error
152
153 .. image:: http://i.imgur.com/LCqrt.gif
154
155 Usage example
156 -------------
157
158
159
160 [FILE:114:distinfo]
161 02b42561b8afb09f1fb6ac6dc81db13374f5f748640f31c8160a374274b54713        10857 django-pure-pagination-0.3.0.tar.gz
162