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.
Requirements
Python: 3.4, 3.5, 3.6, 3.7
Django: 1.11, 2.0, 2.1, 2.2
DRF: 3.8+
From Version 2.0 Django Filter is Python 3 only. If you need to support Python 2.7 use the version 1.1 release.
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 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
File details
Details for the file django-filter-2.1.0.tar.gz.
File metadata
- Download URL: django-filter-2.1.0.tar.gz
- Upload date:
- Size: 142.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3dafb7d2810790498895c22a1f31b2375795910680ac9c1432821cbedb1e176d |
|
| MD5 | 5053caee3bc241c904c280f7df7eb7ff |
|
| BLAKE2b-256 | 1e816efb58568c0a7dbbfd72ed76403591745f93eb166b183ff418add8a5cc24 |
Provenance
File details
Details for the file django_filter-2.1.0-py3-none-any.whl.
File metadata
- Download URL: django_filter-2.1.0-py3-none-any.whl
- Upload date:
- Size: 69.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a3014de317bef0cd43075a0f08dfa1d319a7ccc5733c3901fb860da70b0dda68 |
|
| MD5 | 31b28f649803c46c5c8f69d05a87154d |
|
| BLAKE2b-256 | 48b47d52fb480108c9af88a4af520b371ac2ada55eac9970e025f147d0131b64 |
