https://github.com/dbrgn/django-simplepaginator
A simple wrapper around the Django paginator.
https://github.com/dbrgn/django-simplepaginator
Last synced: 10 months ago
JSON representation
A simple wrapper around the Django paginator.
- Host: GitHub
- URL: https://github.com/dbrgn/django-simplepaginator
- Owner: dbrgn
- License: lgpl-3.0
- Created: 2011-08-12T22:32:00.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2014-01-31T14:32:53.000Z (over 12 years ago)
- Last Synced: 2025-01-12T10:42:13.051Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 235 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
django-simplepaginator
======================
[]
(https://travis-ci.org/dbrgn/django-simplepaginator)
[]
(https://pypi.python.org/pypi/simple_paginator)
django-simplepaginator is a small wrapper around the standard Django paginator. The goal of
django-simplepaginator is _not_ to replace the Django paginator with yet another kind of pagination
interface. It just simplifies the creation of a pagination and provides templates for column
titles and page navigation. It supports sorting and orphans.
Installation
------------
Copy the simple_paginator folder to your project or install it into your pythonpath:
# python setup.py install
If you use pip, you can also install it directly using the -e parameter:
# pip install -e git://github.com/dbrgn/django-simplepaginator.git#egg=simple_paginator
Then add simple_paginator to your `INSTALLED_APPS` setting.
Usage
-----
The SimplePaginator object accepts the following keyword arguments:
* `request` -- The request object
* `prefix` -- The prefix for the controls' css-class and for the GET parameters
* `data` -- Elements to paginate
* `columns` -- A tuple of tuples containing column name and key (default None)
* `per_page` -- How many elements to display per page (default 20)
* `orphans` -- Whether to move orphans to the previous page (default 1)
In the view, use the `paginate()`-shortcutfunction to return pagination items. Remember that each
pagination on a page must have a distinct prefix.
Columns can be marked as non-sortable by setting the sort key to `None`.
### Example:
```python
from django.shortcuts import render_to_response
import simple_paginator
try:
objects = models.Example.objects.filter(id__lte=100)
except ObjectDoesNotExist:
objects = None
prefix = 'itemlist'
columns = (
('Column1', 'modelfield1'),
('Column2', 'modelfield2'),
('Column3', None),
)
items, order, baseurl = simple_paginator.paginate(request, prefix, functions, columns)
context = {
'items': items,
'prefix': prefix,
'columns': columns,
'order': order,
'baseurl': baseurl
}
return render_to_response('template.html', context)
```
And in the template:
```html
Pagination demo
This pagination shows all Example objects with an id <= 100.
{% include 'simple_paginator/paginator_header.html' %}
{% for item in items.object_list %}
{{ item.modelfield1 }}
{{ item.modelfield2 }}
{{ item.modelfield3 }}
{% endfor %}
{% include 'simple_paginator/paginator_control.html' %}
```
If the column/sorting feature is not used, some parts can be omitted:
```html
Pagination demo
This pagination lists some items.
{% for item in items.object_list %}
{{ item }}
{% endfor %}
{% include 'simple_paginator/paginator_control.html' %}
```
Customization
-------------
You can customize the paginator header and control templates by copying them to your project
folder and editing them, or by adding completely new templates. They should be put in a
directory called "simple_paginator" inside your template folder.
Please keep in mind that most of the control logic is done inside those templates, so be careful
changing them.
Changelog
---------
v0.3.1 (2014-01-31)
- [add] Added possibility to sort by model methods (#2)
v0.3.0 (2013-08-21)
- [bug] Removed `
` from `paginator_header.html` template (#1)
v0.2.2 (2011-09-07)
- [add] Feature to mark columns as non-sortable
v0.2.1 (2011-08-30)
- [bug] Fixed compatibility with Python 2.5
v0.2 (2011-08-26)
- [add] Published django-simplepaginator on Github
- [bug] Fixed critical bugs in view and templates
- [bug] Fixed problems with setup.py
License
-------
Copyright 2011-2013 Danilo Bargen (http://dbrgn.ch/)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
Lesser General Public License as published by the Free Software Foundation, either version 3 of the
License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program.
If not, see http://www.gnu.org/licenses/lgpl.html.