Skip to content

Installation

Requirements

  • Python 3.10 or higher
  • A supported type checker: ty, mypy, or pyright

Install with pip

pip install colnade colnade-polars

colnade provides the core abstraction layer. Install the backend adapter for your engine:

Backend Install Engine version
Polars pip install colnade-polars Polars >= 1.0
Pandas pip install colnade-pandas Pandas >= 2.0
Dask pip install colnade-dask Dask >= 2024.1

All backends require PyArrow >= 12.0 (installed automatically as a dependency).

Install with uv

uv add colnade colnade-polars

Or substitute colnade-pandas / colnade-dask for your preferred backend.

Install from source

git clone https://github.com/jwde/colnade.git
cd colnade
uv sync

Verify installation

import colnade as cn

class TestSchema(cn.Schema):
    id: cn.Column[cn.UInt64]
    name: cn.Column[cn.Utf8]

print("Colnade installed successfully!")

Type checker setup

Colnade works with any Python type checker. Here's how to set up the most common ones.

pip install ty
ty check src/

mypy

Add to your pyproject.toml:

[tool.mypy]
python_version = "3.10"
strict = true

pyright

Add to your pyproject.toml:

[tool.pyright]
pythonVersion = "3.10"
typeCheckingMode = "strict"