Skip to main content
We recommend using uv for project management and installing the SDK from the private Backbase Artifactory.

​
1. Configure pyproject.toml

Add the Backbase Artifactory repository to your pyproject.toml. This tells uv where to find the bb-ai-sdk package.
pyproject.toml
[[tool.uv.index]]
name = "backbase"
url = "https://repo.backbase.com/artifactory/api/pypi/pypi-local/simple"
explicit = true

​
2. Set Credentials

Authenticate with Artifactory using environment variables. Add these to your .env file (and ensure .env is in .gitignore):
.env
# Artifactory Credentials
UV_INDEX_BACKBASE_USERNAME=your_username
UV_INDEX_BACKBASE_PASSWORD=your_api_key_or_password
The environment variable format is UV_INDEX_<NAME>_USERNAME, where <NAME> matches the name you defined in pyproject.toml (uppercased).

​
3. Install the SDK

Load your environment variables and add the package: 
# Load env vars
source .env

# Install SDK
uv add bb-ai-sdk --index backbase

​
Optional Framework Support

If you are using specific frameworks, you can install the SDK with extra dependencies: 
# For LangChain/LangGraph support
uv add "bb-ai-sdk[langchain]" --index backbase

# For Agno support
uv add "bb-ai-sdk[agno]" --index backbase

# For all framework adapters
uv add "bb-ai-sdk[all]" --index backbase

​
Verification

Verify the installation was successful: 
uv run python -c "import bb_ai_sdk; print(bb_ai_sdk.__version__)"
If you see the version number (e.g., 0.1.0), you are ready to go!