Metadata-Version: 2.1
Name: kyanitctl
Version: 1.0.0
Summary: Command-line utility for Kyanit
Home-page: https://github.com/kyanit-project/kyanitctl
Author: Zsolt Nagy
Author-email: zsolt@kyanit.eu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: kyanitapi

# __Kyanit__ CTL

## Introduction

Kyanit CTL is part of the Kyanit ecosystem. See https://github.com/kyanit-project/kyanit for an
introduction to Kyanit.

Kyanit CTL is a command-line utility using Kyanit API for interfacing and interacting with Kyanit.

## The Kyanit Ecosystem

* [**Kyanit Core**](https://github.com/kyanit-project/kyanit)

The core Kyanit module, flashed into an ESP8266 board.

* [**Kyanit Board**](https://github.com/kyanit-project/kyanit-board)

A stylish, triangle-shaped ESP8266-based board built around an ESP-12F module, the official Kyanit
controller board.

* [**Kyanit CTL**](https://github.com/kyanit-project/kyanit-ctl)

This repo. Command-line utility for interacting with Kyanit.

* [**Kyanit API**](https://github.com/kyanit-project/kyanit-api)

Python API for interaction with Kyanit from Python code. (It is used by Kyanit CTL.)

## Installing Kyanit CTL

Install the latest released version with:

```
pip install kyanitctl
```

After installation, Kyanit CTL will be available through the `kyanitctl` command.

## Installing Kyanit CTL from Source

To get the latest development version, clone this repository and within the repository root, run:

```
python setup.py install
```

## Usage

Refer to the command-line help with `kyanitctl -h`.

## License Notice

Copyright (C) 2020 Zsolt Nagy

This program is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>.


