Skip to main content

Global search for Django Admin, search across all registered models with permissions and search_fields support

Project description

Django Global Search

PyPI Download Test codecov PyPI Python Versions Supported Django versions

A global search extension for Django Admin that allows searching across multiple models from a single page. Search through all registered models with permission handling and respect for existing search_fields configurations.

Documentation can be found at https://django-global-search.readthedocs.io/

Installation

Install using pip:

pip install django-global-search

Or using uv:

uv add django-global-search

Usage

Setup

# settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django_global_search',  # Add after admin
    # ... other apps
]

Adding a Navigation Button (Optional)

{% extends "admin/base_site.html" %}

{% block userlinks %}
    {{ block.super }}
    {% include 'global_search/button.html' %}
{% endblock %}

This adds a convenient "Global Search" button in the admin header.

Advanced Setup

If you're using a custom admin site class, you can explicitly inherit from the mixin:

# admin.py
from django.contrib.admin import AdminSite
from django_global_search.admin import GlobalSearchAdminSiteMixin

class MyAdminSite(GlobalSearchAdminSiteMixin, AdminSite):
    site_header = "My Custom Admin"

# Replace the default admin site
admin_site = MyAdminSite(name='myadmin')

Screenshots

Global Search Interface

Global Search Interface

Search across all models with permission-based filtering and model selection

Search Results

Search Results

Results grouped by app and model with direct links to detail and changelist views

Requirements

  • Python 3.9+
  • Django 4.2+

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_global_search-0.1.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_global_search-0.1.2-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file django_global_search-0.1.2.tar.gz.

File metadata

  • Download URL: django_global_search-0.1.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_global_search-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4921eadb1cff31410ee7a9c39fa87c35d66b28b838c79b54f13306d747401de5
MD5 67dbf1480ed0d521341edd7c4040bc4f
BLAKE2b-256 205b02de0a3ac67c1553502b762047e5925a98e1f1798436d6bbc8450eefcd61

See more details on using hashes here.

File details

Details for the file django_global_search-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_global_search-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e9f5ad64fe21ee97d5c350faf3dc3d54ad6d57c41873fd1055d258bc4221a2b8
MD5 29cbe4325ff189fdde72b8febcabfc30
BLAKE2b-256 c541c543c9376cb743e0c3bcc29338bbd664bb6bc983ae6ee0446f6af7f6cd60

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page