Overview

PyPaimon is a Python implementation for connecting Paimon catalog, reading & writing tables. The complete Python implementation of the brand new PyPaimon does not require JDK installation.

Environment Settings

SDK is published at pypaimon. You can install by

pip install pypaimon

Build From Source

You can build the source package by executing the following command:

python3 setup.py sdist

The package is under dist/. Then you can install the package by executing the following command:

pip3 install dist/*.tar.gz

The command will install the package and core dependencies to your local Python environment.

Optional Dependencies

PyPaimon supports multiple file formats via optional extras:

# Mosaic format (columnar-bucket hybrid, optimized for wide tables)
pip install pypaimon[mosaic]

# Lance format (optimized for ML / vector search)
pip install pypaimon[lance]

# Vortex format (requires Python >= 3.11)
pip install pypaimon[vortex]