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.3, 3.4, 3.5
Django: 1.8, 1.9, 1.10
DRF: 3.4, 3.5
Installation
Install using pip:
pip install django-filterOr clone the repo and add to your PYTHONPATH:
git clone git@github.com:carltongibson/django-filter.gitUsage
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.
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-1.0.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7cca9dab22c72df734ba24fb81ca018fdb6d2020c840e758d473dcedd341aa7b |
|
| MD5 | f7a35f43f4e9cc5053eb62cb268e7084 |
|
| BLAKE2b-256 | ccb206813f0daf2813c58457b78549e7bb2880fdc6aaaeaa73d3d8abfc05e196 |
