django-admin-anylogicfilter 0.0.1

Django app that adds a filter with any functionality you need.

django-admin-anylogicfilter

Django app that adds a filter with any functionality you need.

Requirements

App tested with

• Python 3.11
• Django 4

Installation

pip install anylogicfilter

Quick start

1. Add anylogicfilter to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'anylogicfilter',
    ...
]

2. Declare your filter class by inheriting from AnyLogicFilter class:

class MyFilter(AnyLogicFilter):
    form_fields = [
        ('field_name', forms.CharField(max_length=100, required=True, initial='')),
        ('other_field_name', forms.BooleanField(label='Not default by-name label', required=False, initial='')),
    ]

    def queryset(self, request, queryset):
        if self.form.is_valid():
            filter_params = {
                p: self.form.cleaned_data.get(p)
                for p in self.expected_parameters()
                if self.form.cleaned_data.get(p) is not None
            }
            # some query, using subquery with 2+ parameters or anything else you need
            return queryset.filter(...filter_params['field_name']...filter_params['other_field_name']...)
        else:
            return queryset

3. Add it to admin.py:

@admin.register(YourModel)
class YourModelAdmin(admin.ModelAdmin):
    list_filter = [
        ...
        ('name_of_any_field_from_or_related_to_your_model', MyFilter),
        ...
    ]

4. Enjoy!

Contributing

Bug reports and/or pull requests are welcome :)

License

MIT License