django-filter

Django-filter is a generic, reusable application to alleviate writing some of the more mundane bits of view code. Specifically, it allows users to filter down a queryset based on a model’s fields, displaying the form to let them do this.

User Guide

• Installation
  • Requirements
• Getting Started
  • The model
  • The filter
  • The view
  • The URL conf
  • The template
  • Generic view & configuration
• Integration with DRF
  • Quickstart
  • Adding a FilterSet with filterset_class
  • Using the filterset_fields shortcut
  • Overriding FilterSet creation
  • Schema Generation with Core API and Open API
  • Crispy Forms
  • Additional FilterSet Features
• Tips and Solutions
  • Common problems for declared filters
  • Filtering by empty values
  • Filtering by relative times
  • Using initial values as defaults
  • Adding model field help_text to filters
• Migration Guide
  • Enabling warnings
  • Migrating to 2.0
  • Migrating to 1.0

Reference Documentation

• FilterSet Options
• Filter Reference
• Field Reference
• Widget Reference
• Settings Reference

Developer Documentation

• Running the Test Suite