Document dependency installation in demo setup#126
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| # 1. Python environment (only needs to be done once) | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate | ||
| python -m pip install --upgrade pip | ||
| pip install -r requirements.txt |
There was a problem hiding this comment.
Install API dependencies from the API requirements file
The new setup section runs pip install -r requirements.txt, but the API server launched a few lines later imports uvicorn. uvicorn is not listed in the top-level requirements.txt; it only appears in apps/api/requirements.txt. On a clean environment, following these steps installs FastAPI but not uvicorn, so python demo_api_server.py fails immediately with ModuleNotFoundError: uvicorn. Please install from apps/api/requirements.txt (or add uvicorn to the root file) so the documented demo commands work on a fresh machine.
Useful? React with 👍 / 👎.
|
Closing as part of PR consolidation. Useful changes have been cherry-picked into PR #240. |
Summary
Testing
https://chatgpt.com/codex/tasks/task_e_68f5bf91e0448329a5dbad16d7c76f03
Summary by cubic
Updated the VC demo guide to set up a Python virtual environment and install requirements before starting the API server. This ensures dependencies are installed and prevents run errors.