Skip to content

Setup checkmaite

Clone the project repository

Ensure you have the right permissions, and clone the project repository:

git clone https://gitlab.jatic.net/jatic/reference-implementation/reference-implementation.git

Create environment and install the package

For most end users, the supported install path is pip:

pip install .

Optional extras for end users:

pip install ".[ui]"           # UI dependencies
pip install ".[reporting]"    # PDF report export (markdown + xhtml2pdf)
pip install ".[cloud]"        # cloud storage dependencies (aws+gcs+azure)
pip install ".[unsupported]"  # installs checkmaite-plugins (includes Java/PySpark deps, Python <3.12)

dev/docs dependencies are Poetry dependency groups, not pip extras.

We also provide poetry-based and conda-based environment setup options below.

Option 1: poetry environment

To set up a poetry environment, install poetry (the minimum supported version is 2.0.0), and build the environment with:

poetry install

JATIC tools which are not under active development are distributed through the separate checkmaite-plugins package. Use these tools with caution because they may contain bugs or may be incompatible with the environment in the future.

poetry install --extras unsupported

You can also install the plugin package directly:

pip install "checkmaite-plugins[unsupported]"

If you are developing locally across both repositories:

pip install -e /path/to/checkmaite
pip install -e "/path/to/checkmaite-plugins[unsupported]"

Option 2: conda environment

To set up a conda environment, install conda on your machine and build the environment with:

# create env with conda-lock installed
conda create -n checkmaite "conda-lock>=3"

# activate the environment
conda activate checkmaite

# use conda-lock to install dependencies
CONDA_ENV_NAME=checkmaite make conda-env

# finally, install the `checkmaite` package
pip install . --no-deps