Metadata-Version: 2.1
Name: clin
Version: 1.0.0a1
Summary: Cli for Nakadi resources management in infrastructure-as-a-code manner
Home-page: https://github.bus.zalan.do/derokhin/clin
License: MIT
Keywords: Nakadi
Author: Dmitry Erokhin
Author-email: dmitry.erokhin@zalando.de
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: click (>=7.1.1,<8.0.0)
Requires-Dist: colorama (>=0.4.3,<0.5.0)
Requires-Dist: deepdiff (>=4.3.2,<5.0.0)
Requires-Dist: pygments (>=2.6.1,<3.0.0)
Requires-Dist: pyyaml (>=5.3.1,<6.0.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Description-Content-Type: text/markdown

# Clin

**Clin** is a command-line utility to manage [Nakadi](https://nakadi.io/)
resources from schema files in "Infrastructure-as-a-Code" style.
![](/docs/gifs/demo.gif)

## User Guide

### Prerequisites

* [Python](https://www.python.org/) >= 3.7

### Installing
You can install **clin** direcly from [PyPI](https://pypi.org/project/clin/)
using pip:

```bash
pip install clin
```

### Getting started

After this you should be able to run tool:
```bash
~ clin --help
Usage: clin [OPTIONS] COMMAND [ARGS]...
...
```

Please refer [documentation](/docs) and [examples](/docs/examples)

## Contributing

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

### Prerequisites

* [Python](https://www.python.org/) >= 3.7
* [Poetry](https://python-poetry.org/) for packaging and dependency
  management. See the [official docs](https://python-poetry.org/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.

```bash
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

```bash
poetry run pytest
```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/zalando-incubator/clin/tags).

## Authors

* **Dmitry Erokhin** [@Dmitry-Erokhin](https://github.com/Dmitry-Erokhin)
* **Daniel Stockhammer** [@dstockhammer](https://github.com/dstockhammer)

See also the list of [contributors](CONTRIBUTORS.md) who participated in this
project.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE)
file for details.

