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.7, 3.2, 3.3, 3.4, 3.5
Django 1.8, 1.9
Installation
Install using pip:
pip install django-filter
Or clone the repo and add to your PYTHONPATH:
git clone git@github.com:carltongibson/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(request, '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.13.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5e10bea3b30e43a9b0b7efdca8e91cb0c1d5bf4d316e8fb6c0c22300d30c7dd |
|
MD5 | e2f45d580f276c82b467eaa25698671f |
|
BLAKE2b-256 | cd9459853d25079093540f4a36c5cde4e34be6f4d69d06771a79e9441613b6ce |