Getting started¶

Requirements¶

The Git repository can be cloned with this command:

git clone https://github.com/MicroPyramid/django-simple-pagination.git

The simple_pagination package, included in the distribution, should be placed on the PYTHONPATH.

Otherwise you can just easy_install -Z django-simple-pagination or pip install django-simple-pagination.

Add the request context processor to your settings.py, e.g.:

from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
TEMPLATE_CONTEXT_PROCESSORS += (
    'django.core.context_processors.request',
)

Add 'simple_pagination' to the INSTALLED_APPS to your settings.py.

See the Settings section for other settings.

Given a template like this:

{% for item in items %}
    {# your code to show the item #}
{% endfor %}

you can use simple Digg-style pagination to display objects just by adding:

{% load paginate %}

{% paginate items %}
{% for item in items %}
    {# your code to show the item #}
{% endfor %}
{% show_pageitems %}

Done.

This is just a basic example. To continue exploring all the Django Simple Pagination features, have a look at Simple pagination.