Django-filter is a reusable Django application for allowing users to filter querysets dynamically.
Project description
Django-filter is a reusable Django application for allowing users to filter querysets dynamically.
Full documentation on read the docs.
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})
Django-filters additionally supports specifying FilterSet fields using a dictionary to specify filters with lookup types:
import django_filters class ProductFilter(django_filters.FilterSet): class Meta: model = Product fields = {'name': ['exact', 'icontains'], 'price': ['exact', 'gte', 'lte'], }
The filters will be available as ‘name’, ‘name__icontains’, ‘price’, ‘price__gte’, and ‘price__lte’ in the above example.
Support
If you have questions about usage or development you can join the mailing list.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_filter-0.10.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3bb373de457c5182fab231d9f6fcb0dd0dfb442473c4287f9bfcbd31daa2edb |
|
MD5 | d64a6aa2a798ce832c040844b1808c06 |
|
BLAKE2b-256 | 69c030e7659b7a4e3b0576f1357cf4faa74c582476bde7f60dc85db490139b59 |