Installation¶
Prerequisites¶
Before installing, ensure you have the following:
| Requirement | Version | Notes |
|---|---|---|
| Python | 3.10+ |
Required for Vanna and FastAPI |
| pip | 23+ |
Use pip install --upgrade pip |
| OpenAI API Key | — | Required for LLM-powered SQL generation |
1. Clone the Repository¶
2. Create a Virtual Environment¶
3. Install Dependencies¶
The requirements.txt installs:
| Package | Purpose |
|---|---|
fastapi |
Modern async web framework |
uvicorn |
ASGI server for FastAPI |
vanna[chromadb,openai] |
RAG + SQL generation engine |
pandas |
Data manipulation and DataFrame handling |
pydantic-settings |
Type-safe environment variable management |
python-dotenv |
Loading .env files |
mkdocs-material |
This documentation site |