Skip to content

app_agent.py sample requires several undocumented dependencies #6076

@ZivGrinblat

Description

@ZivGrinblat

What is the doc issue?

Describe the issue
While trying to run the app_agent.py sample inside python/samples/agentchat_fastapi, I encountered several missing dependencies and setup hurdles that are not documented anywhere in the README or sample guide.

What do you want to see in the doc?
When running the sample at python/samples/agentchat_fastapi/app_agent.py, several important dependencies were missing and not documented. As a new contributor, I ran into multiple ModuleNotFoundError issues which were resolved only after trial-and-error.

I’d love to see an updated README or setup guide for the agentchat_fastapi sample that clearly lists all the required installation steps, including:

pip install aiofiles pyyaml fastapi uvicorn

cd python/packages/autogen-core
pip install -e ".[dev]"

cd ../autogen-agentchat
pip install -e ".[dev]"

N/A — the issue is purely CLI-based, but here's a log-style sample of what I encountered:
ModuleNotFoundError: No module named 'aiofiles'
ModuleNotFoundError: No module named 'yaml'
ModuleNotFoundError: No module named 'autogen_agentchat'
ModuleNotFoundError: No module named 'fastapi'

This covers every step I took, all the errors I encountered, and the exact fixes I used. Happy to submit a PR if you'd like help improving the sample documentation!

Suggested Fix / Working Setup

Clone & activate env

git clone https://github.com/microsoft/autogen.git
cd autogen
python3 -m venv env
source env/bin/activate

Install packages

cd python/packages/autogen-core
pip install -e ".[dev]"

cd ../autogen-agentchat
pip install -e ".[dev]"

pip install aiofiles pyyaml fastapi uvicorn

Run sample

cd ../../samples/agentchat_fastapi
python3 app_agent.py

Link to the doc page, if applicable

//

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions