From 435037e2d4a2a068598197b2e0f7248cb698ef82 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Mon, 6 Jul 2020 22:01:57 +0200 Subject: [PATCH 1/2] Improve installation instructions * Add simple instructions how to install the package * Move the list of supported devices to the end of the file Fixes #60 (hopefully) --- README.md | 75 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 46 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 724fa6735..dd3c58f1d 100644 --- a/README.md +++ b/README.md @@ -7,40 +7,23 @@ python-kasa is a Python library to control TPLink smart home devices (plugs, wall switches, power strips, and bulbs) using asyncio. This project is a maintainer-made fork of [pyHS100](https://github.com/GadgetReactor/pyHS100) project. +## Getting started -**Supported devices** - -* Plugs - * HS100 - * HS103 - * HS105 - * HS107 - * HS110 -* Power Strips - * HS300 - * KP303 -* Wall switches - * HS200 - * HS210 - * HS220 -* Bulbs - * LB100 - * LB110 - * LB120 - * LB130 - * LB230 - * KL60 - * KL110 - * KL120 - * KL130 - -**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests! See below for instructions for setting up a development environment.** - +You can install the most recent release using pip. Until +``` +pip install python-kasa --pre +``` +Alternatively, you can clone this repository and use poetry to install the development version: +``` +git clone https://github.com/python-kasa/python-kasa.git +cd python-kasa/ +poetry install +``` ## Discovering devices -The devices can be discovered either by using `kasa discover` or by calling `kasa` without any parameters. +After installation, the devices can be discovered either by using `kasa discover` or by calling `kasa` without any parameters. ``` $ kasa @@ -61,6 +44,8 @@ Location: {'latitude': XXXX, 'longitude': XXXX} Current state: {'total': 133.082, 'power': 100.418681, 'current': 0.510967, 'voltage': 225.600477} ``` +Use `kasa --help` to get list of all available commands. + ## Basic controls All devices support a variety of common commands, including: @@ -111,3 +96,35 @@ pre-commit install We use several tools to automatically check all contributions, which are run automatically when you commit your code. If you want to manually execute the checks, you can run `tox -e lint` to do the linting checks or `tox` to also execute the tests. + +## Supported devices + +### Plugs + +* HS100 +* HS103 +* HS105 +* HS107 +* HS110 + +### Power Strips +* HS300 +* KP303 + +### Wall switches +* HS200 +* HS210 +* HS220 + +### Bulbs +* LB100 +* LB110 +* LB120 +* LB130 +* LB230 +* KL60 +* KL110 +* KL120 +* KL130 + +**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests! See below for instructions for setting up a development environment.** From 5d1ff8b34c52cbf9d7b702475c5590d50ba306ca Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Mon, 6 Jul 2020 22:04:31 +0200 Subject: [PATCH 2/2] Remove 'see below for devenv instructions' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dd3c58f1d..d6891aaab 100644 --- a/README.md +++ b/README.md @@ -127,4 +127,4 @@ If you want to manually execute the checks, you can run `tox -e lint` to do the * KL120 * KL130 -**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests! See below for instructions for setting up a development environment.** +**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests!**