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:

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:

<h1>Pagination demo</h1>
<p>This pagination shows all Example objects with an id <= 100.</p>

<div class="simple_paginator">
    <table>
        {% include 'simple_paginator/paginator_header.html' %}
            {% for item in items.object_list %}
                <tr class="{% cycle 'odd' 'even' %}">
                    <td>{{ item.modelfield1 }}</td>
                    <td>{{ item.modelfield2 }}</td>
                    <td>{{ item.modelfield3 }}</td>
                </tr>
            {% endfor %}
    </table>

    {% include 'simple_paginator/paginator_control.html' %}
</div>

If the column/sorting feature is not used, some parts can be omitted:

<h1>Pagination demo</h1>
<p>This pagination lists some items.</p>

<div class="simple_paginator">
    {% for item in items.object_list %}
        <div class="item">{{ item }}</div>
    {% endfor %}

    {% include 'simple_paginator/paginator_control.html' %}
</div>

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 <div> 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

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.

dbrgn / django-simplepaginator Goto Github PK