Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/runekaagaard/django-admin-filtrate

Custom filter framework for the Django Admin.
https://github.com/runekaagaard/django-admin-filtrate

Last synced: 6 days ago
JSON representation

Custom filter framework for the Django Admin.

Awesome Lists containing this project

README 

        
## About ##

This Django app makes it easier to create custom filters in the change list of

Django Admin and supplies a `TreeFilter` and a `DateRangeFilter` too. Se below.



## Updating to python3.9 and django3.2.7



Install with:



    pip install git+git://github.com/runekaagaard/django-admin-filtrate@8811bebb0f1985dfef599f65bcab923ba92ac9cc



Thanks user zxl634 for python3 support!



## Updating to 1.4-1.7 support ##



There are no release yet, but a version tested with 1.4 and 1.7 can be installed with pip like:



    pip install git+git://github.com/runekaagaard/django-admin-filtrate@19f56144bfff2180cdc4e3f89770d7423c2b0318



I still need to test it with 1.5 and 1.6, update the documentation and then coax PyPi into making a release. Help could be great :)

Major differences in this version is:



- `lookup_allowed()` no longer needed.

- Uses the new builtin Django Filter classes.

- No need to register with `filtrate.register_filter`.



## Updating to 1.3 support ##

I will write proper docs, things are getting messy here, but here is the

lowdown.



## Docs for 1.2 version ##



### New settings required ###

As I found out, you can't reliably convert the django date formats to

Datepicker formats. So this commit introduces these two new settings:



    FILTRATE = {

		# See http://jqueryui.com/demos/datepicker/#localization.

		'datepicker_region': 'en-GB',

		# See http://docs.jquery.com/UI/Datepicker/formatDate.

		'datepicker_date_format': 'yy-mm-dd',

	}



So if the above defaults does not suit you, you have to change them your self. 

Check out the Datepicker documentation to see how to use them.



### lookup_allowed() ###

Django 1.2.4 introduces restrictions on which lookups that can be queried

in the url, so at the moment the end user are responsible for

checking for those, as in this example:



    class CaseAdmin(admin.ModelAdmin):

		list_filter = ['client']

	

		def lookup_allowed(self, key, *args, **kwargs):

			if 'client__start_date' in key:

				return True

			else:

				return super(CaseAdmin, self).lookup_allowed(key, *args, **kwargs)



### Undefined Media() class bug ###

Time and my Python meta-fu is running out, and I couldn't fix it

so its not neccessary to define an empty Media() class as in:



    class CaseAdmin(admin.ModelAdmin):

		class Media():

			pass

			

## The FiltrateFilter ##

The base class that adds support for custom html in the content of the filter

and for using `Media()` classes.



## TreeFilter ##

A recursive tree filter using the excellent library http://www.jstree.com/. 



### Example ###

```python

# The Filter.

from filtrate.filters import TreeFilter

from itertools import groupby

class CompanyDepartmentFilter(TreeFilter):

    field_name = "client__department__id__in"

    

    def get_title(self):

        return 'By Department'

    

    def get_tree(self):

        from company.models import Department

        qs = Department.objects.all().order_by('company_order', 'company')

        return groupby(qs, lambda obj: getattr(obj, 'company'))



# The model.

from filtrate import register_filter

class Case(Model):

    ...

    client = models.ForeignKey(Client)

    register_filter(client, CompanyDepartmentFilter)

	...

```



## DateRangeFilter ##

Filters results in a given date range using the jQueryUI datepicker plugin.



### Example ###

```python

# The Filter.

from filtrate.filters import DateRangeFilter



class CaseLicenseStartDateFilter(DateRangeFilter):

    field_name = 'caselicense__start_date'

    

    def get_title(self):

        return "By license start date"



# The model.

from filtrate import register_filter

class Case(Model):

	...

    caselicense = models.ForeignKey(Licence)

    register_filter(caselicense, CaseLicenseStartDateFilter)

	...

```



## Installation ##



* Clone the repo and symlink or copy the "filtrate" folder to your apps folder.

* Add `filtrate` to your installed apps, before `django.contrib.admin`.

* Add the "filtrate/templates" folder to your template folders.



### Static files ###



FlexSelect requires "django.contrib.staticfiles" installed to work out of the 

box. If it is not then the js and css files must be installed manually. 

Read more about "django.contrib.staticfiles" at 

https://docs.djangoproject.com/en/1.3/ref/contrib/staticfiles/.