=============
jmb.filter
=============

``jmb.filters`` is a package that adds an advanced
search form in an admin changelist.

The advanced_search form allows to filter content of the changelist
and can coexist with the search entry of the standard django admin
interface as shown by the image below.

.. image:: ./images/advanced_search.png
   :align: right

It is easily configurable via a single attribute placed on the
ModelAdmin class::

    advanced_search_fields = (
        ('username', 'email__contains'),
	('joined__gte', 'joined__gte', 'groups__in'),
    )




It is based on the very popular `django-filter`_ package that is is a
generic, reusable application to alleviate writing some of the more
mundane bits of view code. Specifically, it allows users to filter
down a queryset based on a model's fields, displaying the form to let
them do this.

The main goal of jmb.filter is to add an easy interface to the django
admin interface to get :ref:`advanced search <advanced-search>`



Contents:

.. toctree::
    :maxdepth: 1

    readme
    install
    usage
    ref/filters
    ref/widgets
    advanced_search
    tests


.. _django-filter: https://github.com/carltongibson/django-filter