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.4.0

With pipx¶

To keep clat isolated from your project environments:

pipx install clat-tidy

Development install¶

Clone the repository and install in editable mode:

git clone https://github.com/ccaprani/clat.git
cd clat
pip install -e .

To build the documentation as well, install the docs extra:

pip install -e '.[docs]'
mkdocs serve   # live preview at http://127.0.0.1:8000

Run the test suite with:

python -m pytest tests/ -v