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

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.0.6.tar.gz (2.3 MB 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.0.6-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for django_global_search-0.0.6.tar.gz
Algorithm Hash digest
SHA256 bbc92eebe4e40d1587bf79ee0fc8972a07fc27d38c60278ac64608918369aece
MD5 a81c9a6d497f354e0503855496149898
BLAKE2b-256 1a0ec57078f0693c9149343b65e32a23b9ed226eafcc25837356817e3d9bd589

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_global_search-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3f707eb9c4c26457ac30077d6341c1d24413229108b9b22af480c940adb2eba2
MD5 4bf730f0dc493c1ba96b9d0a1106befd
BLAKE2b-256 2fb8712fa41b8c0b95b8836181264c4224c70e07a94b4b6c082fa3b50ffa2d59

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