๐จ Installation¶
The packages are hosted on:
To install this project, you will need to have Python and uv
installed on your machine:
Run the following commands, to create a virtual environment with uv
and install the dependencies:
# Install the package using uv
uv sync
# Or equivalently use make (also installs pre-commit)
make init
๐ ๏ธ Development¶
To setup for development we recommend using the makefile setup
make init-dev # installs pre-commit as a hook
To install cpg-flow
locally, run:
make install-local
Tip
To try out the pre-installed cpg-flow
in a Docker image, find more information in the Docker section.
๐ Build¶
To build the project, run the following command:
make build
To make sure that you're actually using the installed build we suggest calling the following to install the build wheel.
make install-build