---
title: SDK installation
slug: sdk-installation
docTags: 
createdAt: 2026-08-26T20:21:36.505Z
---

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 up](docId\:y94jE3XBnoz1pDTynhUOA). 

# Install Python 3.12

### macOS

1. Use [Homebrew](https://brew.sh/): brew install python\@3.12 or download the installer from [python.org/downloads](https://www.python.org/downloads/).
2. Verify installation python3 --version

### Windows

1. Download the Python 3.12 installer from [python.org/downloads](https://www.python.org/downloads/)
2. Run the installer
3. Important: Check the box "Add Python to PATH" during installation
4. Click Install Now
5. Verify installation py --version

# Generate a JFrog access token

1. Go to [https://kyndryl.jfrog.io](https://kyndryl.jfrog.io/) and log in with your enterprise credentials
2. Click your **profile icon** (top right) → **Edit Profile**
3. Navigate to **Access** **Tokens** → **Generate** **Token**
4. Copy the generated token and store it securely

# Configure pip for the private repository

### macOS

```javascript
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

```

:::hint{type="info"}
Replace \<YOUR\_ACCESS\_TOKEN> with the token from Step 2.
:::

### Windows

Open PowerShell and create the pip config directory:

```javascript
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"
```

:::hint{type="info"}
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

```javascript
python3 -m venv .venv
source .venv/bin/activate
```

### Windows

```javascript
py -m venv .venv
.venv\Scripts\Activate.ps1
```

If you get an execution policy error on Windows, run:

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

Then retry the activate command.

# Install the SDK

```javascript
pip install bridge-agent-sdk
```

To install a specific version:

```javascript
pip install bridge-agent-sdk==1.0.23
```

### Optional extras

The SDK provides optional feature sets you can install:

- **CLI tools:&#x20;**

  ```javascript
  pip install "bridge-agent-sdk[cli]"
  ```
- **Tenant database support (PostgreSQL):**&#x20;

  ```javascript
  pip install "bridge-agent-sdk[tenant-db]"
  ```
- **Everything:&#x20;**

  ```javascript
  pip install "bridge-agent-sdk[all]"
  ```

# Verify installation

```javascript
"import bridge_agent_sdk; print('Bridge Agent SDK installed successfully')"
```

# Upgrading

To upgrade to the latest version:

```javascript
pip install --upgrade bridge-agent-sdk
```