SDK installation
This guide focuses only on installing the Bridge Agent SDK package on your local system. To understand how set up the local environment, see Local set uplocal set up.
Install Python 3.12
macOS
- Use Homebrew: brew install [email protected] or download the installer from python.org/downloads.
- Verify installation python3 --version
Windows
- Download the Python 3.12 installer from python.org/downloads
- Run the installer
- Important: Check the box "Add Python to PATH" during installation
- Click Install Now
- Verify installation py --version
Generate a JFrog access token
- Go to https://kyndryl.jfrog.io and log in with your enterprise credentials
- Click your profile icon (top right) → Edit Profile
- Navigate to Access Tokens → Generate Token
- Copy the generated token and store it securely
Configure pip for the private repository
macOS
mkdir -p ~/.config/pip
cat <<EOF > ~/.config/pip/pip.conf
[global]
extra-index-url = https://_:<YOUR_ACCESS_TOKEN>@kyndryl.jfrog.io/artifactory/api/pypi/kyn-cto-kaif-pypi-local/simple
EOF
Replace <YOUR_ACCESS_TOKEN> with the token from Step 2.
Windows
Open PowerShell and create the pip config directory:
mkdir -p ~/.config/pip
cat <<EOF > ~/.config/pip/pip.conf
[global]
extra-index-url = https://_:<YOUR_ACCESS_TOKEN>@kyndryl.jfrog.io/artifactory/api/pypi/kyn-cto-kaif-pypi-local/simple
EOF
Replace <YOUR_ACCESS_TOKEN> with the token from Step 2.
mkdir "$env:APPDATA\pip" -Force
Create the config file:
@"
[global]
extra-index-url = https://_:<YOUR_ACCESS_TOKEN>@kyndryl.jfrog.io/artifactory/api/pypi/kyn-cto-kaif-pypi-local/simple
"@ | Out-File -Encoding utf8 "$env:APPDATA\pip\pip.ini"Replace <YOUR_ACCESS_TOKEN> with the token from Step 2.
Create a virtual environment
It is recommended to use a virtual environment to isolate project dependencies.
macOS
python3 -m venv .venv
source .venv/bin/activateWindows
py -m venv .venv
.venv\Scripts\Activate.ps1If you get an execution policy error on Windows, run:
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
Then retry the activate command.
Install the SDK
pip install bridge-agent-sdkTo install a specific version:
pip install bridge-agent-sdk==1.0.23Optional extras
The SDK provides optional feature sets you can install:
- CLI tools:
pip install "bridge-agent-sdk[cli]"- Tenant database support (PostgreSQL):
pip install "bridge-agent-sdk[tenant-db]"- Everything:
pip install "bridge-agent-sdk[all]"Verify installation
"import bridge_agent_sdk; print('Bridge Agent SDK installed successfully')"Upgrading
To upgrade to the latest version:
pip install --upgrade bridge-agent-sdk