Skip to content

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

git clone https://github.com/your-org/dbn-analytics-poc.git
cd dbn-analytics-poc

2. Create a Virtual Environment

python3 -m venv venv
source venv/bin/activate
python -m venv venv
.\venv\Scripts\Activate.ps1

3. Install Dependencies

pip install --upgrade pip
pip install -r requirements.txt

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

Build dependencies

On some systems (particularly Linux/Docker), chromadb requires build-essential:

apt-get install -y build-essential