Installation¶

Prerequisites¶

You must have a Java Development Kit (JDK) version 17 or newer installed and available in your system's PATH.

Recommended Installation: From GitHub¶

[!WARNING] Due to the package size (including .jar artifacts), new versions are no longer published to PyPI. The version on PyPI is outdated. It is strongly recommended to install the package directly from GitHub to get the latest features and fixes.

You can install either the latest development version from the main branch or a specific, stable version from a release tag.

Latest Development Version¶

# For core functionality
pip install "git+https://github.com/memiiso/pydbzengine.git"

# With extras (e.g., iceberg, dlt, docs)
pip install "pydbzengine[iceberg,docs] @ git+https://github.com/memiiso/pydbzengine.git"
pip install "pydbzengine[dlt,docs] @ git+https://github.com/memiiso/pydbzengine.git"

Specific Version¶

To install a specific version from a release tag (e.g., 3.4.1.0):

pip install "pydbzengine @ git+https://github.com/memiiso/pydbzengine.git@3.4.1.0"

Alternative: From PyPI (Outdated Version)¶

An older version is available on PyPI. You can install it, but be aware that it lacks recent features and updates.

# For core functionality
pip install pydbzengine

# With extras
pip install "pydbzengine[iceberg,docs]"
pip install "pydbzengine[dlt,docs]"