Source

django-easyfilters / README.rst

Luke Plant ee14dfe 


Luke Plant 7f6e409 
Luke Plant 26d97ec 


Luke Plant ee14dfe 



Luke Plant 7f6e409 
Luke Plant ee14dfe 


Luke Plant 7f6e409 
Luke Plant 26d97ec 
Luke Plant ee14dfe 

Luke Plant 22e1f7b 
Luke Plant ee14dfe 
Luke Plant 22e1f7b 
Luke Plant ee14dfe 
Luke Plant 26d97ec 
Luke Plant ee14dfe 
Luke Plant 7f6e409 
Luke Plant ee14dfe 

Luke Plant 7f6e409 
Luke Plant ee14dfe 


Luke Plant 8e23f4d 
Luke Plant ee14dfe 

Luke Plant 7f6e409 
Luke Plant ee14dfe 
Luke Plant 8e23f4d 



Luke Plant ee14dfe 

==================
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.

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


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, 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.

The internal API of Filter and FilterSet are not firmed up, but are not far from
being so. Test coverage is extensive.

Feedback regarding API or features is very welcome!

TODO
====

* 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
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.