pip

Installation with pip

Kathará is also available as a Python package on PyPI.

You can install it using pip following this guide.

In this way you will be able to use Kathará as a Python module, both running standard CLI commands both importing it as a library directly in your Python projects.

Prerequisites

By default, Kathará depends on Docker, but can also leverage on Kubernetes, using Megalos.

1. To install Docker, you can follow this guide.
2. (suggested - Linux only) Install xterm terminal emulator (usually sudo apt install xterm or sudo yum install xterm or sudo pacman -S xterm), that is used by default.

Set up a Virtual Environment (Recommended)

To avoid conflicts with system-wide Python dependencies, it’s recommended to create and use a virtual environment.

python3 -m venv kathara-env

NOTE: The Python version MUST be >=3.11.

Then, activate the virtual environment:

On Linux/macOS:

source kathara-env/bin/activate

On Windows

kathara-env\Scripts\activate

NOTE: After the installation, you need to activate the virtual environment every time you open a new terminal to use Kathará.

Installation

You can install Kathará as a Python module directly from pip.

1. Install pyuv, a required dependency of Kathará:

   • (Windows) Ensure you have Git and Microsoft C++ build tools installed
   • (Linux) Ensure you have Git and GCC installed
   • (macOS) Ensure you have Git and Xcode installed
   • Run:

   python3 -m pip install git+https://github.com/saghul/pyuv@master#egg=pyuv

2. If you are planning to use Kathará with TMUX, also install the libtmux dependency:

   python3 -m pip install libtmux

3. Install Kathará:

   python3 -m pip install kathara

4. (Linux) On some distros you may need to fix execute permissions on the Kathará script:

   chmod +x kathara-env/lib/<python3.x>/site-packages/kathara.py

5. Check the installation:

   python3 -m pip kathara check