Improve {% autopaginate %} error message
[django-pagination.git] / setup.py
old mode 100644 (file)
new mode 100755 (executable)
index 5718e27..f1ce26d
--- a/setup.py
+++ b/setup.py
-from setuptools import setup, find_packages
-
-version = '1.0.9'
-
-LONG_DESCRIPTION = """
-How to use django-pagination
-----------------------------
-
-``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.)
-
-1. List this application in the ``INSTALLED_APPS`` portion of your settings
-   file.  Your settings file might look something like::
-   
-       INSTALLED_APPS = (
-           # ...
-           'pagination',
-       )
-
-
-2. Install the pagination middleware.  Your settings file might look something
-   like::
-   
-       MIDDLEWARE_CLASSES = (
-           # ...
-           'pagination.middleware.PaginationMiddleware',
-       )
-
-3. If it's not already added in your setup, add the request context processor.
-   Note that context processors are set by default implicitly, so to set them
-   explicitly, you need to copy and paste this code into your under
-   the value TEMPLATE_CONTEXT_PROCESSORS::
-   
-        ("django.core.context_processors.auth",
-        "django.core.context_processors.debug",
-        "django.core.context_processors.i18n",
-        "django.core.context_processors.media",
-        "django.core.context_processors.request")
-
-4. Add this line at the top of your template to load the pagination tags:
-
-       {% load pagination_tags %}
-
-
-5. Decide on a variable that you would like to paginate, and use the
-   autopaginate tag on that variable before iterating over it.  This could 
-   take one of two forms (using the canonical ``object_list`` as an example
-   variable):
-   
-       {% autopaginate object_list %}
-       
-   This assumes that you would like to have the default 20 results per page.
-   If you would like to specify your own amount of results per page, you can
-   specify that like so:
-   
-       {% autopaginate object_list 10 %}
-   
-   Note that this replaces ``object_list`` with the list for the current page, so
-   you can iterate over the ``object_list`` like you normally would.
-   
-
-6. Now you want to display the current page and the available pages, so
-   somewhere after having used autopaginate, use the paginate inclusion tag:
-   
-       {% paginate %}
-   
-   This does not take any arguments, but does assume that you have already
-   called autopaginate, so make sure to do so first.
-
+#!/usr/bin/env python
+# Copyright (c) 2008, Eric Florenzano
+# Copyright (c) 2010, 2011 Linaro Limited
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+#       copyright notice, this list of conditions and the following
+#       disclaimer in the documentation and/or other materials provided
+#       with the distribution.
+#     * Neither the name of the author nor the names of other
+#       contributors may be used to endorse or promote products derived
+#       from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-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 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.
+from setuptools import setup, find_packages
 
-``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.
+version = "1.1"
 
-``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='django-pagination',
+    name='linaro-django-pagination',
     version=version,
-    description="django-pagination",
-    long_description=LONG_DESCRIPTION,
-    classifiers=[
-        "Programming Language :: Python",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        "Framework :: Django",
-        "Environment :: Web Environment",
-    ],
+    author='Zygmunt Krynicki',
+    author_email='zygmunt.krynicki@linaro.org',
+    description="linaro-django-pagination",
+    long_description=open("README").read(),
     keywords='pagination,django',
-    author='Eric Florenzano',
-    author_email='floguy@gmail.com',
-    url='http://django-pagination.googlecode.com/',
+    url='https://github.com/zyga/django-pagination',
+    test_suite='linaro_django_pagination.test_project.tests.run_tests',
     license='BSD',
     packages=find_packages(),
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Web Environment",
+        "Framework :: Django",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 2.6",
+        "Programming Language :: Python :: 2.7",
+    ],
+    install_requires=[
+        'django >= 1.2',
+    ],
+    tests_require=[
+        'django-testproject >= 0.1',
+    ],
     include_package_data=True,
-    zip_safe=False,
 )