Skip to content

Installation

Requirements

Supported Python version

PyPI Python Versions

Supported Django version

Supported Django versions

uv is a fast Python package installer:

uv add django-global-search

Install with pip

pip install django-global-search

Install from Source

For development or testing the latest changes:

# Clone the repository
git clone https://github.com/youngkwang-yang/django-global-search.git
cd django-global-search

# Install in development mode
uv pip install -e .

Add to Django Project

Add django_global_search to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    'django_global_search',  # Add after django.contrib.admin

    # ... your other apps
]

Installation Order

Place django_global_search after django.contrib.admin to ensure proper integration.

Verify Installation

Run the development server and navigate to /admin/global-search/:

python manage.py runserver

You should see the global search interface in your Django admin.

Next Steps