Metadata-Version: 2.1
Name: kyanitapi
Version: 1.0.1
Summary: Python API for Kyanit
Home-page: https://github.com/kyanit-project/kyanitapi
Author: Zsolt Nagy
Author-email: zsolt@kyanit.eu
License: GPLv3
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.8
Description-Content-Type: text/markdown
Requires-Dist: psutil (<6,>=5)
Requires-Dist: pythonping (<2,>=1)
Requires-Dist: requests (<3,>=2)

# __Kyanit__ API

## Introduction

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

Kyanit API is a Python 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)

Command-line utility for interacting with Kyanit.

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

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

## Installing Kyanit API

Install the latest released version with:

```
pip install kyanitapi
```

## Installing Kyanit API from Source

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

```
python setup.py bdist_wheel
```

This will create Python wheel distribution package in the `dist` directory. Install it using `pip`
with:

```
pip install --force-reinstall dist/kyanitapi-<version>-py3-none-any.whl
```

(Replace `<version>` with the one that has been generated by `setup.py`.)

To switch back to the latest released version, use:

```
pip install --force-reinstall kyanitapi==<version>
```

Where `<version>` is the latest released version.

## Documentation

For a detailed documentation of the API, head to https://kyanit.eu/docs/kyanit-api

## 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/>.


