Skip to content

Commit f930f3c

Browse files
authored
Simplify readme (#1359)
1 parent 7af54d4 commit f930f3c

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,20 @@ This package is mainly used by Home Assistant Core, to offer the Overkiz integra
1313

1414
- Atlantic Cozytouch
1515
- Bouygues Flexom
16+
- Brandt Smart Control **\***
1617
- Hitachi Hi Kumo
1718
- Nexity Eugénie
18-
- Rexel Energeasy Connect
19+
- Rexel Energeasy Connect **\***
20+
- Sauter Cozytouch
1921
- Simu (LiveIn2)
2022
- Somfy Connexoon IO
2123
- Somfy Connexoon RTS
2224
- Somfy TaHoma
2325
- Somfy TaHoma Switch
2426
- Thermor Cozytouch
2527

28+
\[*] _These servers utilize an authentication method that is currently not supported by this library. To use this library with these servers, you will need to obtain an access token (by sniffing the original app) and create a local user on the Overkiz API platform._
29+
2630
## Installation
2731

2832
```bash
@@ -40,12 +44,13 @@ import time
4044

4145
from pyoverkiz.const import SUPPORTED_SERVERS
4246
from pyoverkiz.client import OverkizClient
47+
from pyoverkiz.enums import Server
4348

4449
USERNAME = ""
4550
PASSWORD = ""
4651

4752
async def main() -> None:
48-
async with OverkizClient(USERNAME, PASSWORD, server=SUPPORTED_SERVERS["somfy_europe"]) as client:
53+
async with OverkizClient(USERNAME, PASSWORD, server=SUPPORTED_SERVERS[Server.SOMFY_EUROPE]) as client:
4954
try:
5055
await client.login()
5156
except Exception as exception: # pylint: disable=broad-except
@@ -76,6 +81,7 @@ import aiohttp
7681

7782
from pyoverkiz.client import OverkizClient
7883
from pyoverkiz.const import SUPPORTED_SERVERS, OverkizServer
84+
from pyoverkiz.enums import Server
7985

8086
USERNAME = ""
8187
PASSWORD = ""
@@ -88,7 +94,7 @@ async def main() -> None:
8894
if not token:
8995
# Generate new token via Cloud API
9096
async with OverkizClient(
91-
username=USERNAME, password=PASSWORD, server=SUPPORTED_SERVERS["somfy_europe"]
97+
username=USERNAME, password=PASSWORD, server=SUPPORTED_SERVERS[Server.SOMFY_EUROPE]
9298
) as client:
9399

94100
await client.login()
@@ -139,23 +145,14 @@ asyncio.run(main())
139145

140146
## Development
141147

142-
### Devcontainer
148+
### DevContainer (recommended)
143149

144150
If you use Visual Studio Code with Docker or GitHub CodeSpaces, you can leverage the available devcontainer. This will install all required dependencies and tools and has the right Python version available. Easy!
145151

146152
### Manual
147-
- For Linux, install [pyenv](https://github.com/pyenv/pyenv) using [pyenv-installer](https://github.com/pyenv/pyenv-installer)
148-
- For MacOS, run `brew install pyenv`
149-
- Don't forget to update your `.bashrc` file (or similar):
150-
```
151-
export PATH="~/.pyenv/bin:$PATH"
152-
eval "$(pyenv init -)"
153-
```
154-
- Install the required [dependencies](https://github.com/pyenv/pyenv/wiki#suggested-build-environment)
153+
- Install Python 3.12
155154
- Install [poetry](https://python-poetry.org): `curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python`
156-
157155
- Clone this repository
158156
- `cd python-overkiz-api`
159-
- Install the required Python version: `pyenv install`
160157
- Init the project: `poetry install`
161158
- Run `poetry run pre-commit install`

0 commit comments

Comments
 (0)