Skip to content

5–10 Minute Quickstart

Status: Available in ETLantic 0.21.0. Use etlantic init for the recommended CLI-first path with durable reports and declarative assets.

1. Install

ETLantic requires Python 3.11 or newer.

python -m pip install 'etlantic==0.21.0'
python -m etlantic --version

2. Initialize a project

mkdir my-pipeline && cd my-pipeline
etlantic init --with-toml

This creates pipeline.py (SamplePipeline), profiles/development.json, sample data/sample.json, and .etlantic/ workspace directories.

3. Validate, plan, and run

etlantic doctor --profile development
etlantic inspect pipeline.py:SamplePipeline
etlantic validate pipeline.py:SamplePipeline --profile development
etlantic plan pipeline.py:SamplePipeline --profile development
etlantic run pipeline.py:SamplePipeline --profile development
etlantic report list

No Python-side runtime.memory.seed() is required: the generated profile maps assets to json://data/... paths.

Success criteria

You should see a run status of succeeded. Inspect the written asset:

cat data/out.json

Expected shape (identity transform on sample rows):

[
  {
    "id": 1,
    "name": "Ada"
  },
  {
    "id": 2,
    "name": "Grace"
  }
]

4. Python SDK path (optional)

For programmatic use, the same pipeline class works with the public SDK:

from pipeline import SamplePipeline

report = SamplePipeline.validate(profile="development")
report.raise_for_errors()
SamplePipeline.plan(profile="development")
SamplePipeline.run(profile="development")

Next steps

For an in-memory SDK demo from a checkout (not this Quickstart), see examples/memory_customers.py.