Skip to main content

Typed, contract-driven data pipeline modeling for Python.

Project description

ETLantic logo

ETLantic

Design once. Validate everywhere.
Typed, contract-driven data pipelines for Python.

CI PyPI Python versions MIT license Ruff

Documentation · Quickstart · Capabilities · Roadmap


ETLantic catches incompatible wiring before data is processed. Define datasets, transformations, and pipelines as typed Python classes, then validate, plan, run, or compile the same logical pipeline for different execution engines.

Typed contracts ──▶ Validation ──▶ Deterministic plan ──▶ Run or compile

Why ETLantic?

  • Fail earlier. Detect broken references, incompatible contracts, missing implementations, unsupported capabilities, and untrusted plugins before a write occurs.
  • Keep logic portable. Separate logical pipeline structure from local, Polars, Pandas, SQL, PySpark, and orchestration implementations.
  • Make plans reviewable. Generate deterministic, immutable, secret-free execution plans with stable fingerprints.
  • Preserve evidence. Produce structured diagnostics, lineage, schema observations, and run reports instead of opaque task logs.
  • Adopt incrementally. The core has no dataframe, SQL, Spark, or Airflow dependency. Install only the integrations you need.

Project status: Alpha 0.13.0. The local runtime and reference plugins are available today. Structured Streaming is experimental. Portable transformation authoring and Polars/PySpark relational compilers are available; Pandas and safe SQL portable compilers are planned for 0.14–0.15. See the capabilities guide before choosing a production architecture.

Quickstart

ETLantic requires Python 3.11 or newer.

pip install etlantic
etlantic --version

Create pipeline.py:

from etlantic import (
    Data,
    Input,
    Output,
    Pipeline,
    PipelineRuntime,
    Sink,
    Source,
    Transformation,
)


class RawCustomer(Data):
    customer_id: int
    first_name: str
    last_name: str


class Customer(Data):
    customer_id: int
    full_name: str


class NormalizeCustomers(Transformation):
    customers: Input[RawCustomer]
    result: Output[Customer]


@NormalizeCustomers.implementation("local")
def normalize_customers(customers: list[RawCustomer]) -> list[Customer]:
    return [
        Customer(
            customer_id=row.customer_id,
            full_name=f"{row.first_name} {row.last_name}",
        )
        for row in customers
    ]


class CustomerPipeline(Pipeline):
    raw: Source[RawCustomer] = Source(binding="customer_source")
    normalized = NormalizeCustomers.step(customers=raw)
    curated: Sink[Customer] = Sink(
        input=normalized.result,
        binding="customer_sink",
    )


# Validation and planning do not execute transformation code.
CustomerPipeline.validate(profile="development").raise_for_errors()
plan = CustomerPipeline.plan(profile="development")
print(plan.fingerprint)

runtime = PipelineRuntime()
runtime.memory.seed(
    "customer_source",
    [RawCustomer(customer_id=1, first_name="Ada", last_name="Lovelace")],
)
report = CustomerPipeline.run(profile="development", runtime=runtime)

print(report.status)  # succeeded
print(runtime.memory.get("customer_sink")[0].model_dump())
# {"customer_id": 1, "full_name": "Ada Lovelace"}

Change the sink contract to an incompatible type and validate() returns a structured diagnostic before any transformation or write is attempted.

The complete tested example is examples/quickstart.py.

CLI workflow

The CLI follows the same validate-first lifecycle:

# Inspect and validate a pipeline
etlantic inspect pipeline.py:CustomerPipeline --format json
etlantic validate pipeline.py:CustomerPipeline --format json

# Build and explain a deterministic execution plan
etlantic plan pipeline.py:CustomerPipeline --format json
etlantic plan explain pipeline.py:CustomerPipeline --format json

# Execute locally
etlantic run pipeline.py:CustomerPipeline --profile development

# Emit CI diagnostics
etlantic validate pipeline.py:CustomerPipeline --format sarif

Airflow compilation requires the optional etlantic-airflow package:

pip install "etlantic[airflow]"
etlantic compile pipeline.py:CustomerPipeline --target airflow -o dags/

Other public command groups cover contract generation and diffs, plugins, schema drift, reliability, visualization, and reports. Run etlantic --help for the complete command surface.

Choose an engine

Start with the core package, then add engines as needed:

pip install "etlantic[polars]"
pip install "etlantic[pandas]"
pip install "etlantic[sql]"
pip install "etlantic[pyspark]"
pip install "etlantic[airflow]"
Integration Package Purpose
Polars etlantic-polars Eager/lazy dataframe execution and portable kernel compilation
Pandas etlantic-pandas Eager dataframe execution
SQL etlantic-sql Parameterized relational execution and SQL-to-SQL plans
PySpark etlantic-pyspark Spark execution and local session provider
Airflow etlantic-airflow Compile plans into Airflow DAG artifacts
Keyring etlantic-keyring Resolve runtime secrets from the OS keyring
SQLModel etlantic-sqlmodel Bridge ContractModel schemas and SQLModel
SparkForge etlantic-sparkforge Migrate SparkForge pipeline definitions

Plugins are discovered through Python entry points and scoped to a runtime registry. Production profiles require an explicit plugin allowlist and reject untrusted plugins by default.

How it works

ETLantic keeps logical intent separate from physical execution:

  1. Author typed Data, Transformation, and Pipeline classes.
  2. Inspect an immutable logical graph without running user code.
  3. Validate structure, references, contracts, policies, capabilities, and plugin trust in ordered phases.
  4. Plan engine selections, execution regions, bindings, artifacts, and materialization boundaries.
  5. Execute or compile the plan through small backend protocols.
  6. Report step outcomes, diagnostics, lineage, artifacts, and schema observations.

Plans and reports contain secret references, never resolved secret values. Secrets are resolved only at runtime. Capability and trust failures occur before mutation.

Capability boundary

Capability 0.13
Typed modeling, validation, contracts, and deterministic planning Available
Local Python execution and structured run reports Available
Memory, callable, JSON, CSV, and no-write storage Available
Polars and Pandas dataframe plugins Available
SQL and PySpark plugins Available
Airflow plan compiler Available
ODCS, DTCS, and DPCS interchange Available
Schema drift, reliability, visualization, and SARIF tooling Available
Production plugin allowlists and runtime secret providers Available
Portable transformation authoring Available
Polars + PySpark portable compilers (kernel + relational /1) Available
Structured Streaming Experimental
Pandas portable compiler and public conformance SDK Planned for 0.14
Safe SQL portable lowering and profile graduation Planned for 0.15+

See Capabilities and Limitations and the roadmap for the precise support boundary.

Documentation

Development

The repository uses uv for its workspace and development environment:

git clone https://github.com/eddiethedean/etlantic.git
cd etlantic
uv sync
uv run python examples/quickstart.py
uv run pytest
uv run ruff check .
uv run ruff format --check .
uv run mkdocs serve

See CONTRIBUTING.md for package-specific test groups and development conventions.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

etlantic-0.13.0.tar.gz (306.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

etlantic-0.13.0-py3-none-any.whl (249.8 kB view details)

Uploaded Python 3

File details

Details for the file etlantic-0.13.0.tar.gz.

File metadata

  • Download URL: etlantic-0.13.0.tar.gz
  • Upload date:
  • Size: 306.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for etlantic-0.13.0.tar.gz
Algorithm Hash digest
SHA256 b35ac3f84469c489a38ed6c3791fec6a99b542c7c1a5231add5d21e92e0fdd2c
MD5 1d751b2766f185b8ddd5bcc961d29324
BLAKE2b-256 2eb98c2fa432b3901a2de26e31ff7d3472d3e5e69d7dd4b156fe046620b00db9

See more details on using hashes here.

File details

Details for the file etlantic-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: etlantic-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 249.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for etlantic-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f99a7e4738885dab3cbf5185467daaa972a812f1fe4c8133fdac0be25320da0
MD5 5741ce8dd6efc2ea1db683286915081f
BLAKE2b-256 db5f5832d144dc34ce8c4227c40cc1eeb0a11416efa10275067c9f838bd93ccc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page