Source

django-easyfilters / README.rst

django-easyfilters

Overview

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.

Download/install

Just install as a Python library.

PyPI page: http://pypi.python.org/pypi/django-easyfilters

Docs

See the docs/ directory, especially docs/overview.rst

Also hosted here: http://packages.python.org/django-easyfilters

Demo

A small demo app is included, see the instructions in docs/develop.rst

A (currently) live example can be seen at:

http://www.christchurchbradford.org.uk/sermons/

Status

The library is in a useful state and is used in production. Test coverage is extensive. Feedback regarding API or features is very welcome!

TODO

  • Possible: ability to specify 'defaults' attribute for FilterSet
  • Allow the automatic 'page' resetting to be customized
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.