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, 1.11
DRF: 3.5
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})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.
2 maintainers
Metadata
2 maintainers
Release files for django-filter 1.0.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-1.0.3.tar.gz | 123.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_filter-1.0.3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 166.2 kB
Release files / django-filter-1.0.3.tar.gz
| Download URL | django-filter-1.0.3.tar.gz |
|---|---|
| Size | 123.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6adeebc5853e8fd5211878895ab279f6be16b855e384957ffa574f669336ddc1
|
|
BLAKE2b-256 checksum How to use checksums |
7e5452429bb187338c41d9bce57831b65eb4cdd15503f682915f8f48061ae6fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / django_filter-1.0.3-py2.py3-none-any.whl
| Download URL | django_filter-1.0.3-py2.py3-none-any.whl |
|---|---|
| Size | 43.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
0f2ad1f4a31aa66a8dc8e6cb8590c23848563e04b706c751bf69068a0d3cc57c
|
|
BLAKE2b-256 checksum How to use checksums |
12c792cb4992dfbbd6773f4b4b947fc41baa3aa235adedb2f322143b0f7bf3b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
