django-universal-paginator 1.4.0

Template

To use this library first add {% pagination %} to django template or {{ pagination() }} to jinja2 template.

<!-- object_list.html -->
{% load paginator_tags %}

<ul>
        {% for object in object_list %}
                <li>{{ object }}</li>
        {% endfor %}
</ul>

<div class="pagination">{% pagination %}</div>

To modify style look to paginator.html.

URLs

This package can be used without URL modification, but if you want clean URL patterns without GET parameters, like /object-list/3/, you can use following code (example contains both methods - standard and cursor).

# urls.py

from django.urls import path, register_converter
from django_universal_paginator.converter import PageConverter, CursorPageConverter

register_converter(PageConverter, 'page')
register_converter(CursorPageConverter, 'cursor_page')

# standard
url(r'^object-list/<page:page>', ObjectList.as_view(), name='object_list'),
# or cursor
url(r'^cursor/<cursor_page:page>', ObjectList.as_view(), name='cursor_list'),

Classical navigation

To use classical navigation, just add paginate_by attribute to class based list view.

# views.py

class ObjectList(ListView):
        paginate_by = 10
        # model = ...

If you are using function based views, you can use django_universal_paginator.utils.paginate_queryset.

# views.py
from django_universal_paginator.utils import paginate_queryset

def list_view(request):
        queryset = Book.objects.order_by('pk')
        paginate_by = 10
        page = 1
        paginator, page, queryset, is_paginated = self.paginate_queryset(queryset, page,
        paginate_by)

        context = {
                "paginator": paginator,
                "page_obj": page,
                "is_paginated": is_paginated,
                "object_list": queryset,
        }

        reutrn render_to_string("list.html", context)

Cursor pagination

To use cursor pagination, queryset must be correctly ordered (order key must be combination of keys which are unique across queryset).

# views.py
from django.views.generic import ListView
from django_universal_paginator.cursor import CursorPaginateMixin

class List(CursorPaginateMixin, ListView):
        paginate_by = 10
        queryset = Book.objects.order_by('pk')