Django Filter
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
Metadata
2 maintainers
Release files for django-filter 26.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django_filter-26.2.tar.gz | 144.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_filter-26.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 238.9 kB
Release files / django_filter-26.2.tar.gz
| Download URL | django_filter-26.2.tar.gz |
|---|---|
| Size | 144.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd5cc83995fbe9f5f07fb5dcda16fde0f04de1ecf8ef82628b6c0ec921b751af
|
|
BLAKE2b-256 checksum How to use checksums |
07eec0f950fe24f3e0b69d054ad957f9229632b50bdc78e968f966d8b4efe16a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Release files / django_filter-26.2-py3-none-any.whl
| Download URL | django_filter-26.2-py3-none-any.whl |
|---|---|
| Size | 94.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df8f737841d6359df00b84dda9b5ab59067fe60292091f1bdae1e3e6281cedb0
|
|
BLAKE2b-256 checksum How to use checksums |
4a926b098caa5b980a9d13a8db4825b7670410fa572e9195e39648f7700f2a37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Security for django-filter 26.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
