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.1.tar.gz (15.3 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.1-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for django_global_search-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c1bc0d10591d7297016a13791db013414cf1e6dde103d90fc99dad3edb2ba3b0
MD5 c0bbfe5652a2d0c69ebc522fbc00264b
BLAKE2b-256 30e52572560c9b4df050062d050ef55d9fd67af64ce954f7fd81ad90a4c01e30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_global_search-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b05a217395ee61524ca5f4c7cce24faaafbe4996ad6f36b45c74da6007b7d06a
MD5 7c7b32b2efe402248a86f8c72f175014
BLAKE2b-256 3d08caa227c9dc023c249f4e8ddf393521faa7870163c710e2dbb036fdd8f35e

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