kaskade is a terminal user interface for kafka
Project description
╔══════════════════════════════════════╗ ║ _ _ _ ║ ║ | | ____ _ ___| | ____ _ __| | ___ ║ ║ | |/ / _` / __| |/ / _` |/ _` |/ _ \ ║ ║ | < (_| \__ \ < (_| | (_| | __/ ║ ║ |_|\_\__,_|___/_|\_\__,_|\__,_|\___| ║ ╚══════════════════════════════════════╝
kaskade
is a terminal user interface for kafka.
Installation and Usage
Install with pip:
pip install kaskade
Upgrade with pip:
pip install --upgrade kaskade
Help:
kaskade --help
Version:
kaskade --version
Run without config file (it'll take any of kaskade.yml
, kaskade.yaml
, config.yml
, config.yaml
):
kaskade
Run with config file:
kaskade my-file.yml
Running with Docker
Using docker (add a network
and volume
):
docker run --rm -it --network kafka-sandbox_network -v $(pwd)/config.yml:/kaskade/config.yml sauljabin/kaskade:latest
Development
Installing poetry:
pip install poetry
Installing development dependencies:
poetry install
Build (it'll create the dist
folder):
poetry build
Scripts
Running unit tests:
poetry run python -m scripts.tests
Running multi version tests (3.7
, 3.8
, 3.9
):
Make sure you have
python3.7
,python3.8
,python3.9
aliases installed
poetry run python -m scripts.multi-version-tests
Applying code styles:
poetry run python -m scripts.styles
Running code analysis:
poetry run python -m scripts.analyze
Running code coverage:
poetry run python -m scripts.tests-coverage
Generate readme banner:
poetry run python -m scripts.banner
Running cli using poetry
:
poetry run kaskade
Docker
Build docker:
poetry build
docker build -t sauljabin/kaskade:latest -f ./docker/Dockerfile .
Run with docker:
docker run --rm -it --network kafka-sandbox_network -v $(pwd)/config.yml:/kaskade/config.yml sauljabin/kaskade:latest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.