Installation¶

Requirements¶

Python 3.10 or higher
Polars (primary DataFrame library)
DuckDB (optional, for DuckDB backend)

Install with pip¶

pip install transformplan

Install with uv¶

uv add transformplan

Optional: DuckDB Backend¶

To use the DuckDB backend, install DuckDB separately:

pip install duckdb

Or with uv:

uv add duckdb

Development Installation¶

Clone the repository and install with development dependencies:

git clone https://github.com/limebit/transformplan.git
cd transformplan
make install-dev

This will:

Create a virtual environment
Install all runtime and development dependencies
Install the package in editable mode

Verify Installation¶

import transformplan
print(transformplan.__all__)

You should see the list of exported classes and functions:

['Backend', 'ChunkValidationResult', 'ChunkedProtocol', 'ChunkingError',
 'Col', 'DryRunResult', 'Filter', 'PolarsBackend', 'Protocol',
 'SchemaValidationError', 'TransformPlan', 'ValidationResult', 'frame_hash']