Skip to content

INSTALLATION.md

Latest commit

 

History

History
53 lines (36 loc) · 978 Bytes

INSTALLATION.md

File metadata and controls

53 lines (36 loc) · 978 Bytes

Installation Guide

For Local Development (AdAPI Repo)

From the AdAPI/api/ directory:

# Install in editable mode
pip install -e ../public-api/vkra-protocol

# Or with uv
uv pip install -e ../public-api/vkra-protocol

The main API's pyproject.toml includes vkra-protocol as a local path dependency, but you may need to install it manually first.

For Standalone Use

# Clone the repository
git clone https://github.com/vkra/vkra-protocol.git
cd vkra-protocol

# Install dependencies
pip install -e .

# Or with uv
uv pip install -e .

Dependencies

The package requires:

  • Python >= 3.11
  • pydantic >= 2.0.0
  • openai >= 1.0.0

Install with:

pip install pydantic openai

Verification

After installation, verify it works:

from vkra_protocol import LLMAOrchestrator, VectorDatabase, UserProfileStore
from vkra_protocol.schemas import SearchRequest, UserContext

print("✅ Package installed successfully!")