Standard setup (recommended)
Use uv for project management and install the SDK from the private Backbase Artifactory.
Add the Backbase Artifactory repository to your pyproject.toml. This tells uv where to find the bb-ai-sdk package.
[[tool.uv.index]]
name = "backbase"
url = "https://repo.backbase.com/artifactory/api/pypi/pypi-local/simple"
2. Set credentials
Authenticate with Artifactory using environment variables. Add these to your .env file (and ensure .env is in .gitignore):
# Artifactory credentials
export UV_INDEX_BACKBASE_USERNAME=your_username
export 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). You must export them in .env file
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__)"