Skip to content

docs: add missing microsoft-agents-hosting-fastapi to Packages Overview#346

Merged
MattB-msft merged 1 commit intomainfrom
copilot/update-packages-overview
Mar 31, 2026
Merged

docs: add missing microsoft-agents-hosting-fastapi to Packages Overview#346
MattB-msft merged 1 commit intomainfrom
copilot/update-packages-overview

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

Summary

The microsoft-agents-hosting-fastapi package exists in the libraries/ directory and is published on PyPI, but was missing from the Packages Overview table in README.md.

Changes

  • Added microsoft-agents-hosting-fastapi row to the Packages Overview table with a PyPI version badge, description, and "Replaces" column entry
  • Added a FastAPI import example to the Import Examples section alongside the existing aiohttp example

@MattB-msft MattB-msft marked this pull request as ready for review March 31, 2026 17:57
@MattB-msft MattB-msft requested a review from a team as a code owner March 31, 2026 17:57
Copilot AI review requested due to automatic review settings March 31, 2026 17:57
@MattB-msft MattB-msft merged commit c8e6af3 into main Mar 31, 2026
11 checks passed
@MattB-msft MattB-msft deleted the copilot/update-packages-overview branch March 31, 2026 17:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s top-level documentation to reflect that the FastAPI hosting package is part of the SDK and to show how to import it, aligning the README with the packages actually present/published.

Changes:

  • Added a FastAPI import example in the “Import Examples” section.
  • Added microsoft-agents-hosting-fastapi to the “Packages Overview” table with a PyPI badge and description.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines 30 to +33
from microsoft_agents.hosting.aiohttp import start_agent_process

# FastAPI hosting
from microsoft_agents.hosting.fastapi import start_agent_process
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

In the single Import Examples code block, both aiohttp and FastAPI imports bind the same name start_agent_process. If a user copies the whole block, the FastAPI import will overwrite the aiohttp import, which is confusing and can lead to using the wrong framework helper. Consider splitting these into separate code blocks, or aliasing the imports (e.g., start_agent_process as aiohttp_start_agent_process / ... as fastapi_start_agent_process) to make the example copy/paste-safe.

Suggested change
from microsoft_agents.hosting.aiohttp import start_agent_process
# FastAPI hosting
from microsoft_agents.hosting.fastapi import start_agent_process
from microsoft_agents.hosting.aiohttp import start_agent_process as aiohttp_start_agent_process
# FastAPI hosting
from microsoft_agents.hosting.fastapi import start_agent_process as fastapi_start_agent_process

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants