Dev guide

Dev setup

You will need to install uv.

Install dev dependencies

uv sync

By default these come with the group chdb also, but not the docs group - to install with these use the --group flag.

Manually update dev dependency versions with:

uv lock

Check package (with ruff and mypy):

./scripts/check_package.sh

Run all pytest tests:

uv run python -m pytest -vx tests

You can run just the tests with chdb (for instance if you do not have clickhouse), or just clickhouse, by passing the -m flag

uv run python -m pytest -vxm chdb tests
# or the clickhouse tests:
uv run python -m pytest -vxm clickhouse tests

For clickhouse tests you will need to have docker container running.

Run test scripts

uv run python scripts/getting_started_chdb.py
uv run python scripts/getting_started_clickhouse.py

From root of repo:

./scripts/bump_version.sh X.X.X

Build package to dist/

uv build --package splinkclickhouse

Inspect package contents:

# replace version as appropriate
mkdir -p tmp && tar -xzvf dist/splinkclickhouse-0.4.0.tar.gz -C tmp/