django-admin-list-filters 1.0

Embedded filters for Django Admin site

DjangoAdminFilters library

The free, open-source DjangoAdminFilters library is designed to filter objects in the Django admin site. The library provide few filters for this purpose.

• DateRange: allows you to set a custom date range using input fields
• DateRangePicker: allows you to set a custom date range using javascript widget for select datetime from calendar

DateRange filter	DateRangePicker filter

For javascript widget used code from date-and-time-picker project with embedded code, that allow to select dates before current.

Installation

pip install django-admin-list-filters

To connect library to your project, add django_admin_filters to the INSTALLED_APPS list in your settings.py file.

INSTALLED_APPS = (

...

  'django_admin_filters',
)

After that, connect the static files of the library.

manage.py collectstatic

Usage

Let's say we have a table in the database. The records contain datetime fields.

# models.py
from django.db import models

class Log(models.Model):
    text = models.CharField(max_length=100)
    timestamp1 = models.DateTimeField(default=None, null=True)
    timestamp2 = models.DateTimeField(default=None, null=True)

To use filters with a date interval, you need to specify them in the admin.py file in the list_filter attribute of the corresponding class.

# admin.py
from django.contrib import admin
from django_admin_filters import DateRange, DateRangePicker
from .models import Log

class Admin(admin.ModelAdmin):
    list_display = ['text', 'timestamp1', 'timestamp2']
    list_filter = (('timestamp1', DateRange), ('timestamp2', DateRangePicker))

admin.site.register(Log, Admin)

Customization

You can customize the appearance and behavior of filters to suit your needs by inheriting the filter classes from the library and overriding some of the attributes.

# admin.py
from django_admin_filters import DateRange

class MyDateRange(DateRange):
    FILTER_LABEL = "Data range"
    FROM_LABEL = "From"
    TO_LABEL = "To"
    ALL_LABEL = 'All'
    CUSTOM_LABEL = "custom range"
    NULL_LABEL = "no date"
    BUTTON_LABEL = "Set range"
    DATE_FORMAT = "YYYY-MM-DD HH:mm"

    is_null_option = True

    options = (
      ('1da', "24 hours ahead", 60 * 60 * 24),
      ('1dp', "24 hours in the past", 60 * 60 * -24),
    )

You can override the following attributes.

• FILTER_LABEL: Title of the filter.
• FROM_LABEL: The label of the start date field.
• TO_LABEL: The label of the end date field.
• ALL_LABEL: The label of the menu item for displaying all records.
• CUSTOM_LABEL: The label of the menu item when date range is set.
• BUTTON_LABEL: The label of the button for set date range.
• NULL_LABEL: The label of the menu item for displaying records without date.
• is_null_option: Set this attribute to False to remove the option to display record without date from the filter menu.
• DATE_FORMAT: Hint about the format of the date and time fields.

You can change the date/time input format to your own. However, you may need to override the to_dtime method as well. This method is used to convert a user-entered string into a datetime value. By default, the method is defined as follows.

@staticmethod
def to_dtime(text):
    try:
        return datetime.fromisoformat(text)
    except ValueError:
        return None

The options attribute specifies filter menu items that allow you to select data from the current moment to an offset of a specified number of seconds in the past or future. Each element of the options list contains three values.

• A unique string to use in the GET request parameters. Except for the strings 'custom' and 'empty' which are used by the filter.
• The title of the item in the filter menu.
• Offset in seconds relative to the current moment. A negative value specifies an offset to the past.

The DateRangePicker filter with a javascript calendar date/time picker widget is derived from the DateRange filter and allows you to override all the attributes described above. Also, additional attributes can be overridden in DateRangePicker.

class MyDateRangePicker(DateRangePicker):
    WIDGET_LOCALE = 'en'
    WIDGET_BUTTON_LABEL = "Set"
    WIDGET_WITH_TIME = True

    WIDGET_START_TITLE = 'Start date'
    WIDGET_START_TOP = -350
    WIDGET_START_LEFT = -400

    WIDGET_END_TITLE = 'End date'
    WIDGET_END_TOP = -350
    WIDGET_END_LEFT = -400

• WIDGET_LOCALE: The language code for display the names of the months and days of the week. By default is the value of the LANGUAGE_CODE item in your project's settings.py file.
• WIDGET_BUTTON_LABEL: The label of the select button.
• WIDGET_WITH_TIME: Set this attribute to False if you only want to select a date without a time.
• WIDGET_START_TITLE: The title of the widget when selecting the start date of the interval.
• WIDGET_START_TOP: The vertical offset of the widget's calendar window when selecting the start date of the interval.
• WIDGET_START_LEFT: The horizontal offset of the widget's calendar window when selecting the start date of the interval.
• WIDGET_END_TITLE: The title of the widget when selecting the end date of the interval.
• WIDGET_END_TOP: The vertical offset of the widget's calendar window when selecting the end date of the interval.
• WIDGET_END_LEFT: The horizontal offset of the widget's calendar window when selecting the end date of the interval.

Usage example

You can run an example of using the library on your local host.

On the Windows platform, you must first install the following programs.

• Python3
• GNU Unix Utils for operations via makefile
• Git for Windows to access the source code repository.

Then clone the repository and run the installation, specifying the path to Python 3.

git clone [e-mail]:vb64/django.admin.filters.git
cd django.admin.filters
make setup PYTHON_BIN=/usr/bin/python3

Collect static files and create a database.

make static
make db

Create a database superuser by specifying a login and password for it.

make superuser

Run example.

make example

Open http://127.0.0.1:8000/admin/ in a browser to view the example site. To enter the admin panel you need to use the login and password that were set when creating the superuser.