Installation

Stable release

Using docker 

docker run --rm -v ~/.aws:/root/.aws public.ecr.aws/johnpreston/kafka-overwatch:latest

Hint

Head to https://gallery.ecr.aws/johnpreston/kafka-overwatch to select a particular version if need be.

From Pip

Warning

You must use pip>=21 to have all functionalities work. Simply run 

pip install pip -U

To install Kafka Overwatch, run this command in your terminal: 

pip install --user kafka-overwatch

Hint

Highly recommend to create a new python virtualenv in order not to spread on all your machine 

python -m venv venv
source venv/bin/activate
pip install pip -U
pip install kafka-overwatch

This is the preferred method to install Kafka Overwatch python package, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guides you through the process.

From sources

The sources for Kafka Overwatch can be downloaded from the Github repo .

You can either clone the public repository: 

$ git clone git://github.com/johnpreston/kafka-overwatch

Or download the tarball : 

$ curl -OJL https://github.com/johnpreston/kafka-overwatch/tarball/main

Once you have a copy of the source, you can install it

Using pip 

# After git clone
cd kafka-overwatch
python -m venv venv
source venv/bin/activate
pip install pip -U
pip install .