Django-filter is a reusable Django application for allowing users to filter querysets dynamically.
Project description
Kaizntree Django Filter
This is a fork from django-filter with some minor funcionalities added for developing at Kaizntree.
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.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-filter
Then 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.
Project details
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-kaizntree-21.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c85089891b1ff945d3eb0bfa89c696b47487ed15530f21536d37641a40cf64f1 |
|
MD5 | 103922c85662276739c232d33d7de094 |
|
BLAKE2b-256 | 24a7e24c4f383110472a71c0f70b65187d35ad8a9b923b2779c5d814d5ac978c |
Hashes for django_filter_kaizntree-21.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5af77a946fc37d0fcfddb8a957c5cc11b59c435b7bd5491d22f7ea68e7a4393 |
|
MD5 | b2087c7831fcaab9788d72be8eaeb885 |
|
BLAKE2b-256 | 705a9e1ecb2e60e69ed64401be939f38168cb7e2ca0dc70c89743aa45751f809 |