Skip to content

Python: Fix ag-ui examples packaging for PyPI publish - #1953

Merged
moonbox3 merged 2 commits into
microsoft:mainfrom
moonbox3:fix-ag-ui-example-publish
Nov 6, 2025
Merged

Python: Fix ag-ui examples packaging for PyPI publish#1953
moonbox3 merged 2 commits into
microsoft:mainfrom
moonbox3:fix-ag-ui-example-publish

Conversation

@moonbox3

@moonbox3 moonbox3 commented Nov 6, 2025

Copy link
Copy Markdown
Contributor

Motivation and Context

With the latest attempts to expose the ag-ui examples via the PyPI package, things are still not working correctly - even though installing the package locally via uv worked. To finally fix things, this PR renames the examples to agent_framework_ag_ui_examples so that it can properly be included with the package publishing.

Mostly renaming in the PR, and a version bump. I built the wheel, and brought it into the AG-UI branch I am working on, and am able to properly use the examples.

Note: although there are renames, this isn't technically breaking because examples were never properly published/accessed.

Description

Fix ag-ui examples publishing.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

Copilot AI review requested due to automatic review settings November 6, 2025 02:15
@markwallace-microsoft markwallace-microsoft added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Nov 6, 2025
@markwallace-microsoft

markwallace-microsoft commented Nov 6, 2025

Copy link
Copy Markdown
Contributor

Python Test Coverage

Python Test Coverage Report •
FileStmtsMissCoverMissing
TOTAL12822191185% 
report-only-changed-files is enabled. No files were changed during this commit :)

Python Unit Test Overview

Tests Skipped Failures Errors Time
1698 107 💤 0 ❌ 0 🔥 32.440s ⏱️

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the AG-UI examples into a proper Python package structure that can be distributed with the main agent-framework-ag-ui package. The package version is bumped to 1.0.0b251106.post1 to reflect this change.

  • Moves example code from examples/ to agent_framework_ag_ui_examples/ package
  • Updates the build configuration to include the examples package in the wheel distribution
  • Adds proper package structure with __init__.py and __main__.py for module execution

Reviewed Changes

Copilot reviewed 1 out of 21 changed files in this pull request and generated no comments.

Show a summary per file
File Description
python/uv.lock Updates locked version to 1.0.0b251106.post1
python/packages/ag-ui/pyproject.toml Bumps version and changes package configuration from force-include to standard packages list
python/packages/ag-ui/agent_framework_ag_ui_examples/server/main.py FastAPI server implementation with all AG-UI example endpoints
python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/backend_tool_rendering.py Backend tool rendering endpoint registration
python/packages/ag-ui/agent_framework_ag_ui_examples/server/api/__init__.py API endpoints package initialization
python/packages/ag-ui/agent_framework_ag_ui_examples/server/__init__.py Server package initialization
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/weather_agent.py Weather agent demonstrating backend tool rendering
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/ui_generator_agent.py UI generator agent for tool-based generative UI
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_steps_agent.py Task steps agent with streaming state updates and step execution simulation
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/task_planner_agent.py Task planner with human-in-the-loop approval workflow
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/simple_agent.py Basic chat agent example
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/research_assistant_agent.py Research assistant with async tools
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/recipe_agent.py Recipe agent with shared state management
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/human_in_the_loop_agent.py Human-in-the-loop agent with step customization
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/document_writer_agent.py Document writer with predictive state updates
python/packages/ag-ui/agent_framework_ag_ui_examples/agents/__init__.py Exports all example agents
python/packages/ag-ui/agent_framework_ag_ui_examples/__main__.py Module entry point for running the server
python/packages/ag-ui/agent_framework_ag_ui_examples/__init__.py Package initialization
python/packages/ag-ui/agent_framework_ag_ui_examples/README.md Comprehensive documentation for the AG-UI integration
python/packages/ag-ui/agent_framework_ag_ui_examples/.vscode/settings.json VS Code Python path configuration
python/packages/ag-ui/agent_framework_ag_ui_examples/.env.example Environment variable template

@moonbox3
moonbox3 merged commit ac018f7 into microsoft:main Nov 6, 2025
24 checks passed
arisng pushed a commit to arisng/agent-framework that referenced this pull request Feb 2, 2026
* Fix ag-ui examples packaging for PyPI publish

* Fix markdown links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants