setup.py

   1 #!/usr/bin/env python
   2 from setuptools import setup, find_packages
   3
   4 version = '1.0.7.1'
   5
   6 LONG_DESCRIPTION = """
   7
   8 About the fork
   9 --------------
  10
  11 This project is a fork of apparently dead "django-pagination" project
  12 originally written by 'Eric Florenzano'. It is maintained by the Linaro
  13 Validation/Infrastructure team. Latest releases can be found on launchpad and
  14 pypi.
  15
  16
  17 How to use linaro-django-pagination
  18 -----------------------------------
  19
  20 ``linaro-django-pagination`` allows for easy Digg-style pagination without
  21 modifying your views.
  22
  23 There are really 5 steps to setting it up with your projects (not including
  24 installation, which is covered in INSTALL.txt in this same directory.)
  25
  26 1. List this application in the ``INSTALLED_APPS`` portion of your settings
  27    file.  Your settings file might look something like::
  28
  29        INSTALLED_APPS = (
  30            # ...
  31            'linaro_django_pagination',
  32        )
  33
  34
  35 2. Install the pagination middleware.  Your settings file might look something
  36    like::
  37
  38        MIDDLEWARE_CLASSES = (
  39            # ...
  40            'linaro_django_pagination.middleware.PaginationMiddleware',
  41        )
  42
  43 3. If it's not already added in your setup, add the request context processor.
  44    Note that context processors are set by default implicitly, so to set them
  45    explicitly, you need to copy and paste this code into your under
  46    the value TEMPLATE_CONTEXT_PROCESSORS::
  47
  48         ("django.core.context_processors.auth",
  49         "django.core.context_processors.debug",
  50         "django.core.context_processors.i18n",
  51         "django.core.context_processors.media",
  52         "django.core.context_processors.request")
  53
  54 4. Add this line at the top of your template to load the pagination tags:
  55
  56        {% load pagination_tags %}
  57
  58
  59 5. Decide on a variable that you would like to paginate, and use the
  60    autopaginate tag on that variable before iterating over it.  This could
  61    take one of two forms (using the canonical ``object_list`` as an example
  62    variable):
  63
  64        {% autopaginate object_list %}
  65
  66    This assumes that you would like to have the default 20 results per page.
  67    If you would like to specify your own amount of results per page, you can
  68    specify that like so:
  69
  70        {% autopaginate object_list 10 %}
  71
  72    Note that this replaces ``object_list`` with the list for the current page, so
  73    you can iterate over the ``object_list`` like you normally would.
  74
  75
  76 6. Now you want to display the current page and the available pages, so
  77    somewhere after having used autopaginate, use the paginate inclusion tag:
  78
  79        {% paginate %}
  80
  81    This does not take any arguments, but does assume that you have already
  82    called autopaginate, so make sure to do so first.
  83
  84
  85 That's it!  You have now paginated ``object_list`` and given users of the site
  86 a way to navigate between the different pages--all without touching your views.
  87
  88
  89 Optional Settings
  90 -----------------
  91
  92 In linaro-django-pagination, there are no required settings.  There are,
  93 however, a small set of optional settings useful for changing the default
  94 behavior of the pagination tags.  Here's an overview:
  95
  96 ``PAGINATION_DEFAULT_PAGINATION``
  97     The default amount of items to show on a page if no number is specified.
  98
  99 ``PAGINATION_DEFAULT_WINDOW``
 100     The number of items to the left and to the right of the current page to
 101     display (accounting for ellipses).
 102
 103 ``PAGINATION_DEFAULT_ORPHANS``
 104     The number of orphans allowed.  According to the Django documentation,
 105     orphans are defined as::
 106
 107         The minimum number of items allowed on the last page, defaults to zero.
 108
 109 ``PAGINATION_INVALID_PAGE_RAISES_404``
 110     Determines whether an invalid page raises an ``Http404`` or just sets the
 111     ``invalid_page`` context variable.  ``True`` does the former and ``False``
 112     does the latter.
 113 """
 114
 115 setup(
 116     name='linaro-django-pagination',
 117     version=version,
 118     description="linaro-django-pagination",
 119     long_description=LONG_DESCRIPTION,
 120     classifiers=[
 121         "Programming Language :: Python",
 122         "Topic :: Software Development :: Libraries :: Python Modules",
 123         "Framework :: Django",
 124         "Environment :: Web Environment",
 125     ],
 126     keywords='pagination,django',
 127     author='Eric Florenzano',
 128     author_email='zygmunt.krynicki@linaro.org',
 129     url='http://launchpad.net/linaro-django-pagination/',
 130     license='BSD',
 131     packages=find_packages(),
 132     include_package_data=True,
 133     zip_safe=False,
 134 )