Skip to main content

django-filter meets django-pagination

Project description

# django-filters-mixin

Simple integration between [django-filter](https://github.com/alex/django-filter) and [Django Pagination](https://docs.djangoproject.com/en/dev/topics/pagination/)

[![Latest Version](https://pypip.in/version/django-filters-mixin/badge.svg)](https://pypi.python.org/pypi/django-filters-mixin/)
[![Downloads](https://pypip.in/download/django-filters-mixin/badge.svg)](https://pypi.python.org/pypi/django-filters-mixin/)
[![License](https://pypip.in/license/django-filters-mixin/badge.svg)](https://pypi.python.org/pypi/django-filters-mixin/)

### Requirements

You must have *django-filter* installed and configured, see the [django-filter documentation](https://github.com/alex/django-filter) for details and setup instructions.

## Installation

```shell
$ pip install django-filters-mixin
```

## Usage

The ``FilterMixin`` allows to use pagination together with filtering

```python
# views.py

import django_filters
from filters.views import FilterMixin


class CustomFilterSet(django_filters.FilterSet):
# read https://github.com/alex/django-filter#usage
...


class CustomFilterView(FilterMixin, django_filters.views.FilterView):
filterset_class = CustomFilterSet
paginate_by = 12
...
```

Please see ``example`` application. This application is used to manually test the functionalities of this package. This also serves as good example.

You need Django 1.4 or above to run that. It might run on older versions but that is not tested.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-filters-mixin-0.1.2.tar.gz (2.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page