Project Porting Guide

This guide walks you through the process of migrating an existing project to the SDK.

Poetry Setup (Optional)

We recommend using Poetry for package management. This step is optional but it should also streamline other parts of the migration process.

Install pipx and poetry:

pip3 install pipx
pipx ensurepath
pipx install poetry

Initialize poetry inside your existing project:

cd tap-<myproject>
poetry init
# poetry will setup your project interactively

Add the SDK as a dependency:

poetry add singer-sdk

Or to use a prerelease version of the SDK you can modify pyproject.toml as follows:

[tool.poetry.dependencies]
python = "^3.8"
singer-sdk = { git = "https://gitlab.com/meltano/sdk.git", branch = "development" }

Then:

poetry install