Development

This library is developed on GitHub in the dioptra-io/diamond-miner repository.

git clone git@github.com:dioptra-io/diamond-miner.git
cd diamond-miner/

# Install the dependencies (once)
poetry install

# Install the pre-commit hooks (once)
poetry run pre-commit install

# Edit some files...

# Run the tests
poetry run pytest

# Preview the documentation
poetry run mkdocs serve --watch diamond_miner --watch docs

# Commit...

# Tag a new version
poetry run bumpversion patch # or minor/major

Test data

Most tests require a running instance of ClickHouse with pre-populated tables. To start a ClickHouse server and insert the test data:

docker run --rm -d -p 8123:8123 clickhouse/clickhouse-server:22.8
poetry run python tests/data/insert.py

To use a different server, set the DIAMOND_MINER_TEST_DATABASE_URL environment variable (http://localhost:8123 by default).