agent-framework-devui 1.0.0b251001__py3-none-any.whl → 1.0.0b251016__py3-none-any.whl

agent_framework_devui-1.0.0b251001.dist-info/METADATA

@@ -1,172 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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,,