How to Install Connector SDK
Install Connector SDK on your local machine to develop and test custom connectors.
See Upgrade your Connector SDK package if you need to update an installed package.
Prerequisites
Python version support
Connector SDK supports the following Python versions:
- 3.15
- 3.14
- 3.13
- 3.12
- 3.11
Python may be global or managed in a virtual environment.
When specifying a Python runtime version for deployment, use one of the supported versions listed above. For more information, see fivetran deploy.
Operating system support
Connector SDK supports the following operating systems for the testing environment:
- Windows: 10 or later, 64-bit only
- macOS: 13 Ventura or later, Apple Silicon arm64 or Intel x86_64
- Linux: Ubuntu 20.04 or later, Debian 10 or later, or Amazon Linux 2 or later, arm64 or x86_64
Install Connector SDK
You can install Connector SDK using either of the following methods:
- Option 1: Install in a virtual environment (recommended): Install Connector SDK in an isolated environment using
uv. - Option 2: Install using pip: Install Connector SDK directly into your current Python environment.
We recommend using a separate virtual environment for each connector project to isolate dependencies and prevent version conflicts.
We pre-install the msodbcsql17 and msodbcsql18 drivers for connecting to Microsoft SQL Server. We also pre-install libpq5 and libpq-dev, which are required to support psycopg and psycopg2 respectively.
For Connector SDK connections that use Hybrid Deployment, we install Ubuntu packages in the SDK runtime image from the November 20, 2026 snapshot (20261120T000000Z). Third-party repositories, such as the Microsoft package repository, are not pinned to this snapshot.
Option 1: Install in a virtual environment (recommended)
Use uv to create and activate a virtual environment before installing the Connector SDK or running any connector commands.
Install
uvby following the official installation instructions.Install the required Python version. For example:
uv python install 3.13.7Create a virtual environment using that Python version:
uv venv --python 3.13.7 venvActivate the virtual environment by following the instructions in the
uvvirtual environments documentation.Install the Connector SDK:
uv pip install fivetran-connector-sdk
Option 2: Install using pip
Alternatively, install Connector SDK using pip:
pip install fivetran-connector-sdk
Upgrade your Connector SDK package
We recommend always using the latest version of Connector SDK, as it contains all the latest definitions and updates.
Option 1: Upgrade in a virtual environment
Activate your virtual environment and run:
uv pip install --upgrade fivetran-connector-sdk
Option 2: Upgrade using pip
pip install --upgrade fivetran-connector-sdk
Troubleshooting
If you encounter issues installing or upgrading Connector SDK, see the following troubleshooting guides: