Skip to content

anuj9196/django-admin-sbf

Repository files navigation

Django Admin Search-by-Field

Django Admin SBF is a Django admin app to customise the default search functionality to search by specific field instead of all the fields. This helps in reducing the SQL query overload when there are too much data to process and multiple fields to search from.

Detailed documentation is in the "docs" directory.

Quick start

  1. Install
pip install django-admin-sbf
  1. Add "django_admin_sbf" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        'django_admin_sbf',
    ]
    
  2. Extent the admin class for any model using DjangoAdminSBF instead of ModelAdmin

  3. Define search_fields same as Django default.

Screenshots

Django admin sbf

Example

@admin.register(Education)
class EducationAdmin(DjangoAdminSBF):

    search_fields = [
        'course',
        'subject
    ]