Metadata-Version: 2.0
Name: django-rangepaginator
Version: 1.1.0
Summary: Nice paginator for Django
Home-page: https://github.com/mvantellingen/django-rangepaginator
Author: Michael van Tellingen
Author-email: michaelvantellingen@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: test
Provides-Extra: docs
Requires-Dist: Django (>=1.7)
Requires-Dist: six (>=1.1)
Provides-Extra: docs
Requires-Dist: sphinx (>=1.4.0); extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest (==3.0.1); extra == 'test'
Requires-Dist: pytest-cov (==2.3.1); extra == 'test'
Requires-Dist: pytest-django (==3.0.0); extra == 'test'
Requires-Dist: pytest-sugar (==0.7.1); extra == 'test'
Requires-Dist: isort (==4.2.5); extra == 'test'
Requires-Dist: flake8 (==3.0.4); extra == 'test'
Requires-Dist: flake8-blind-except (==0.1.1); extra == 'test'
Requires-Dist: flake8-debugger (==1.4.0); extra == 'test'

=====================
django-rangepaginator
=====================

This Django app provides a templatetag to render pagination widgets which include a range of pages around the current active one.

.. image:: docs/_static/example.png?stop-caching-me

Status
======
.. image:: https://travis-ci.org/mvantellingen/django-rangepaginator.svg?branch=master
    :target: https://travis-ci.org/mvantellingen/django-rangepaginator

.. image:: http://codecov.io/github/mvantellingen/django-rangepaginator/coverage.svg?branch=master
    :target: http://codecov.io/github/mvantellingen/django-rangepaginator?branch=master

.. image:: https://img.shields.io/pypi/v/django-rangepaginator.svg
    :target: https://pypi.python.org/pypi/django-rangepaginator/


Installation
============

.. code-block:: shell

   pip install django_rangepaginator

Update your Django settings:

.. code-block:: python


    INSTALLED_APPS += [
        'django_rangepaginator'
    ]

    # Use bootstrap4 template
    RANGE_PAGINATOR_TEMPLATE = 'django_rangepaginator/bootstrap3.html'

    # Use bootstrap3 template (default)
    RANGE_PAGINATOR_TEMPLATE = 'django_rangepaginator/bootstrap4.html'


Usage
=====
.. code-block:: django

    {% load rangepaginator %}
    {% paginate page request=request %}

The following options are available:

- distance: number of pages around current active one (default = 2)
- edge: number of pages at the start and end (default = 1)
- extra_class: add extra css classes to the pagination div (default = '')
- text_labels: use strings for previous/next instead of symbols (default = True)

Demo
====
A sandbox environment is available in the repository, run the following:

.. code-block:: shell

   ./sandbox/manage.py migrate
   ./sandbox/manage.py runserver

Bugs/features
=============

Let me know! :-)




