Skip to content
A generic system for filtering Django QuerySets based on user selections
Python Other
  1. Python 99.9%
  2. Other 0.1%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.azure_pipelines Azure: limit Python 3.5 builds to supported versions. Feb 24, 2019
.github/ISSUE_TEMPLATE Update issue templates Jul 19, 2018
django_filters Fixed import of FieldDoesNotExist. (#1127) Sep 30, 2019
docs Docs: Updated field_name example in tips.txt. (#1141) Nov 14, 2019
requirements Bump pyyaml from 3.11 to 5.1 in /requirements (#1079) May 24, 2019
tests Extend test coverage. (#1130) Nov 14, 2019
.bumpversion.cfg Version 2.2. Jul 16, 2019
.gitignore Cleanup XML test runner output (#1060) Apr 4, 2019
.travis.yml Declared support for, and added testing against, Python 3.8. (#1138) Oct 29, 2019
AUTHORS group filter fields with meta option 'together' Mar 17, 2015
CHANGES.rst Version 2.2. Jul 16, 2019
LICENSE Small license changes (acknowledge individual contributors). Oct 21, 2012
MANIFEST.in Add templates to manifest, remove install note Dec 9, 2016
Makefile Update docs on `filter_overrides` usage Nov 18, 2016
README.rst Update list of supported versions (#1148) Nov 14, 2019
codecov.yml Disable codecov status check Mar 20, 2017
runshell.py Fix runshell sync behavior Apr 12, 2016
runtests.py Consolidate shell/test settings, replace syncdb w/ migrate Nov 23, 2015
setup.cfg Add linting and docs builds to CI (#850) Jul 13, 2018
setup.py Update list of supported versions (#1148) Nov 14, 2019
tox.ini Declared support for, and added testing against, Python 3.8. (#1138) Oct 29, 2019

README.rst

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.

https://dev.azure.com/noumenal/Django%20Filter/_apis/build/status/Django%20Filter-CI https://travis-ci.org/carltongibson/django-filter.svg?branch=master

Requirements

  • Python: 3.5, 3.6, 3.7, 3.8
  • Django: 1.11, 2.0, 2.1, 2.2, 3.0
  • DRF: 3.10+

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-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 have questions about usage or development you can join the mailing list.

You can’t perform that action at this time.