Luke Plant avatar Luke Plant committed ee14dfe

Added proper docs.

Comments (0)

Files changed (11)

-====================
- django-easyfilters
-====================
-
-ALPHA software! Starting to get useful, but APIs still not quite settled.
+==================
+django-easyfilters
+==================
 
 Overview
 ========
 
-An app that provides filters like list_filter and date_hierarchy in Django's
-admin, but for use outside the admin, with result counts for the choices,
-and with more intelligence and things 'just working'.
+This library provides filters similar in some ways to ``list_filter`` and
+``date_hierarchy`` in Django's admin, but for use outside the
+admin. Importantly, it also includes result counts for the choices. It is
+designed to be very easy to get started with.
 
-The UI of the filters is links i.e. just click on links to add/remove
-filters.  For fields where the values are more like a continuum, the aim is
-to use autogenerated, intelligent ranges.  Dates will use something like the
-Django admin's date_hierarchy feature.
+Docs
+====
+See the docs/ directory, especially docs/overview.rst
 
 
-Install
-=======
+Demo
+====
 
-Just install using pip/easy_install - this is a pure Python library that doesn't
-need to be in INSTALLED_APPS.
+A small demo app is included, see the instructions in docs/develop.rst
 
-Usage
-=====
+A (currently) live example can be seen at:
 
-Suppose your model.py looks something like this::
+http://www.christchurchbradford.org.uk/sermons/
 
-    class Book(models.Model):
-        name = models.CharField(max_length=100)
-        binding = models.CharField(max_length=2, choices=BINDING_CHOICES)
-        authors = models.ManyToManyField(Author)
-        genre = models.ForeignKey(Genre)
-        price = models.DecimalField(max_digits=6, decimal_places=2)
-        date_published = models.DateField()
+Status
+======
 
-(BINDING_CHOICES, Author and Genre omitted for brevity).
+The library is in a useful state, but not quite 'complete'. The main glaring
+feature omission in nice handling of Decimal fields (or other numeric fields that need
+to be treated as a continuum of values) to provide range-base selection.
 
-And you have a views.py something like this::
+The internal API of Filter and FilterSet are not firmed up, but are not far from
+being so. Test coverage is extensive.
 
-    from myapp.models import Book
-
-    def booklist(request):
-        books = Book.objects.all()
-        return render(request, "booklist.html", {'books': books})
-
-
-and a template like this::
-
-    {% for book in books %}
-       {# etc #}
-    {% endfor %}
-
-
-To add the filters, in views.py you do something like this::
-
-    from django_easyfilters import FilterSet
-    from myapp.models import Book
-
-    class BookFilterSet(FilterSet):
-        fields = [
-            'binding',
-            'authors',
-            'genre',
-            'price',
-            ]
-
-    def booklist(request):
-        books = Book.objects.all()
-        booksfilter = BookFilterSet(books, request.GET)
-        return render(request, "booklist.html", {'books': booksfilter.qs,
-                                                 'booksfilter': booksfilter})
-
-Then, in the template, just add ``{{ booksfilter }}`` above the list of
-books. You can also use pagination e.g. using django-pagination::
-
-    {% autopaginate books 20 %}
-
-    <h1>Filters:</h1>
-    {{ booksfilter }}
-
-    {% paginate %}
-
-    {% for book in books %}
-       {# etc #}
-    {% endfor %}
-
-Customisation of the filters can be done using a tuple containing (field_name,
-dict of options), instead of just field_name::
-
-    class BookFilterSet(FilterSet):
-        model = Book
-        fields = [
-            'binding',
-            ('genre', dict(order_by_count=True))
-        ]
-
-Done so far
-===========
-
-* Support for ForeignKey - ForeignKeyFilter
-* Support for anything with 'choices' defined - ChoicesFilter
-* Support for ManyToMany - ManyToManyFilter
-* Fallback support for CharField, IntegerField, everything else - ValuesFilter
-* Options:
-
-  * order_by_count
-
-* Very good test coverage
+Feedback regarding API or features is very welcome!
 
 TODO
 ====
 
-* DateField, DateTimeField
-* Automatic range-based filters - e.g. for prices
-* More options for customisation
-
-
-  * 'defaults' attribute for FilterSet
-
-* Docs for customisation
-
-  * Options provided by Filters
-  * API of Filter
-  * API of FilterSet for overriding rendering
-
-
-Development
-===========
-
-First, ensure the directory containing this README is on your Python path
-(virtualenv recommended). Django is a required dependency.
-
-Tests
------
-
-To run the test suite, do::
-
-   ./manage.py test django_easyfilters
-
-Editing test fixtures
----------------------
-
-To edit the test fixtures, you can edit the fixtures in
-django_easyfilters/tests/fixtures/, or you can do it via an admin interface:
-
-First create an empty db::
-
-   rm tests.db
-   ./manage.py syncdb
-
-Then load with current test fixture::
-
-   ./manage.py loaddata django_easyfilters_tests
-
-Then edit in admin at http://localhost:8000/admin/ ::
-
-   ./manage.py runserver
-
-Or from a Python shell.
-
-Then dump data::
-
-  ./manage.py dumpdata tests --format=json --indent=2 > django_easyfilters/tests/fixtures/django_easyfilters_tests.json
-
-
-Demo
-----
-
-Once the test fixtures have been loaded into the DB, and the devserver is
-running, as above, you can view a test page at http://localhost:8000/books/
+* Automatic range-based filters for DecimalFields - e.g. for prices
+* Ability to specify 'defaults' attribute for FilterSet
+* Allow the automatic 'page' resetting to be customized
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-easyfilters.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-easyfilters.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-easyfilters"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-easyfilters"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+# -*- coding: utf-8 -*-
+#
+# django-easyfilters documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 28 00:22:30 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-easyfilters'
+copyright = u'2011, Luke Plant'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-easyfiltersdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'django-easyfilters.tex', u'django-easyfilters Documentation',
+   u'Luke Plant', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'django-easyfilters', u'django-easyfilters Documentation',
+     [u'Luke Plant'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'django-easyfilters', u'django-easyfilters Documentation', u'Luke Plant',
+   'django-easyfilters', 'One line description of project.', 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+===========
+Development
+===========
+
+First, ensure the directory containing the ``django_easyfilters`` directory is
+on your Python path (virtualenv recommended). Django is a required dependency.
+
+Tests
+-----
+
+To run the test suite, do::
+
+   ./manage.py test django_easyfilters
+
+Editing test fixtures
+---------------------
+
+To edit the test fixtures, you can edit the fixtures in
+django_easyfilters/tests/fixtures/, or you can do it via an admin interface:
+
+First create an empty db::
+
+   rm tests.db
+   ./manage.py syncdb
+
+Then load with current test fixture::
+
+   ./manage.py loaddata django_easyfilters_tests
+
+Then edit in admin at http://localhost:8000/admin/ ::
+
+   ./manage.py runserver
+
+Or from a Python shell.
+
+Then dump data::
+
+  ./manage.py dumpdata tests --format=json --indent=2 > django_easyfilters/tests/fixtures/django_easyfilters_tests.json
+
+
+Demo
+----
+
+Once the test fixtures have been loaded into the DB, and the devserver is
+running, as above, you can view a test page at http://localhost:8000/books/
+=======
+Filters
+=======
+.. currentmodule:: django_easyfilters.filters
+
+When you specify the ``fields`` attribute on a
+:class:`~django_easyfilters.FilterSet` subclass, various different ``Filter``
+classes will be chosen depending on the type of field. They are listed below,
+with the keyword argument options that they take.
+
+At the moment, all other methods of Filter and subclasses are considered private
+implementation details, until all the Filters are implemented and the API firms
+up.
+
+.. class:: Filter
+
+   This is the base class for all filters, and has provides some options:
+
+   * ``query_param``:
+
+     The parameter in the query string that will be used for this field.
+     This can be useful for shortening the query strings that are generated.
+
+   * ``order_by_count``:
+
+     Default: False
+
+     If ``True``, this will cause the choices to be sorted so that the choices
+     with the largest 'count' appear first.
+
+.. class:: ForeignKeyFilter
+
+   This is used for ForeignKey fields
+
+.. class:: ManyToManyFilter
+
+   This is used for ManyToMany fields
+
+.. class:: ChoicesFilter
+
+   This is used for fields that have 'choices' defined. The choices presented
+   will be in the order specified in 'choices'.
+
+.. class:: DateTimeFilter
+
+   This is the most complex of the filters, as it allows drill-down from year to
+   month to day. It takes the following options:
+
+   * ``max_links``
+
+     Default: 12
+
+     The maximum number of links to display. If the number of choices at any
+     level does not fit into this value, ranges will be used to shrink the
+     number of choices.
+
+   * ``max_depth``
+
+     Default: None
+
+     If ``'year'`` or ``'month'`` is specified, the drill-down will be limited
+     to that level.
+
+.. class:: ValuesFilter
+
+   This is the fallback that is used when nothing else matches.

docs/filterset.rst

+=========
+FilterSet
+=========
+
+.. currentmodule:: django_easyfilters.filterset
+
+.. class:: FilterSet
+
+   This is meant to be used by subclassing. The only required
+   attribute is ``fields``, which must be a list of fields to produce filters
+   for. For example, given the following model definition:
+
+   .. code-block:: python
+
+      class Book(models.Model):
+          name = models.CharField(max_length=100)
+          authors = models.ManyToManyField(Author)
+          genre = models.ForeignKey(Genre)
+          date_published = models.DateField()
+
+   You could create a BookFilterSet like this:
+
+   .. code-block:: python
+
+
+       class BookFilterSet(FilterSet):
+           fields = [
+               'genre',
+               'authors',
+               'date_published',
+           ]
+
+   The items in the fields attribute can also be two-tuples containing first
+   the field name and second a dictionary of options to be passed to the
+   :doc:`filters <filters>` as keyword arguments.
+
+
+   To use the BookFilterSet, please see :doc:`the overview instructions
+   <overview>`. The public API of ``FilterSet`` for use consists of:
+
+   .. method:: __init__(queryset, params)
+
+      queryset must be a QuerySet, which can already be filtered.
+
+      params must be a QueryDict, normally request.GET.
+
+   .. attribute:: qs
+
+      This attribute contains the input QuerySet filtered according to the data
+      in ``params``.
+
+
+   In addition, there are methods that can be overridden to customise the FilterSet:
+
+
+   .. method:: get_template(field_name)
+
+      This method can be overriden to render the filterset. It is called for
+      each field in the filterset, with the field name being passed in.
+
+      It is expected to return a Django Template instance. This template will
+      then be rendered with the following Context data:
+
+      * ``filterlabel`` - the label for the filter (derived from verbose_name of
+        the field)
+      * ``choices`` - a list of `choices` for the filter. Each one has the
+        following attributes:
+
+        * ``link_type``: either ``remove``, ``add`` or ``display``, depending
+          on the type of the choice.
+
+        * ``label``: the text to be displayed for this choice.
+
+        * ``url`` for those that are ``remove`` or ``add``, a URL for selecting
+          that filter.
+
+        * ``count``: for those that are ``add`` links, the number of items in
+          the QuerySet that match that choice.
+.. django-easyfilters documentation master file, created by
+   sphinx-quickstart on Tue Jun 28 00:22:30 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to django-easyfilters's documentation!
+==============================================
+
+django-easyfilters provides a UI for filtering a Django QuerySet by clicking on
+links. It is similar in some ways to ``list_filter`` and ``date_hierarchy`` in
+Django's admin, but for use outside the admin. Importantly, it also includes
+result counts for the choices, and it has a bigger emphasis on intelligent
+display and things 'just working'.
+
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   install
+   overview
+   filterset
+   filters
+   develop
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+============
+Installation
+============
+
+Install using pip or easy_install. Nothing further is required.
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-easyfilters.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-easyfilters.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

docs/overview.rst

+========
+Overview
+========
+
+Suppose your model.py looks something like this:
+
+.. code-block:: python
+
+    class Book(models.Model):
+        name = models.CharField(max_length=100)
+        binding = models.CharField(max_length=2, choices=BINDING_CHOICES)
+        authors = models.ManyToManyField(Author)
+        genre = models.ForeignKey(Genre)
+        price = models.DecimalField(max_digits=6, decimal_places=2)
+        date_published = models.DateField()
+
+(with BINDING_CHOICES, Author and Genre omitted for brevity).
+
+You might want to present a list of Book objects, allowing the user to filter on
+the various fields. Assuming your have a views.py is something like this:
+
+.. code-block:: python
+
+    from myapp.models import Book
+
+    def booklist(request):
+        books = Book.objects.all()
+        return render(request, "booklist.html", {'books': books})
+
+and the template is like this:
+
+.. code-block:: django
+
+    {% for book in books %}
+       {# etc #}
+    {% endfor %}
+
+To add the filters, in views.py, you add the following:
+
+.. code-block:: python
+
+    from django_easyfilters import FilterSet
+    from myapp.models import Book
+
+    class BookFilterSet(FilterSet):
+        fields = [
+            'binding',
+            'authors',
+            'genre',
+            'price',
+            ]
+
+    def booklist(request):
+        books = Book.objects.all()
+        booksfilter = BookFilterSet(books, request.GET)
+        return render(request, "booklist.html", {'books': booksfilter.qs,
+                                                 'booksfilter': booksfilter})
+
+Notice that the ``books`` item put in the context has been replaced by
+``bookfilter.qs``, so that the QuerySet passed to the template has filtering
+applied to it, as defined by BookFilterSet and the information from the query
+string (request.GET).
+
+The ``booksfilter`` item has been added, in order for the filters to be
+displayed on the template.
+
+Then, in the template, just add ``{{ booksfilter }}`` to the template.
+books. You can also use pagination e.g. using django-pagination:
+
+.. code-block:: django
+
+    {% autopaginate books 20 %}
+
+    <h2>Filters:</h2>
+    {{ booksfilter }}
+
+    {% paginate %}
+
+    <h2>Books found</h2>
+    {% for book in books %}
+       {# etc #}
+    {% endfor %}
+
+Customisation of the filters can be done using a tuple containing (``field_name``,
+dict of options), instead of just ``field_name``::
+
+    class BookFilterSet(FilterSet):
+        model = Book
+        fields = [
+            'binding',
+            ('genre', dict(order_by_count=True))
+        ]
+
+See :doc:`the Filters documentation <filters>` for options that can be
+specified. See :doc:`the FilterSet documentation <filterset>` for ways to
+customize the rendering of the filters.
 
 setup(
     name = "django-easyfilters",
-    version = '0.0.1',
+    version = '0.1',
     packages = find_packages(),
     include_package_data = True,
 
     license = "MIT",
     keywords = "django filter autofilter drilldown easy simple",
     classifiers = [
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 4 - Beta",
         "Environment :: Web Environment",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Framework :: Django",
         "Topic :: Software Development :: User Interfaces",
         ],
-    install_requires = ['django >= 1.3'],
+    install_requires = ['django >= 1.3', 'dateutil'],
 )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.