https://github.com/julianwachholz/django-autocompletefilter

Django 2.0+ ModelAdmin list_filter with autocomplete widget.
https://github.com/julianwachholz/django-autocompletefilter

autocomplete django django-admin python

Last synced: 10 months ago
JSON representation

Django 2.0+ ModelAdmin list_filter with autocomplete widget.

• Host: GitHub
• URL: https://github.com/julianwachholz/django-autocompletefilter
• Owner: julianwachholz
• License: mit
• Created: 2018-06-26T07:55:55.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T11:49:26.000Z (almost 2 years ago)
• Last Synced: 2025-08-23T08:04:51.262Z (11 months ago)
• Topics: autocomplete, django, django-admin, python
• Language: Python
• Homepage: https://twitter.com/julianwachholz/status/1011542175358873600
• Size: 18.6 KB
• Stars: 29
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
django-autocompletefilter

=========================

A django application that lets you use the built in autocomplete function of the

django admin to filter in admin list views by foreign key relations.

.. image:: https://pbs.twimg.com/media/DgmzYLbW4AA9oL3.jpg:large

Usage

-----

#. Install the package, for example from PyPi::

    pip install django-autocompletefilter

#. Add ``autocompletefilter`` to your ``INSTALLED_APPS`` setting.

#. Create and register a model admin for the model you want to filter by.

   Ensure it has ``search_fields`` specified for autocomplete to work.

#. In your second model admin, use the ``AutocompleteFilterMixin`` on your class and

   add the desired foreign key attribute to filter by to the ``list_filter``

   items by using the AutocompleteListFilter class::

    from autocompletefilter.admin import AutocompleteFilterMixin

    from autocompletefilter.filters import AutocompleteListFilter

    class FooAdmin(AutocompleteFilterMixin, admin.ModelAdmin):

        list_filter = (

            ('bar', AutocompleteListFilter),

        )

Status of this project

----------------------

This project is currently using a rather hacky way to implement this.

Caution is advised when using it.

Using multiple autocomplete filters on the same page does work.

Currently only tested on Python 3.6

Contributing

------------

All suggestions are welcome. Especially about ways to make this cleaner.

Common issues

-------------

- **Reverse for '__autocomplete' not found.**

  You must register a model admin with ``search_fields`` for the model you want to look up.

- **The results could not be loaded.**

  You likely forgot to specify ``search_fields`` on your model admin for the model you want to look up.