Metadata-Version: 2.1
Name: kafkapy
Version: 0.2.0
Summary: Python CLI for managing a kafka cluster
Author: symonk
Author-email: jackofspaces@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: confluent-kafka (>=2.3.0,<3.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: rich (>=13.7.0,<14.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

<img src="https://github.com/symonk/kafkapy/blob/main/.github/images/logo.png" border="1" width="275" height="275">

![version](https://img.shields.io/pypi/v/kafkapy?color=%2342f54b&label=&style=flat-square)
[![codecov](https://codecov.io/gh/symonk/kafkapy/branch/main/graph/badge.svg)](https://codecov.io/gh/symonk/kafkapy)
[![docs](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://symonk.github.io/kafkapy/)

###  Kafkapy

Kafkapy is a python kafka administrative tool for managing brokers and other resources brokers manage such as
`topics` and `partitions`.  

-----

## Quick Start

Create a `properties.yaml` file, by default `kafkapy` will look in `~/.kafkapy/properties.yaml` if one is not
provided via `--properties` option.  This file should set any of the properties you wish to pass on to the underlying
`librdkafka` library options.

For a full properties reference, see the following:

View `librdkafka` properties [Here](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md)


-----

## Contributing

In order to contribute to the project:

```python
# placeholder
```
