django-filtrate 0.1.1

Quickstart

Install Django Filtrate:

pip install django-filtrate

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    "filtrate",
    ...
)

1. Add the mixin

class YourModelAdmin(FiltrateMixin, admin.ModelAdmin):
    ...

2. Navigate to http://localhost:8000/admin/filtrate/filter

3. Add your new filter!

How it works

As soon as you add the FiltrateMixin to your ModelAdmin, your model and admin will be registered with Filtrate. At this point, you can navigate to the Filtrate admin page, and begin adding filters.

Filtrate uses Django’s built-in filtering to build it’s ListFilters, by passing the filters field as arguments to the queryset. See https://docs.djangoproject.com/en/dev/topics/db/queries/#retrieving-specific-objects-with-filters for more details about filtering queries with Django.

For example, let’s say you have the following Template model:

class Template(models.Model):
    name = models.CharField(max_length=25)
    is_active = models.BooleanField(default=True)
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.name

If you wanted to build a filter for all active Templates created on or after 2023-01-01, then your Filter.filters should look like:

{
    "is_active": True,
    "created_at__gte": "2023-01-01",
}

Save it, and then voila, you have a new filter on your TemplateAdmin!

Happy Filtering!

Features

• Filter data model

• FiltrateMixin ModelAdmin mixin

TODO’s

• User-specific filters

• Export data

• Add Filter button on changelist

• Additional test coverage

• Setup tox

• More documentation

Local Development

make install
make test

Deployment

make build
make deploy

License

This project is provided under the BSD License.