Skip to content

Installation

Requirements

  • Python 3.10 or higher
  • Polars (primary DataFrame library)
  • Pandas and PyArrow (optional, for Pandas support)

Install with pip

pip install transformplan

Install with uv

uv add transformplan

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:

  1. Create a virtual environment
  2. Install all runtime and development dependencies
  3. Install the package in editable mode

Verify Installation

import transformplan
print(transformplan.__all__)

You should see the list of exported classes and functions:

['TransformPlan', 'Protocol', 'frame_hash', 'Col', 'Filter',
 'ValidationResult', 'SchemaValidationError', 'DryRunResult']