esque 0.1.2a0

A usable kafka tool.

Kafkaesque - a kafka tool.

Installation and Usage

Installation

esque is available at pypi.org and can be installed with pip install esque. esque requires Python 3.6+ to run.

Enable Autocompletion

esque uses Magic Environment Variables to provide autocompletion to you. You can enable autocompletion by adding the one of the following snippets to your .bashrc/.zshrc

Bash

eval "$(_ESQUE_COMPLETE=source esque)"

ZSH

eval "$(_ESQUE_COMPLETE=source_zsh esque)"

Usage

Config Definition

When starting esque for the first time the following message will appear:

No config provided in ~/.esque
Should a sample file be created in ~/.esque [y/N]:

When answering with y esque will copy over the sample config to ~/.esque/esque.cfg. Afterwards you can modify that file to fit your cluster definitions.

Alternatively might just provide a config file following the sample config's file in that path.

Command Overview

$ esque
Usage: esque [OPTIONS] COMMAND [ARGS]...

  (Kafka-)esque.

Options:
  --help  Show this message and exit.

Commands:
  create    Create a new instance of a resource.
  ctx       Switch clusters.
  delete    Delete a resource.
  describe  Get detailed informations about a resource.
  get       Get a quick overview of different resources.
  ping      Tests the connection to the kafka cluster.

Development

pipenv install --dev
pipenv shell 
export PYTHONPATH=$(pwd)

Run tests

docker-compose up