File: README.md

package info (click to toggle)
pytedee-async 0.2.20-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 132 kB
  • sloc: python: 714; makefile: 7
file content (48 lines) | stat: -rw-r--r-- 1,257 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Python Tedee Async Client Package

This is a Tedee Lock Client package. It is an async implementation of [joerg65's original package](https://github.com/joerg65/pytedee.git).

## Install:
### From pip
```
pip install pytedee-async
```

### Locally
```python
pipenv install -e .
# or
python3 setup.py install
```

## Try it out
- Generate personal key. Instructions: https://tedee-tedee-api-doc.readthedocs-hosted.com/en/latest/howtos/authenticate.html#personal-access-key
  Minimal scopes required for enable integration are:
    - Devices.Read
    - Lock.Operate
- with `example.py`: Create a file `config.json` next to `example.py`:
```json
  {
  "personalToken": "<your token>"
  }
```
cd into the directory of those to files and run
```
python example.py
```

- Initiate an instance of `TedeeClient`
```python
from pytedee_async import TedeeClient

pk = "<your PersonalKey>"
# through init
client = TedeeClient(pk) # is initialized with no locks
client.get_locks() # get the locks

# through classmethod
# will initialize directly with all locks you have
client = await TedeeClient.create(pk)
```

- the locks are avialable in a dictionary `client.locks_dict` with the key of the dict being the serial number of each lock, or in a list `client.locks`