Metadata-Version: 2.1
Name: django-admin-sbf
Version: 0.4
Summary: A Django admin app to search by specific field instead of all fields
Home-page: https://github.com/anuj9196/django-admin-sbf
Author: Anuj Sharma
Author-email: contact@anujs.in
License: UNKNOWN
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules

============================
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

.. code-block::

    pip install django-admin-sbf

2. Add "django_admin_sbf" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'django_admin_sbf',
    ]

3. Extent the admin class for any model using `DjangoAdminSBF` instead of `ModelAdmin`

4. Define `search_fields` same as Django default.

Screenshots
-----------

.. image:: assets/image/admin_sbf.png
   :alt: Django admin sbf

Example
-------

.. code-block::

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

       search_fields = [
           'course',
           'subject
       ]


