Installation

There are three possible ways of installing TEDective ETL:

Using PyPi package (recommended for most users)
Using Nix Flake
Manually

Using PyPi package

The easiest way to install TEDective ETL is to use PyPi package via pipx:

pipx install tedective-etl
pipx ensurepath # to make sure it has been added to your path
run-pipeline --help

Using Nix:

# Install flake into your profile
nix profile install git+https://git.fsfe.org/TEDective/etl
run-pipeline --help

Alternatively, you can clone this repository and build it via Nix yourself

# Cloning the repository and entering it
git clone https://git.fsfe.org/TEDective/etl && cd etl
 
# Nix build using the provided flake
nix build
 
# Disclaimer nix-commands and flakes are experimental features so you will need to add these flags to the command to be able to run them.
--extra-experimental-features 'nix-command flakes'
# You will also been prompted to accept/decline some extra configurations. You can accept them without receiving a prompt using this or manually decide without adding it:
--accept-flake-config

Manually

Another way is to use poetry directly.

After cloning the repo (opens in a new tab):

poetry install
poetry run run-pipeline --help

Quickstart Usage