django-listview-search-admin-autocomplete 0.3.0__tar.gz

django_listview_search_admin_autocomplete-0.3.0/.gitignore

@@ -0,0 +1,59 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+*.egg-info/
+*.egg
+sdist/
+
+# Virtual environments
+venv/
+ENV/
+.env
+.venv/
+
+# Distribution / packaging (uv)
+.uv/
+
+# IDE
+.idea/
+*.iml
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+coverage.xml
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+example/db.sqlite3
+
+# OS
+.DS_Store
+Thumbs.db
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/

django_listview_search_admin_autocomplete-0.3.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: django-listview-search-admin-autocomplete
+Version: 0.3.0
+Summary: Django admin autocomplete with related field support
+Project-URL: Homepage, https://github.com/linevich/django-search-admin-autocomplete
+Project-URL: Repository, https://github.com/linevich/django-search-admin-autocomplete
+Project-URL: Documentation, https://github.com/linevich/django-search-admin-autocomplete#readme
+Project-URL: Issues, https://github.com/linevich/django-search-admin-autocomplete/issues
+Project-URL: Changelog, https://github.com/linevich/django-search-admin-autocomplete/releases
+Author-email: linevich <mail@linevich.net>
+Maintainer-email: Your Name <your@email.com>
+License-Expression: MIT
+Keywords: admin,autocomplete,django,search
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.8
+Requires-Dist: django>=3.2
+Description-Content-Type: text/x-rst
+
+Django-search-admin-autocomplete
+================================
+
+.. image:: https://raw.githubusercontent.com/linevych/django-search-admin-autocomplete/master/doc/demo.gif
+
+**This is a fork of** `django-search-admin-autocomplete <https://github.com/linevich/django-search-admin-autocomplete>`_ **(archived).** The original package is no longer maintained. This fork adds new features, modern Django support, and bug fixes.
+
+Simple Django app that adds autocomplete search to the admin panel changelist view.
+
+What's New
+----------
+
+- **Related field search**: Search across ForeignKey relations (e.g., ``client__name``, ``category__title``)
+- **Django 4+ / 5+ support**: Fixed deprecated ``url()`` imports
+- **Modern build system**: ``pyproject.toml`` with hatchling (no more ``setup.py``)
+- **Python 3.8–3.13** support
+- **Comprehensive test suite** (18 tests)
+
+Requirements
+============
+
+- Python: 3.8+
+- Django: 3.2+
+
+Installation
+============
+
+.. code-block:: bash
+
+    pip install django-listview-search-admin-autocomplete
+
+.. code-block:: python
+
+    INSTALLED_APPS = [
+        ...
+        'search_admin_autocomplete',
+        ...
+    ]
+
+Usage
+=====
+
+Basic usage with direct fields:
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        search_fields = ['name', 'description']
+
+    admin.site.register(MyModel, MyModelAdmin)
+
+Related Field Support
+=====================
+
+Search across ForeignKey and related model fields using Django's ``__`` lookup syntax:
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class OrderAdmin(SearchAutoCompleteAdmin):
+        search_fields = [
+            'order_number',
+            'client__name',        # ForeignKey → Client.name
+            'client__email',       # ForeignKey → Client.email
+            'category__title',     # ForeignKey → Category.title
+        ]
+
+    admin.site.register(Order, OrderAdmin)
+
+The autocomplete will search and display values from both the model and its related models.
+
+Configuration Options
+=====================
+
+.. code-block:: python
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        search_fields = ['name', 'client__name']
+        search_prefix = '__icontains'  # Search operator (default: '__contains')
+        max_results = 20               # Max autocomplete results (default: 10)
+
+Customization
+=============
+
+If you have a custom ``change_list.html``:
+
+**admin.py**
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        change_list_template = 'admin/custom-list.html'
+        search_fields = ['name', 'client__title']
+
+    admin.site.register(MyModel, MyModelAdmin)
+
+**admin/custom-list.html**
+
+.. code-block:: html
+
+    {% extends 'search_admin_autocomplete/change_list.html' %}
+
+    {% block object-tools %}
+    Your custom html...
+    {{ block.super }}
+    {% endblock %}
+
+Running Tests
+=============
+
+.. code-block:: bash
+
+    cd example
+    python manage.py test search_admin_autocomplete
+
+Changelog
+=========
+
+0.3.0 (2026)
+------------
+- **Forked** from archived ``django-search-admin-autocomplete``
+- Added support for related field lookups (e.g., ``client__name``)
+- Updated for Django 4+ and 5+ compatibility
+- Modernized package configuration with ``pyproject.toml``
+- Added comprehensive test suite (18 tests)
+
+0.2.1 and earlier
+-----------------
+- Original release by linevich (see `upstream repo <https://github.com/linevich/django-search-admin-autocomplete>`_)

django_listview_search_admin_autocomplete-0.3.0/README.rst

@@ -0,0 +1,134 @@
+Django-search-admin-autocomplete
+================================
+
+.. image:: https://raw.githubusercontent.com/linevych/django-search-admin-autocomplete/master/doc/demo.gif
+
+**This is a fork of** `django-search-admin-autocomplete <https://github.com/linevich/django-search-admin-autocomplete>`_ **(archived).** The original package is no longer maintained. This fork adds new features, modern Django support, and bug fixes.
+
+Simple Django app that adds autocomplete search to the admin panel changelist view.
+
+What's New
+----------
+
+- **Related field search**: Search across ForeignKey relations (e.g., ``client__name``, ``category__title``)
+- **Django 4+ / 5+ support**: Fixed deprecated ``url()`` imports
+- **Modern build system**: ``pyproject.toml`` with hatchling (no more ``setup.py``)
+- **Python 3.8–3.13** support
+- **Comprehensive test suite** (18 tests)
+
+Requirements
+============
+
+- Python: 3.8+
+- Django: 3.2+
+
+Installation
+============
+
+.. code-block:: bash
+
+    pip install django-listview-search-admin-autocomplete
+
+.. code-block:: python
+
+    INSTALLED_APPS = [
+        ...
+        'search_admin_autocomplete',
+        ...
+    ]
+
+Usage
+=====
+
+Basic usage with direct fields:
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        search_fields = ['name', 'description']
+
+    admin.site.register(MyModel, MyModelAdmin)
+
+Related Field Support
+=====================
+
+Search across ForeignKey and related model fields using Django's ``__`` lookup syntax:
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class OrderAdmin(SearchAutoCompleteAdmin):
+        search_fields = [
+            'order_number',
+            'client__name',        # ForeignKey → Client.name
+            'client__email',       # ForeignKey → Client.email
+            'category__title',     # ForeignKey → Category.title
+        ]
+
+    admin.site.register(Order, OrderAdmin)
+
+The autocomplete will search and display values from both the model and its related models.
+
+Configuration Options
+=====================
+
+.. code-block:: python
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        search_fields = ['name', 'client__name']
+        search_prefix = '__icontains'  # Search operator (default: '__contains')
+        max_results = 20               # Max autocomplete results (default: 10)
+
+Customization
+=============
+
+If you have a custom ``change_list.html``:
+
+**admin.py**
+
+.. code-block:: python
+
+    from search_admin_autocomplete.admin import SearchAutoCompleteAdmin
+
+    class MyModelAdmin(SearchAutoCompleteAdmin):
+        change_list_template = 'admin/custom-list.html'
+        search_fields = ['name', 'client__title']
+
+    admin.site.register(MyModel, MyModelAdmin)
+
+**admin/custom-list.html**
+
+.. code-block:: html
+
+    {% extends 'search_admin_autocomplete/change_list.html' %}
+
+    {% block object-tools %}
+    Your custom html...
+    {{ block.super }}
+    {% endblock %}
+
+Running Tests
+=============
+
+.. code-block:: bash
+
+    cd example
+    python manage.py test search_admin_autocomplete
+
+Changelog
+=========
+
+0.3.0 (2026)
+------------
+- **Forked** from archived ``django-search-admin-autocomplete``
+- Added support for related field lookups (e.g., ``client__name``)
+- Updated for Django 4+ and 5+ compatibility
+- Modernized package configuration with ``pyproject.toml``
+- Added comprehensive test suite (18 tests)
+
+0.2.1 and earlier
+-----------------
+- Original release by linevich (see `upstream repo <https://github.com/linevich/django-search-admin-autocomplete>`_)

django_listview_search_admin_autocomplete-0.3.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "django-listview-search-admin-autocomplete"
+version = "0.3.0"
+description = "Django admin autocomplete with related field support"
+readme = "README.rst"
+license = "MIT"
+authors = [
+    { name = "linevich", email = "mail@linevich.net" },
+]
+maintainers = [
+    { name = "Your Name", email = "your@email.com" },
+]
+keywords = ["django", "admin", "autocomplete", "search"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "Django>=3.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/linevich/django-search-admin-autocomplete"
+Repository = "https://github.com/linevich/django-search-admin-autocomplete"
+Documentation = "https://github.com/linevich/django-search-admin-autocomplete#readme"
+Issues = "https://github.com/linevich/django-search-admin-autocomplete/issues"
+Changelog = "https://github.com/linevich/django-search-admin-autocomplete/releases"
+
+[tool.hatch.build.targets.wheel]
+packages = ["search_admin_autocomplete"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/search_admin_autocomplete",
+    "/README.rst",
+    "/LICENSE",
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "example.project.settings"
+pythonpath = ["."]
+testpaths = ["search_admin_autocomplete"]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+
+

django_listview_search_admin_autocomplete-0.3.0/search_admin_autocomplete/admin.py

@@ -0,0 +1,91 @@
+from functools import reduce
+from operator import or_
+from typing import List
+
+from django.contrib import admin
+from django.db.models import Q, Model
+from django.http import HttpRequest
+
+try:
+    from django.urls import reverse
+except ImportError:
+    from django.core.urlresolvers import reverse  # type: ignore
+
+try:
+    from django.urls import re_path
+except ImportError:
+    from django.conf.urls import url as re_path  # type: ignore
+
+from django.http.response import HttpResponse, JsonResponse, HttpResponseBadRequest
+from django.urls.resolvers import URLPattern
+
+
+class SearchAutoCompleteAdmin(admin.ModelAdmin):
+    """
+    Basic admin class that allows to enable search autocomplete for certain model.
+
+    Usage:
+
+    .. code-block:: python
+
+        class MyModelAdmin(SearchAutoCompleteAdmin)
+            search_fields = ['search_field', ]
+
+        admin.site.register(MyModel, MyModelAdmin)
+    """
+    change_list_template = 'search_admin_autocomplete/change_list.html'
+    search_fields = []  # type: List[str]
+    search_prefix = '__contains'
+    max_results = 10
+
+    def get_urls(self) -> List[URLPattern]:
+        urls = super(SearchAutoCompleteAdmin, self).get_urls()
+        api_urls = [re_path(r'^search/(?P<search_term>\w{0,50})$', self.search_api)]
+        return api_urls + urls
+
+    def search_api(self, request: HttpRequest, search_term: str) -> HttpResponse:
+        """
+        API view that perform search by search term for current model.
+        """
+        if len(self.search_fields) == 0:
+            return HttpResponseBadRequest(reason='Mo search_fields defined in {}'.format(self.__class__.__name__))
+
+        query = [Q(**{'{}{}'.format(field, self.search_prefix): search_term}) for field in self.search_fields]
+        # https://github.com/python/mypy/issues/4150
+        query = reduce(or_, query)  # type: ignore
+        return JsonResponse(data=[{'keyword': self.get_instance_name(item), 'url': self.get_instance_url(item)}
+                                  for item in self.model.objects.filter(query)[0:self.max_results]], safe=False)
+
+    def _get_field_value(self, instance, field_name):
+        """Resolve field value supporting related field lookups like 'client__name'."""
+        parts = field_name.split('__')
+        obj = instance
+        for part in parts:
+            obj = getattr(obj, part, None)
+            if obj is None:
+                return None
+        return obj
+
+    def get_instance_name(self, instance: Model) -> str:
+        """
+        Format instance name based on value of search fields.
+        """
+        values = []
+
+        for field in self.search_fields:
+            value = self._get_field_value(instance, field)
+            if not value:
+                continue
+            values.append(str(value))
+
+        if not values:
+            return ""
+
+        return ", ".join(values)
+
+    def get_instance_url(self, instance: Model) -> str:
+        """
+        Returns url admin change view for model instance.
+        """
+        url_name = "admin:{}_{}_change".format(self.model._meta.app_label, str(self.model.__name__).lower())
+        return reverse(url_name, args=(instance.pk,))

django_listview_search_admin_autocomplete-0.3.0/search_admin_autocomplete/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class SearchAdminAutocompleteConfig(AppConfig):
+    name = 'search_admin_autocomplete'

django_listview_search_admin_autocomplete-0.3.0/search_admin_autocomplete/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.