docs: add missing microsoft-agents-hosting-fastapi to Packages Overview#346
docs: add missing microsoft-agents-hosting-fastapi to Packages Overview#346MattB-msft merged 1 commit intomainfrom
Conversation
Agent-Logs-Url: https://github.com/microsoft/Agents-for-python/sessions/7ff28bf3-c6ec-4d4c-a376-435bd86fadab Co-authored-by: MattB-msft <10568244+MattB-msft@users.noreply.github.com>
There was a problem hiding this comment.
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-fastapito the “Packages Overview” table with a PyPI badge and description.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| from microsoft_agents.hosting.aiohttp import start_agent_process | ||
|
|
||
| # FastAPI hosting | ||
| from microsoft_agents.hosting.fastapi import start_agent_process |
There was a problem hiding this comment.
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.
| 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 |
Summary
The
microsoft-agents-hosting-fastapipackage exists in thelibraries/directory and is published on PyPI, but was missing from the Packages Overview table inREADME.md.Changes
microsoft-agents-hosting-fastapirow to the Packages Overview table with a PyPI version badge, description, and "Replaces" column entry