# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-django-filter
VERSION=		24.2
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		Django dynamic filter of querysets (3.11)
SDESC[v12]=		Django dynamic filter of querysets (3.12)
HOMEPAGE=		https://github.com/carltongibson/django-filter/tree/main
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/7b/7d/ee51b0fd69425035a2efc101b2252cd08eab525c12db92fbea298823cc9f
DISTFILE[1]=		django_filter-24.2-py3-none-any.whl:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

USES=			cpe

DISTNAME=		django_filter-24.2.dist-info

CPE_PRODUCT=		django-filter
CPE_VENDOR=		django-filter_project
GENERATED=		yes

[PY311].RUN_DEPENDS_ON=			python-Django:single:v11
[PY311].USES_ON=			python:v11,wheel

[PY312].RUN_DEPENDS_ON=			python-Django:single:v12
[PY312].USES_ON=			python:v12,wheel

[FILE:2766:descriptions/desc.single]
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``. 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:

* [Status of supported Python versions]
* [List of supported Django versions]

Support for Python and Django versions will be dropped when they reach
end-of-life. Support for Python versions will be 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:

.. code-block:: sh

    pip install django-filter

Then add 'django_filters' to your INSTALLED_APPS.

.. code-block:: python

    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:

.. code-block:: python

    import django_filters

    class ProductFilter(django_filters.FilterSet):
        class Meta:
            model = Product
            fields = ['name', 'price', 'manufacturer']

And then in your view you could do:

.. code-block:: python

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

.. code-block:: python

    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`_.


[FILE:114:distinfo]
df2ee9857e18d38bed203c8745f62a803fa0f31688c9fe6f8e868120b1848e48        94530 django_filter-24.2-py3-none-any.whl