Installation

From PyPI

pip install clat-tidy

This installs the clat command on your PATH.

Distribution name vs command name

You install clat-tidy but run clat. The PyPI distribution is called clat-tidy because the name clat was already taken; the command, the importable package, and the config files are all still clat.

Requires Python ≥ 3.8. On Python < 3.11, the tomli TOML reader is installed automatically (3.11+ uses the standard-library tomllib).

clat's only runtime dependency is rich, for its coloured terminal output.

Verify

clat --version

clat 0.5.0

With pipx

To keep clat isolated from your project environments:

pipx install clat-tidy

Development install

Clone the repository and create the conda development environment:

git clone https://github.com/ccaprani/clat.git
cd clat
conda env create -f environment.yml
conda activate clat

The conda environment installs clat in editable mode with the docs extra and pytest, so it can run both tests and documentation builds:

python -m pytest tests/ -v
mkdocs serve   # live preview at http://127.0.0.1:8000

To install into an existing environment instead, use pip:

pip install -e '.[docs]'