How to Install Connector SDK

Follow the steps below to install and configure the Connector SDK locally.

See Upgrade your Connector SDK package if you need to update an installed package.

Create a Python virtual environment

We recommend you create a separate Python virtual environment on your local machine for each custom connector you write using Connector SDK. A Python virtual environment isolates one project's dependencies from another's. This prevents version conflicts, so if you write multiple connectors that require different library versions, they don't interfere with each other.

You can create a virtual environment using venv or uv. Once created, activate the virtual environment before installing the Connector SDK or running any connector commands.

See our Using Environment Variables With the Connector SDK guide for details on how to use environment variables.

Install Connector SDK

In the same directory where you created your virtual environment, run the following command after activating it:

pip install fivetran-connector-sdk

To learn about pre-installed packages and DB drivers, see our SDK Runtime documentation.

To learn how to work with the SDK's CLI, see our Connector SDK CLI Commands documentation.

Troubleshooting

If you are experiencing issues with installing Connector SDK, see our troubleshooting articles:

• Command Not Found
• Fivetran.exe Failed to Run
• No Connector SDK Version Information

Upgrade your Connector SDK package

We recommend always using the latest version of the Connector SDK, as it contains all the latest definitions and updates. You can upgrade it using the following pip command:

pip install --upgrade fivetran-connector-sdk