PyPI - agent-framework-devui - Versions diffs - 0.0.1a0__py3-none-any.whl → 1.0.0b251001__py3-none-any.whl - Mend

agent-framework-devui 0.0.1a0py3-none-any.whl → 1.0.0b251001py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of agent-framework-devui might be problematic. Click here for more details.

Files changed (24) hide show

agent_framework_devui/__init__.py +151 -0
agent_framework_devui/_cli.py +143 -0
agent_framework_devui/_discovery.py +724 -0
agent_framework_devui/_executor.py +770 -0
agent_framework_devui/_mapper.py +582 -0
agent_framework_devui/_server.py +530 -0
agent_framework_devui/_session.py +191 -0
agent_framework_devui/_tracing.py +168 -0
agent_framework_devui/models/__init__.py +72 -0
agent_framework_devui/models/_discovery_models.py +51 -0
agent_framework_devui/models/_openai_custom.py +209 -0
agent_framework_devui/ui/assets/index-D1AmQWga.css +1 -0
agent_framework_devui/ui/assets/index-DPEaaIdK.js +435 -0
agent_framework_devui/ui/index.html +14 -0
agent_framework_devui/ui/vite.svg +1 -0
agent_framework_devui-1.0.0b251001.dist-info/METADATA +172 -0
agent_framework_devui-1.0.0b251001.dist-info/RECORD +20 -0
{agent_framework_devui-0.0.1a0.dist-info → agent_framework_devui-1.0.0b251001.dist-info}/WHEEL +1 -2
agent_framework_devui-1.0.0b251001.dist-info/entry_points.txt +3 -0
agent_framework_devui-1.0.0b251001.dist-info/licenses/LICENSE +21 -0
agent_framework_devui-0.0.1a0.dist-info/METADATA +0 -18
agent_framework_devui-0.0.1a0.dist-info/RECORD +0 -5
agent_framework_devui-0.0.1a0.dist-info/licenses/LICENSE +0 -9
agent_framework_devui-0.0.1a0.dist-info/top_level.txt +0 -1

agent_framework_devui/ui/index.html ADDED Viewed

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Agent Framework Dev UI</title>
+    <script type="module" crossorigin src="/assets/index-DPEaaIdK.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-D1AmQWga.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

agent_framework_devui/ui/vite.svg ADDED Viewed

@@ -0,0 +1 @@

+ <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

agent_framework_devui-1.0.0b251001.dist-info/METADATA ADDED Viewed

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: agent-framework-devui
+Version: 1.0.0b251001
+Summary: Debug UI for Microsoft Agent Framework with OpenAI-compatible API server.
+Author-email: Microsoft <af-support@microsoft.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: agent-framework-core
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pytest>=7.0.0 ; extra == "all"
+Requires-Dist: watchdog>=3.0.0 ; extra == "all"
+Requires-Dist: pytest>=7.0.0 ; extra == "dev"
+Requires-Dist: watchdog>=3.0.0 ; extra == "dev"
+Project-URL: homepage, https://aka.ms/agent-framework
+Project-URL: issues, https://github.com/microsoft/agent-framework/issues
+Project-URL: release_notes, https://github.com/microsoft/agent-framework/releases?q=tag%3Apython-1&expanded=true
+Project-URL: source, https://github.com/microsoft/agent-framework/tree/main/python
+Provides-Extra: all
+Provides-Extra: dev
+# DevUI - A Sample App for Running Agents and Workflows
+A lightweight, standalone sample app interface for running entities (agents/workflows) in the Microsoft Agent Framework supporting **directory-based discovery**, **in-memory entity registration**, and **sample entity gallery**.
+> [!IMPORTANT]
+> DevUI is a **sample app** to help you get started with the Agent Framework. It is **not** intended for production use. For production, or for features beyond what is provided in this sample app, it is recommended that you build your own custom interface and API server using the Agent Framework SDK.
+![DevUI Screenshot](./docs/devuiscreen.png)
+## Quick Start
+```bash
+# Install
+pip install agent-framework-devui
+```
+You can also launch it programmatically
+```python
+from agent_framework import ChatAgent
+from agent_framework.openai import OpenAIChatClient
+from agent_framework.devui import serve
+def get_weather(location: str) -> str:
+    """Get weather for a location."""
+    return f"Weather in {location}: 72°F and sunny"
+# Create your agent
+agent = ChatAgent(
+    name="WeatherAgent",
+    chat_client=OpenAIChatClient(),
+    tools=[get_weather]
+)
+# Launch debug UI - that's it!
+serve(entities=[agent], auto_open=True)
+# → Opens browser to http://localhost:8080
+```
+In addition, if you have agents/workflows defined in a specific directory structure (see below), you can launch DevUI from the _cli_ to discover and run them.
+```bash
+# Launch web UI + API server
+devui ./agents --port 8080
+# → Web UI: http://localhost:8080
+# → API: http://localhost:8080/v1/*
+```
+When DevUI starts with no discovered entities, it displays a **sample entity gallery** with curated examples from the Agent Framework repository to help you get started quickly.
+## Directory Structure
+For your agents to be discovered by the DevUI, they must be organized in a directory structure like below. Each agent/workflow must have an `__init__.py` that exports the required variable (`agent` or `workflow`).
+**Note**: `.env` files are optional but will be automatically loaded if present in the agent/workflow directory or parent entities directory. Use them to store API keys, configuration variables, and other environment-specific settings.
+```
+agents/
+├── weather_agent/
+│   ├── __init__.py      # Must export: agent = ChatAgent(...)
+│   ├── agent.py
+│   └── .env             # Optional: API keys, config vars
+├── my_workflow/
+│   ├── __init__.py      # Must export: workflow = WorkflowBuilder()...
+│   ├── workflow.py
+│   └── .env             # Optional: environment variables
+└── .env                 # Optional: shared environment variables
+```
+## Viewing Telemetry (Otel Traces) in DevUI
+Agent Framework emits OpenTelemetry (Otel) traces for various operations. You can view these traces in DevUI by enabling tracing when starting the server.
+```bash
+devui ./agents --tracing framework
+```
+## OpenAI-Compatible API
+For convenience, you can interact with the agents/workflows using the standard OpenAI API format. Just specify the `entity_id` in the `extra_body` field. This can be an `agent_id` or `workflow_id`.
+```bash
+# Standard OpenAI format
+curl -X POST http://localhost:8080/v1/responses \
+  -H "Content-Type: application/json" \
+  -d @- << 'EOF'
+{
+  "model": "agent-framework",
+  "input": "Hello world",
+  "extra_body": {"entity_id": "weather_agent"}
+}
+```
+## CLI Options
+```bash
+devui [directory] [options]
+Options:
+  --port, -p      Port (default: 8080)
+  --host          Host (default: 127.0.0.1)
+  --headless      API only, no UI
+  --config        YAML config file
+  --tracing       none|framework|workflow|all
+  --reload        Enable auto-reload
+```
+## Key Endpoints
+- `GET /v1/entities` - List discovered agents/workflows
+- `GET /v1/entities/{entity_id}/info` - Get detailed entity information
+- `POST /v1/entities/add` - Add entity from URL (for gallery samples)
+- `DELETE /v1/entities/{entity_id}` - Remove remote entity
+- `POST /v1/responses` - Execute agent/workflow (streaming or sync)
+- `GET /health` - Health check
+- `POST /v1/threads` - Create thread for agent (optional)
+- `GET /v1/threads?agent_id={id}` - List threads for agent
+- `GET /v1/threads/{thread_id}` - Get thread info
+- `DELETE /v1/threads/{thread_id}` - Delete thread
+- `GET /v1/threads/{thread_id}/messages` - Get thread messages
+## Implementation
+- **Discovery**: `agent_framework_devui/_discovery.py`
+- **Execution**: `agent_framework_devui/_executor.py`
+- **Message Mapping**: `agent_framework_devui/_mapper.py`
+- **Session Management**: `agent_framework_devui/_session.py`
+- **API Server**: `agent_framework_devui/_server.py`
+- **CLI**: `agent_framework_devui/_cli.py`
+## Examples
+See `samples/` for working agent and workflow implementations.
+## License
+MIT

agent_framework_devui-1.0.0b251001.dist-info/RECORD ADDED Viewed

@@ -0,0 +1,20 @@
+agent_framework_devui/__init__.py,sha256=Hk2ddFHRvxe6Ytz59g2dKCs-wreG7pi7DuMgbUIeqiY,5079
+agent_framework_devui/_cli.py,sha256=UnQ6xRfDnaZcDnlI2GCiFKjoZ1mkOqpPctEaZ9Zyhxc,4604
+agent_framework_devui/_discovery.py,sha256=5cuevVnQ3bN1JEVF-uJ0My0Poid1uLaLMfjq3DafJuo,27462
+agent_framework_devui/_executor.py,sha256=JCQw2YYAuALKxupCWAuIzDJXYHv7Tv82EbBw_IHN_ps,31995
+agent_framework_devui/_mapper.py,sha256=Y99AofK_grj_VOqxGqfmUZQ8iwRKwOcAMO9TYgfhnNw,24558
+agent_framework_devui/_server.py,sha256=0jZ8N2mNfU0dLOWeriF3LknmsPbeWW0xzS4SgBgN-tM,24506
+agent_framework_devui/_session.py,sha256=FIxfdKc7Z8Q13GpYTImEzpyZwVIcx6PC8cUSKDBBumo,6027
+agent_framework_devui/_tracing.py,sha256=ZoYKYomFB0VjiEBFgPsSu2ocpnPushWczKl5QndSUjQ,6152
+agent_framework_devui/models/__init__.py,sha256=hP1oLW7XdoKo-8W7RnJgeK74x0LcdU4CTEADf5a96kU,2026
+agent_framework_devui/models/_discovery_models.py,sha256=JUK5w5F_Wa58UADJzRWYn_jiv6hRRGEnh69pJT1TQ5Y,1428
+agent_framework_devui/models/_openai_custom.py,sha256=CvnJlkRpDnPhI-KVJJiYi1ZKOlCQlLHldiJpb2WzJ2E,6352
+agent_framework_devui/ui/index.html,sha256=BUII9nBcNAlWpH3u3kc7TrWQevt1I6WL7_YscjlDFXQ,469
+agent_framework_devui/ui/vite.svg,sha256=SnSK_UQ5GLsWWRyDTEAdrjPoeGGrXbrQgRw6O0qSFPs,1497
+agent_framework_devui/ui/assets/index-D1AmQWga.css,sha256=t90ENwgHXtVHlGhcczmh2_CFg4XlOKMXFAjGKkaLzak,86064
+agent_framework_devui/ui/assets/index-DPEaaIdK.js,sha256=N-7rwEhaoabYRB80sTVH2Mtvx3k6uU4bn5DLkppnjsg,663901
+agent_framework_devui-1.0.0b251001.dist-info/entry_points.txt,sha256=H6Vq4nNyU8GryiFv215LfIF9pjVnow9Ono-pJzZ6zsI,52
+agent_framework_devui-1.0.0b251001.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+agent_framework_devui-1.0.0b251001.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+agent_framework_devui-1.0.0b251001.dist-info/METADATA,sha256=Qzudyg-VsFYYMG4wkpZQ7Js78pO2u-MEfqKEIPUExvM,6248
+agent_framework_devui-1.0.0b251001.dist-info/RECORD,,

{agent_framework_devui-0.0.1a0.dist-info → agent_framework_devui-1.0.0b251001.dist-info}/WHEEL RENAMED Viewed

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

agent_framework_devui-1.0.0b251001.dist-info/entry_points.txt ADDED Viewed

@@ -0,0 +1,3 @@
+[console_scripts]
+devui=agent_framework_devui:main

agent_framework_devui-1.0.0b251001.dist-info/licenses/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+    MIT License
+    Copyright (c) Microsoft Corporation.
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

agent_framework_devui-0.0.1a0.dist-info/METADATA DELETED Viewed

@@ -1,18 +0,0 @@
-Metadata-Version: 2.4
-Name: agent-framework-devui
-Version: 0.0.1a0
-Summary: Agent Framework Dev UI
-Author-email: Agent Framework Devs <ekzhu@microsoft.com>
-License-Expression: MIT
-Project-URL: Homepage, https://pypi.org/project/agent-framework-devui/
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-# agent-framework-devui
-Agent Framework Dev UI

agent_framework_devui-0.0.1a0.dist-info/RECORD DELETED Viewed

@@ -1,5 +0,0 @@
-agent_framework_devui-0.0.1a0.dist-info/licenses/LICENSE,sha256=tXr82ogDNlpu98cOzhowZAz--s3FEcNSFElKbM8YESE,1077
-agent_framework_devui-0.0.1a0.dist-info/METADATA,sha256=oxPBsAr_JVTobnKCSt4LxYcw4c-eLa-nIZIoebTKBBc,558
-agent_framework_devui-0.0.1a0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-agent_framework_devui-0.0.1a0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-agent_framework_devui-0.0.1a0.dist-info/RECORD,,

agent_framework_devui-0.0.1a0.dist-info/licenses/LICENSE DELETED Viewed

@@ -1,9 +0,0 @@
-MIT License
-Copyright (c) 2025 Agent Framework Devs
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

agent_framework_devui-0.0.1a0.dist-info/top_level.txt DELETED Viewed

	@@ -1 +0,0 @@
1	-

agent-framework-devui 0.0.1a0__py3-none-any.whl → 1.0.0b251001__py3-none-any.whl

Potentially problematic release.

agent-framework-devui 0.0.1a0py3-none-any.whl → 1.0.0b251001py3-none-any.whl