herojan/clin

Cli for Nakadi for event types and subscriptions management

Clin

Clin is a command-line utility to manage Nakadi resources from schema files in "Infrastructure as Code" style.

User Guide

Prerequisites

• Python >= 3.7

Installing

You can install clin directly from PyPI using pip:

pip install clin

Getting started

After this you should be able to run the clin tool:

~ clin --help
Usage: clin [OPTIONS] COMMAND [ARGS]...
...

Please refer to the documentation and examples.

Contributing

Please read CONTRIBUTING for details on our process for submitting pull requests to us, and please ensure you follow the CODE_OF_CONDUCT.

Prerequisites

• Python >= 3.7
• Poetry for packaging and dependency management. See the official docs for instructions on installation and basic usage.

Installing

After cloning the repository, use poetry to create a new virtual environment and restore all dependencies.

poetry install

If you're using an IDE (eg. PyCharm), make sure that it's configured to use the virtual environment created by poetry as the project's interpreter. You can find the path to the used environment with poetry env info.

Running the tests

poetry run pytest

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Dmitry Erokhin @Dmitry-Erokhin
• Daniel Stockhammer @dstockhammer

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.