Skip to content

A generic system for filtering Django QuerySets based on user selections

License

Notifications You must be signed in to change notification settings

smcoll/django-filter

This branch is 1074 commits behind carltongibson/django-filter:main.

Folders and files

NameName
Last commit message
Last commit date
Nov 23, 2013
Jan 3, 2014
Feb 25, 2013
Nov 23, 2013
Mar 12, 2013
Aug 19, 2013
Oct 19, 2013
Aug 10, 2013
Oct 21, 2012
Aug 10, 2013
Mar 23, 2013
Mar 12, 2013
Jun 12, 2013
Jul 27, 2013
Aug 10, 2013

Repository files navigation

Django Filter

Django-filter is a reusable Django application for allowing users to filter querysets dynamically.

Full documentation on read the docs.

https://secure.travis-ci.org/alex/django-filter.png?branch=master

Requirements

  • Python 2.6+
  • Django 1.4.5+

Installation

Install using pip:

pip install django-filter

Or clone the repo and add to your PYTHONPATH:

git clone git@github.com:alex/django-filter.git

Usage

Django-filter can be used for generating interfaces similar to the Django admin's list_filter interface. It has an API very similar to Django's ModelForms. For example, if you had a Product model you could have a filterset for it with the code:

import django_filters

class ProductFilter(django_filters.FilterSet):
    class Meta:
        model = Product
        fields = ['name', 'price', 'manufacturer']

And then in your view you could do:

def product_list(request):
    filter = ProductFilter(request.GET, queryset=Product.objects.all())
    return render_to_response('my_app/template.html', {'filter': filter})

Support

If you have questions about usage or development you can join the mailing list.

About

A generic system for filtering Django QuerySets based on user selections

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 96.4%
  • Shell 3.6%