Skip to content

A generic system for filtering Django QuerySets based on user selections

License

Notifications You must be signed in to change notification settings

earshinov/django-filter

This branch is 10 commits ahead of, 162 commits behind carltongibson/django-filter:main.

Folders and files

NameName
Last commit message
Last commit date
Mar 4, 2020
Jul 19, 2018
May 24, 2020
May 8, 2020
May 14, 2020
May 24, 2020
Jul 16, 2019
Apr 4, 2019
Mar 4, 2020
Mar 17, 2015
Jul 16, 2019
Oct 21, 2012
Dec 9, 2016
Nov 18, 2016
Mar 20, 2020
Mar 20, 2017
Mar 20, 2020
Nov 23, 2015
Jul 13, 2018
Mar 20, 2020
May 20, 2020

Repository files navigation

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: 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.

About

A generic system for filtering Django QuerySets based on user selections

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.9%
  • Other 0.1%