# Clin
**Clin** is a command-line utility to manage [Nakadi](https://nakadi.io/)
resources from schema files in "Infrastructure as Code" style.
## User Guide
### Prerequisites
* [Python](https://www.python.org/) >= 3.7
### Installing
You can install **clin** directly from [PyPI](https://pypi.org/project/clin/)
using pip:
```bash
pip install clin
```
### Getting started
After this you should be able to run the `clin` tool:
```bash
~ clin --help
Usage: clin [OPTIONS] COMMAND [ARGS]...
...
```
Please refer to the [documentation](https://github.com/zalando-incubator/clin/tree/master/docs)
and [examples](https://github.com/zalando-incubator/clin/tree/master/docs/examples).
## Contributing
Please read [CONTRIBUTING](https://github.com/zalando-incubator/clin/blob/master/CONTRIBUTING.md)
for details on our process for submitting pull requests to us, and please ensure
you follow the [CODE_OF_CONDUCT](https://github.com/zalando-incubator/clin/blob/master/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](Chttps://github.com/zalando-incubator/clin/blob/master/ONTRIBUTORS.md)
who participated in this project.
## License
This project is licensed under the MIT License. See the
[LICENSE](https://github.com/zalando-incubator/clin/blob/master/LICENSE) file
for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/zalando-incubator/clin",
"name": "clin",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "Nakadi",
"author": "Dmitry Erokhin",
"author_email": "dmitry.erokhin@zalando.de",
"download_url": "https://files.pythonhosted.org/packages/8f/58/a058a095238e6a6e269edbbc2375df1b8d5e641e63e331ddf15221048ad6/clin-1.8.0.tar.gz",
"platform": null,
"description": "# Clin\n\n**Clin** is a command-line utility to manage [Nakadi](https://nakadi.io/)\nresources from schema files in \"Infrastructure as Code\" style.\n\n\n## User Guide\n\n### Prerequisites\n\n* [Python](https://www.python.org/) >= 3.7\n\n### Installing\nYou can install **clin** directly from [PyPI](https://pypi.org/project/clin/)\nusing pip:\n\n```bash\npip install clin\n```\n\n### Getting started\n\nAfter this you should be able to run the `clin` tool:\n```bash\n~ clin --help\nUsage: clin [OPTIONS] COMMAND [ARGS]...\n...\n```\n\nPlease refer to the [documentation](https://github.com/zalando-incubator/clin/tree/master/docs)\nand [examples](https://github.com/zalando-incubator/clin/tree/master/docs/examples).\n\n## Contributing\n\nPlease read [CONTRIBUTING](https://github.com/zalando-incubator/clin/blob/master/CONTRIBUTING.md)\nfor details on our process for submitting pull requests to us, and please ensure\nyou follow the [CODE_OF_CONDUCT](https://github.com/zalando-incubator/clin/blob/master/CODE_OF_CONDUCT.md).\n\n### Prerequisites\n\n* [Python](https://www.python.org/) >= 3.7\n* [Poetry](https://python-poetry.org/) for packaging and dependency\n management. See the [official docs](https://python-poetry.org/docs/) for\n instructions on installation and basic usage.\n\n### Installing\nAfter cloning the repository, use `poetry` to create a new virtual environment\nand restore all dependencies.\n\n```bash\npoetry install\n```\n\nIf you're using an IDE (eg. PyCharm), make sure that it's configured to use the\nvirtual environment created by poetry as the project's interpreter. You can find\nthe path to the used environment with `poetry env info`.\n\n### Running the tests\n\n```bash\npoetry run pytest\n```\n\n## Versioning\n\nWe use [SemVer](http://semver.org) for versioning. For the versions available,\nsee the [tags on this repository](https://github.com/zalando-incubator/clin/tags).\n\n## Authors\n\n* **Dmitry Erokhin** [@Dmitry-Erokhin](https://github.com/Dmitry-Erokhin)\n* **Daniel Stockhammer** [@dstockhammer](https://github.com/dstockhammer)\n\nSee also the list of [contributors](Chttps://github.com/zalando-incubator/clin/blob/master/ONTRIBUTORS.md)\nwho participated in this project.\n\n## License\n\nThis project is licensed under the MIT License. See the\n[LICENSE](https://github.com/zalando-incubator/clin/blob/master/LICENSE) file\nfor details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cli for Nakadi resources management in Infrastructure as Code style",
"version": "1.8.0",
"project_urls": {
"Homepage": "https://github.com/zalando-incubator/clin"
},
"split_keywords": [
"nakadi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5e2c3e43d0edf170fdd729c2dd83fd0c37f7fd93c59fff64eec6b499e82deb4",
"md5": "73b77c598471bc44a93b8c37e02aab4b",
"sha256": "286679738679513c2d5f83d114c15b3699de220119be07d7d4b43bb4ef311fb0"
},
"downloads": -1,
"filename": "clin-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73b77c598471bc44a93b8c37e02aab4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 21640,
"upload_time": "2024-05-27T13:44:49",
"upload_time_iso_8601": "2024-05-27T13:44:49.188521Z",
"url": "https://files.pythonhosted.org/packages/a5/e2/c3e43d0edf170fdd729c2dd83fd0c37f7fd93c59fff64eec6b499e82deb4/clin-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f58a058a095238e6a6e269edbbc2375df1b8d5e641e63e331ddf15221048ad6",
"md5": "26bc4498fb754554672123543fcb91df",
"sha256": "9a715421f645f483c082408b2f9ad371b90993131c9aeda5420e923ac3dba40b"
},
"downloads": -1,
"filename": "clin-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "26bc4498fb754554672123543fcb91df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 16658,
"upload_time": "2024-05-27T13:44:50",
"upload_time_iso_8601": "2024-05-27T13:44:50.897795Z",
"url": "https://files.pythonhosted.org/packages/8f/58/a058a095238e6a6e269edbbc2375df1b8d5e641e63e331ddf15221048ad6/clin-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 13:44:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zalando-incubator",
"github_project": "clin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clin"
}
JSON
