Python API

Use these references alongside the guides: signatures, types and docstrings come from the installed source. The Python-script contract is the entry point for writing Python tasks. Other modules describe the engine's current implementation; their interfaces may change before 1.0.0.

Start here

• Python script types: ScriptTask, ScriptResult and Offset, with the data a task receives and returns.
• Writing Python scripts: examples, offsets, warehouse access and logging.
• Configuration: loading the project configuration and resolving its settings.

• Core errors: named errors and their exit statuses.

• Service operations: actor-scoped calls and structured result documents.

• Calling operations and JSON output: Python and CLI examples.

Packages

• api
• cli
• config
• core
• dialects
• engine
• execution
• handlers
• overseer
• scripting
• services
• warehouse

etl_craft

etl-craft: a metadata-driven ETL orchestration engine.