Django-filter is a reusable Django application for allowing users to filter querysets dynamically.
Project description
Django-filter is a reusable Django application allowing users to declaratively add dynamic QuerySet filtering from URL parameters.
Full documentation on read the docs.
Versioning and stability policy
Django-Filter is a mature and stable package. It uses a two-part CalVer versioning scheme, such as 21.1. The first number is the year. The second is the release number within that year.
On an on-going basis, Django-Filter aims to support all current Django versions, the matching current Python versions, and the latest version of Django REST Framework.
Please see:
Support for Python and Django versions will be dropped when they reach end-of-life. Support for Python versions will dropped when they reach end-of-life, even when still supported by a current version of Django.
Other breaking changes are rare. Where required, every effort will be made to apply a “Year plus two” deprecation period. For example, a change initially introduced in 23.x would offer a fallback where feasible and finally be removed in 25.1. Where fallbacks are not feasible, breaking changes without deprecation will be called out in the release notes.
Installation
Install using pip:
pip install django-filterThen add 'django_filters' to your INSTALLED_APPS.
INSTALLED_APPS = [
...
'django_filters',
]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})Usage with Django REST Framework
Django-filter provides a custom FilterSet and filter backend for use with Django REST Framework.
To use this adjust your import to use django_filters.rest_framework.FilterSet.
from django_filters import rest_framework as filters
class ProductFilter(filters.FilterSet):
class Meta:
model = Product
fields = ('category', 'in_stock')For more details see the DRF integration docs.
Support
If you need help you can start a discussion. For commercial support, please contact Carlton Gibson via his website.
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-23.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e3c52ad83c32fb5882125105efb5fea2a1d6a85e7dc64b04ef52edbf14451b6c |
|
| MD5 | a83305b5075e4059772ca6e217d78cdc |
|
| BLAKE2b-256 | 7f8335f62a59ce976309ae974ba6aceaf159f40e5c1a8d8e997327e0211d97dc |
