From ac018f700bc8bd1d6d44f1ad795ef17276b560c9 Mon Sep 17 00:00:00 2001 From: Evan Mattson <35585003+moonbox3@users.noreply.github.com> Date: Thu, 6 Nov 2025 11:31:24 +0900 Subject: [PATCH] Python: Fix ag-ui examples packaging for PyPI publish (#1953) * Fix ag-ui examples packaging for PyPI publish * Fix markdown links --- python/packages/ag-ui/README.md | 4 ++-- .../.env.example | 0 .../.vscode/settings.json | 0 .../{examples => agent_framework_ag_ui_examples}/README.md | 0 .../{examples => agent_framework_ag_ui_examples}/__init__.py | 0 .../{examples => agent_framework_ag_ui_examples}/__main__.py | 0 .../agents/__init__.py | 0 .../agents/document_writer_agent.py | 0 .../agents/human_in_the_loop_agent.py | 0 .../agents/recipe_agent.py | 0 .../agents/research_assistant_agent.py | 0 .../agents/simple_agent.py | 0 .../agents/task_planner_agent.py | 0 .../agents/task_steps_agent.py | 0 .../agents/ui_generator_agent.py | 0 .../agents/weather_agent.py | 0 .../server/__init__.py | 0 .../server/api/__init__.py | 0 .../server/api/backend_tool_rendering.py | 0 .../server/main.py | 0 python/packages/ag-ui/getting_started/README.md | 2 +- python/packages/ag-ui/pyproject.toml | 5 ++--- python/uv.lock | 2 +- 23 files changed, 6 insertions(+), 7 deletions(-) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/.env.example (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/.vscode/settings.json (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/README.md (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/__init__.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/__main__.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/__init__.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/document_writer_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/human_in_the_loop_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/recipe_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/research_assistant_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/simple_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/task_planner_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/task_steps_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/ui_generator_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/agents/weather_agent.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/server/__init__.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/server/api/__init__.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/server/api/backend_tool_rendering.py (100%) rename python/packages/ag-ui/{examples => agent_framework_ag_ui_examples}/server/main.py (100%) diff --git a/python/packages/ag-ui/README.md b/python/packages/ag-ui/README.md index 7e0d6b73d9..a7e24b5fbc 100644 --- a/python/packages/ag-ui/README.md +++ b/python/packages/ag-ui/README.md @@ -36,7 +36,7 @@ add_agent_framework_fastapi_endpoint(app, agent, "/") ## Documentation - **[Getting Started Tutorial](getting_started/)** - Step-by-step guide to building your first AG-UI server and client -- **[Examples](examples/)** - Complete examples for AG-UI features +- **[Examples](agent_framework_ag_ui_examples/)** - Complete examples for AG-UI features ## Features @@ -64,7 +64,7 @@ The package uses a clean, orchestrator-based architecture: ## Next Steps 1. **New to AG-UI?** Start with the [Getting Started Tutorial](getting_started/) -2. **Want to see examples?** Check out the [Examples](examples/) for AG-UI features +2. **Want to see examples?** Check out the [Examples](agent_framework_ag_ui_examples/) for AG-UI features ## License diff --git a/python/packages/ag-ui/examples/.env.example b/python/packages/ag-ui/agent_framework_ag_ui_examples/.env.example similarity index 100% rename from python/packages/ag-ui/examples/.env.example rename to python/packages/ag-ui/agent_framework_ag_ui_examples/.env.example diff --git a/python/packages/ag-ui/examples/.vscode/settings.json b/python/packages/ag-ui/agent_framework_ag_ui_examples/.vscode/settings.json similarity index 100% rename from python/packages/ag-ui/examples/.vscode/settings.json rename to python/packages/ag-ui/agent_framework_ag_ui_examples/.vscode/settings.json diff --git a/python/packages/ag-ui/examples/README.md b/python/packages/ag-ui/agent_framework_ag_ui_examples/README.md similarity index 100% rename from python/packages/ag-ui/examples/README.md rename to python/packages/ag-ui/agent_framework_ag_ui_examples/README.md diff --git a/python/packages/ag-ui/examples/__init__.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/__init__.py similarity index 100% rename from python/packages/ag-ui/examples/__init__.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/__init__.py diff --git a/python/packages/ag-ui/examples/__main__.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/__main__.py similarity index 100% rename from python/packages/ag-ui/examples/__main__.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/__main__.py diff --git a/python/packages/ag-ui/examples/agents/__init__.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/__init__.py similarity index 100% rename from python/packages/ag-ui/examples/agents/__init__.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/__init__.py diff --git a/python/packages/ag-ui/examples/agents/document_writer_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/document_writer_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/document_writer_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/document_writer_agent.py diff --git a/python/packages/ag-ui/examples/agents/human_in_the_loop_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/human_in_the_loop_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/human_in_the_loop_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/human_in_the_loop_agent.py diff --git a/python/packages/ag-ui/examples/agents/recipe_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/recipe_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/recipe_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/recipe_agent.py diff --git a/python/packages/ag-ui/examples/agents/research_assistant_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/research_assistant_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/research_assistant_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/research_assistant_agent.py diff --git a/python/packages/ag-ui/examples/agents/simple_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/simple_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/simple_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/simple_agent.py diff --git a/python/packages/ag-ui/examples/agents/task_planner_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_planner_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/task_planner_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_planner_agent.py diff --git a/python/packages/ag-ui/examples/agents/task_steps_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_steps_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/task_steps_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_steps_agent.py diff --git a/python/packages/ag-ui/examples/agents/ui_generator_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/ui_generator_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/ui_generator_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/ui_generator_agent.py diff --git a/python/packages/ag-ui/examples/agents/weather_agent.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/agents/weather_agent.py similarity index 100% rename from python/packages/ag-ui/examples/agents/weather_agent.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/agents/weather_agent.py diff --git a/python/packages/ag-ui/examples/server/__init__.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/server/__init__.py similarity index 100% rename from python/packages/ag-ui/examples/server/__init__.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/server/__init__.py diff --git a/python/packages/ag-ui/examples/server/api/__init__.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/__init__.py similarity index 100% rename from python/packages/ag-ui/examples/server/api/__init__.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/__init__.py diff --git a/python/packages/ag-ui/examples/server/api/backend_tool_rendering.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/backend_tool_rendering.py similarity index 100% rename from python/packages/ag-ui/examples/server/api/backend_tool_rendering.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/backend_tool_rendering.py diff --git a/python/packages/ag-ui/examples/server/main.py b/python/packages/ag-ui/agent_framework_ag_ui_examples/server/main.py similarity index 100% rename from python/packages/ag-ui/examples/server/main.py rename to python/packages/ag-ui/agent_framework_ag_ui_examples/server/main.py diff --git a/python/packages/ag-ui/getting_started/README.md b/python/packages/ag-ui/getting_started/README.md index 2d1219bed4..f656e49979 100644 --- a/python/packages/ag-ui/getting_started/README.md +++ b/python/packages/ag-ui/getting_started/README.md @@ -629,7 +629,7 @@ Now that you understand the basics of AG-UI, you can: ## Additional Resources -- [AG-UI Examples](../examples/README.md): Complete working examples for all 7 features +- [AG-UI Examples](../agent_framework_ag_ui_examples/README.md): Complete working examples for all 7 features - [Agent Framework Documentation](../../core/README.md): Learn more about creating agents - [AG-UI Protocol Spec](https://docs.ag-ui.com/): Official protocol documentation diff --git a/python/packages/ag-ui/pyproject.toml b/python/packages/ag-ui/pyproject.toml index 85297ac73f..400e5e6e34 100644 --- a/python/packages/ag-ui/pyproject.toml +++ b/python/packages/ag-ui/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "agent-framework-ag-ui" -version = "1.0.0b251106" +version = "1.0.0b251106.post1" description = "AG-UI protocol integration for Agent Framework" readme = "README.md" license-files = ["LICENSE"] @@ -40,8 +40,7 @@ requires = ["hatchling"] build-backend = "hatchling.build" [tool.hatch.build.targets.wheel] -packages = ["agent_framework_ag_ui"] -force-include = { "examples" = "agent_framework_ag_ui_examples" } +packages = ["agent_framework_ag_ui", "agent_framework_ag_ui_examples"] [tool.pytest.ini_options] asyncio_mode = "auto" diff --git a/python/uv.lock b/python/uv.lock index ad924492ac..ddf1ac4205 100644 --- a/python/uv.lock +++ b/python/uv.lock @@ -193,7 +193,7 @@ requires-dist = [ [[package]] name = "agent-framework-ag-ui" -version = "1.0.0b251106" +version = "1.0.0b251106.post1" source = { editable = "packages/ag-ui" } dependencies = [ { name = "ag-ui-protocol", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" },