Rename to linaro-django-pagination.

[django-pagination.git] / setup.py

diff --git a/setup.py b/setup.py
old mode 100644 (file)
new mode 100755 (executable)
index 9b09bbe..2d0dc88
--- a/setup.py
+++ b/setup.py
@@ -1,13 +1,24 @@
+#!/usr/bin/env python
 from setuptools import setup, find_packages
 
-version = '1.0.2'
+version = '1.0.7.1'
 
 LONG_DESCRIPTION = """
-How to use django-pagination
-----------------------------
 
-``django-pagination`` allows for easy Digg-style pagination without modifying
-your views.
+About the fork
+--------------
+
+This project is a fork of apparently dead "django-pagination" project
+originally written by 'Eric Florenzano'. It is maintained by the Linaro
+Validation/Infrastructure team. Latest releases can be found on launchpad and
+pypi.
+
+
+How to use linaro-django-pagination
+-----------------------------------
+
+``linaro-django-pagination`` allows for easy Digg-style pagination without
+modifying your views.
 
 There are really 5 steps to setting it up with your projects (not including 
 installation, which is covered in INSTALL.txt in this same directory.)
@@ -17,7 +28,7 @@ installation, which is covered in INSTALL.txt in this same directory.)
    
        INSTALLED_APPS = (
            # ...
-           'pagination',
+           'linaro_django_pagination',
        )
 
 
@@ -26,7 +37,7 @@ installation, which is covered in INSTALL.txt in this same directory.)
    
        MIDDLEWARE_CLASSES = (
            # ...
-           'pagination.middleware.PaginationMiddleware',
+           'linaro_django_pagination.middleware.PaginationMiddleware',
        )
 
 3. If it's not already added in your setup, add the request context processor.
@@ -73,12 +84,38 @@ installation, which is covered in INSTALL.txt in this same directory.)
 
 That's it!  You have now paginated ``object_list`` and given users of the site
 a way to navigate between the different pages--all without touching your views.
+
+
+Optional Settings
+-----------------
+
+In linaro-django-pagination, there are no required settings.  There are,
+however, a small set of optional settings useful for changing the default
+behavior of the pagination tags.  Here's an overview:
+
+``PAGINATION_DEFAULT_PAGINATION``
+    The default amount of items to show on a page if no number is specified.
+
+``PAGINATION_DEFAULT_WINDOW``
+    The number of items to the left and to the right of the current page to
+    display (accounting for ellipses).
+
+``PAGINATION_DEFAULT_ORPHANS``
+    The number of orphans allowed.  According to the Django documentation,
+    orphans are defined as::
+    
+        The minimum number of items allowed on the last page, defaults to zero.
+
+``PAGINATION_INVALID_PAGE_RAISES_404``
+    Determines whether an invalid page raises an ``Http404`` or just sets the
+    ``invalid_page`` context variable.  ``True`` does the former and ``False``
+    does the latter.
 """
 
 setup(
-    name='pagination',
+    name='linaro-django-pagination',
     version=version,
-    description="django-pagination",
+    description="linaro-django-pagination",
     long_description=LONG_DESCRIPTION,
     classifiers=[
         "Programming Language :: Python",
@@ -88,11 +125,10 @@ setup(
     ],
     keywords='pagination,django',
     author='Eric Florenzano',
-    author_email='floguy@gmail.com',
-    url='http://www.eflorenzano.com/',
+    author_email='zygmunt.krynicki@linaro.org',
+    url='http://launchpad.net/linaro-django-pagination/',
     license='BSD',
     packages=find_packages(),
     include_package_data=True,
     zip_safe=False,
-    install_requires=['setuptools'],
 )