Development#

Thanks for deciding to work on ducklake! You can create a development environment with the following steps.

Install Tooling#

To work on the ducklake Python SDK you’ll need to install:

  • pixi to manage the Python and tooling environment

  • rustup to manage the Rust toolchain for compiling the native module

Environment Installation#

git clone https://github.com/borchero/ducklake-sdk
cd ducklake-sdk
rustup show
pixi install

Build and install the native module locally with:

pixi run install-py

Running the Tests#

Python tests:

pixi run test-py

Rust tests:

pixi run test-rs

Linting#

pixi run lint

Documentation#

We use Sphinx together with MyST, and write user documentation in markdown. If you are not yet familiar with this setup, the MyST docs for Sphinx are a good starting point.

When updating the documentation, you can compile a local build of the documentation and then open it in your web browser using the commands below:

pixi run -e docs docs
open ducklake-python/docs/_build/html/index.html