Skip to main content

An always-present chat-agent sidebar in the Django admin, powered by django-ag-ui.

Project description

django-admin-agent

CI PyPI Python versions Django versions Docs Coverage Ruff License

An always-present chat-agent sidebar embedded in the Django admin. The agent reads your data through typed, server-side tools and drives the admin UI — filling forms, applying filters, navigating between pages — with visible animations and a confirmation modal on anything destructive.

It builds on django-ag-ui (the Django ↔ Pydantic-AIAG-UI bridge) and ships the @artooi/ag-ui-web-component <ag-ui-chat> element vendored as a static bundle — there's no separate npm install. Works with the vanilla Django admin and with Django Unfold.

  • Server-side admin tools — a default registry of read-only shell.* (query / count / fetch instances) and introspect.* (model schema, admin registration) tools, derived from your installed models. Every call is typed and audited through django-ag-ui's AuditLogger.
  • Frontend tool handlersnav.* and DOM-driving tools (fill a field, click, apply a changelist filter) execute in the browser against the live admin page, with animations so the user sees what the agent is doing.
  • Destructive-action gating — tools flagged x-destructive in their JSON Schema are intercepted by a confirmation modal before they run.
  • Drop-in sidebar — a {% django_admin_agent_sidebar %} template tag (no admin-site swap) or a SidebarAdminSite for those who prefer to subclass.
  • Themeable, with skills — configure the theme (light / dark / auto / code), density, placement, text animation, and tool-call display mode from DJANGO_ADMIN_AGENT, and surface a catalog of one-click skills as composer chips and a /-command palette. Built on django-ag-ui>=0.10,<0.12 and the matching @artooi/ag-ui-web-component.
  • Voice & model thoughts — set DJANGO_AG_UI["TRANSCRIPTION_BACKEND"] to add a 🎤 mic to the composer (server-side transcription), and a reasoning model's streamed chain-of-thought renders in a collapsible "thoughts" region. Both ride on the re-vendored web component; voice is off until a backend is configured.
  • Unfold-aware — a runtime JS shim adapts the sidebar to Unfold's chrome; any Python Unfold introspection is lazy and guarded, so Unfold stays optional.
  • 100% test coverage, type-checked, Python 3.10–3.14, Django 4.2–6.0.

📖 Full documentation: https://artui.github.io/django-admin-agent/

pip install django-admin-agent
# expose the admin tools as an HTTP MCP server too:
pip install "django-admin-agent[mcp]"

ASGI required. The agent endpoint streams Server-Sent Events, which the sync WSGI worker can't serve — deploy the admin under Daphne / Uvicorn.


Quick start

# settings.py
INSTALLED_APPS = [
    # ...
    "django.contrib.admin",
    "django_admin_agent",
]
# urls.py
from django.contrib import admin
from django.urls import path

from django_admin_agent import get_urls

urlpatterns = [
    path("admin/", admin.site.urls),
    # Mounts the agent endpoint over the default shell.* + introspect.* registry.
    *get_urls(model="anthropic:claude-sonnet-4.6"),
]
{# templates/admin/base_site.html — override so it wins over the admin app's copy #}
{% extends "admin/base.html" %}
{% load django_admin_agent %}

{% block branding %}
  <h1 id="site-name"><a href="{% url 'admin:index' %}">My admin</a></h1>
  {% django_admin_agent_sidebar %}
{% endblock %}

That's the whole wiring: the template tag computes its own context (endpoint URL, title, auto-confirm flag, bootstrap module, route map), so the admin site doesn't need swapping. Serve it over ASGI:

uvicorn myproject.asgi:application

The model can be set per-mount (get_urls(model=...)) or globally via DJANGO_AG_UI["MODEL"]. See the docs for the full tool surface, configuration reference, the SidebarAdminSite path, Unfold support, and the [mcp] server.

License

MIT — see LICENSE.

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_admin_agent-0.10.1.tar.gz (252.4 kB view details)

Uploaded Source

Built Distribution

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

django_admin_agent-0.10.1-py3-none-any.whl (130.9 kB view details)

Uploaded Python 3

File details

Details for the file django_admin_agent-0.10.1.tar.gz.

File metadata

  • Download URL: django_admin_agent-0.10.1.tar.gz
  • Upload date:
  • Size: 252.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for django_admin_agent-0.10.1.tar.gz
Algorithm Hash digest
SHA256 7e1c10504fd44e981abe6b0a78a2b3be1e342e7d506d7478de869afc15fb6445
MD5 e9f48624c481b7284d451be425b07e49
BLAKE2b-256 5a347d3a539e952536590139a5a5f456d66e993d1bdd8384382a6700ceda911e

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_admin_agent-0.10.1.tar.gz:

Publisher: release.yml on Artui/django-admin-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_admin_agent-0.10.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_admin_agent-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46b15bb508680e5e883c97bf9fa6ddfbe5aff1a1c8f87eb061a74b9ba340dc36
MD5 22e297b3d8c3296472d86fa21eb9894b
BLAKE2b-256 7300f46d36e8daf7f4be0a86aec9323879e8ff9e55f5178d219dc275d6f59efb

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_admin_agent-0.10.1-py3-none-any.whl:

Publisher: release.yml on Artui/django-admin-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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