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 be 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.
2 maintainers
Release files for django-filter 24.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django_filter-24.3.tar.gz | 144.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_filter-24.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 239.5 kB
Release files / django_filter-24.3.tar.gz
| Download URL | django_filter-24.3.tar.gz |
|---|---|
| Size | 144.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d8ccaf6732afd21ca0542f6733b11591030fa98669f8d15599b358e24a2cd9c3
|
|
BLAKE2b-256 checksum How to use checksums |
50bcdc19ae39c235332926dd0efe0951f663fa1a9fc6be8430737ff7fd566b20
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Release files / django_filter-24.3-py3-none-any.whl
| Download URL | django_filter-24.3-py3-none-any.whl |
|---|---|
| Size | 95.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c4852822928ce17fb699bcfccd644b3574f1a2d80aeb2b4ff4f16b02dd49dc64
|
|
BLAKE2b-256 checksum How to use checksums |
09b192f1c30b47c1ebf510c35a2ccad9448f73437e5891bbd2b4febe357cc3de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
