Skip to main content

Django ↔ Pydantic-AI ↔ AG-UI integration: async view, tool registry, audit logger.

Project description

django-ag-ui

CI PyPI Python versions Django versions Docs Coverage Ruff License

Wire a Pydantic-AI agent into any Django project and speak the AG-UI protocol to a browser — a streaming agent endpoint, a typed tool registry, and the plumbing in between. No admin specifics; that lives in the downstream django-admin-agent, and the browser half is @artooi/ag-ui-web-component.

  • Async AG-UI endpointDjangoAGUIView wraps Pydantic-AI's AGUIAdapter and returns a StreamingHttpResponse of AG-UI events (SSE). Conversation state rides in each request, so there's no cross-request session store and multi-worker deployments are safe by default.
  • Typed tool registry — register plain callables with @tool; JSON Schema is derived from their signatures. destructive= / category= / confirm= / summary= metadata surface as x-destructive / x-category / x-confirm / x-summary extensions for client-side gating.
  • Configurable agentAgentConfig + the DJANGO_AG_UI settings cover the model, MODEL_SETTINGS, RETRIES, external TOOLSETS / CAPABILITIES, an explicit API_KEY / PROVIDER credential path, and an AGENT_FACTORY escape hatch for full control of construction.
  • Authentication hooksrequire_authenticated=True fails closed (401) for anonymous requests, and a get_user(request) hook establishes the user tools, the drf-mcp bridge, and conversation ownership act as.
  • Skills — a SkillRegistry / SkillSpec catalog of pre-defined prompts served at <prefix>skills/ via get_urls(view, skills=...), surfaced by the web component as chips and a /-command palette.
  • Tool metadata catalog — a read-only ToolsView served at <prefix>tools/ via get_urls(view, tools=registry), giving the web component (data-tools-url) friendly card labels for server-side tools whose schema never reaches the browser.
  • Audit boundary — an AuditLogger Protocol (Null / Logging shipped, pluggable by dotted path) records every server-side tool call.
  • Opt-in conversation persistence — a ConversationStore Protocol with a no-op default, a session-backed store, and an abstract model-backed base.
  • Reach external tools — compose any Pydantic-AI toolset, including an in-process drf-mcp bridge (the [drf-mcp] extra) so the agent can query DRF-exposed data.
  • 100% test coverage, type-checked, Python 3.10–3.14, Django 4.2–6.0.

📖 Full documentation: https://artui.github.io/django-ag-ui/

pip install "django-ag-ui[anthropic]"   # or [openai], or [google]
# or, with uv:
uv add "django-ag-ui[anthropic]"

The core dep is pydantic-ai-slim[ag-ui], which ships no model-provider library — pick one via a provider extra (anthropic / openai / google).

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


Quick start

Register a read-only tool, mount the endpoint, and point a browser AG-UI client at it.

# tools.py
from django_ag_ui import ToolRegistry, tool

registry = ToolRegistry()


@tool(registry)
def count_active_users() -> int:
    """How many users are currently active."""
    from django.contrib.auth import get_user_model

    return get_user_model().objects.filter(is_active=True).count()
# urls.py
from django.urls import path  # noqa: F401

from django_ag_ui import DjangoAGUIView, get_urls

from .tools import registry

urlpatterns = [
    *get_urls(DjangoAGUIView(registry), prefix="agent/"),
]
# settings.py
DJANGO_AG_UI = {
    "MODEL": "anthropic:claude-sonnet-4.6",   # any Pydantic-AI model string
    # "API_KEY": os.environ["ANTHROPIC_API_KEY"],  # else inferred from env
    # "MODEL_SETTINGS": {"temperature": 0.2},
    # "AUDIT_LOGGER": "django_ag_ui.LoggingAuditLogger",
    # "CONVERSATION_STORE": "django_ag_ui.DjangoSessionConversationStore",
}

POSTing an AG-UI RunAgentInput to /agent/ now streams the agent's run. Frontend-declared tools in the request are merged into the agent's catalog automatically; server-side tools run in-process. See the docs for the full settings reference, the persistence stores, and the drf-mcp bridge.

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_ag_ui-0.6.0.tar.gz (216.2 kB view details)

Uploaded Source

Built Distribution

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

django_ag_ui-0.6.0-py3-none-any.whl (60.9 kB view details)

Uploaded Python 3

File details

Details for the file django_ag_ui-0.6.0.tar.gz.

File metadata

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

File hashes

Hashes for django_ag_ui-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ccedf41408ba937a6f224cd99e92ff99d37a839e6c86e6aabe2a574de4c4dd8e
MD5 849fd58e90138d0335f71a34ffabbd73
BLAKE2b-256 f5c41425807b1f9b3d0f090bc83bd11abd14391aca7636a883bebc5bb62c8fdb

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_ag_ui-0.6.0.tar.gz:

Publisher: release.yml on Artui/django-ag-ui

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_ag_ui-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: django_ag_ui-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 60.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for django_ag_ui-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40c985d8c172b69e627a8364c253f9e1af4035f8db4ca42aee0243dcb013621c
MD5 f5c84d36230ab80773c7842af1135834
BLAKE2b-256 77d8a373c6742ee95c11e97e8e72342dbef7fe98a9ac15300a6e8290d6a59914

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_ag_ui-0.6.0-py3-none-any.whl:

Publisher: release.yml on Artui/django-ag-ui

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