Skip to content

Update readme fixture checker and readme #699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rytilahti merged 1 commit into from
Jan 24, 2024
Merged

Update readme fixture checker and readme #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,13 @@ At the moment, the following devices have been confirmed to work:
#### Plugs

* Tapo P110
* Tapo P125M
* Tapo P135 (dimming not yet supported)

#### Bulbs

* Tapo L510B
* Tapo L510E
* Tapo L530E

#### Light strips
Expand Down Expand Up @@ -334,7 +336,7 @@ use it directly you should expect it could break in future releases until this s
Other TAPO libraries are:

* [PyTapo - Python library for communication with Tapo Cameras](https://github.com/JurajNyiri/pytapo)
* [Tapo P100 (Tapo P105/P100 plugs, Tapo L510E bulbs)](https://github.com/fishbigger/TapoP100)
* [Tapo P100 (Tapo plugs, Tapo bulbs)](https://github.com/fishbigger/TapoP100)
* [Home Assistant integration](https://github.com/fishbigger/HomeAssistant-Tapo-P100-Control)
* [plugp100, another tapo library](https://github.com/petretiandrea/plugp100)
* [Home Assistant integration](https://github.com/petretiandrea/home-assistant-tapo-p100)
6 changes: 4 additions & 2 deletions devtools/check_readme_vs_fixtures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Script that checks if README.md is missing devices that have fixtures."""
import re
import sys

from kasa.tests.conftest import (
Expand Down Expand Up @@ -32,10 +33,11 @@ def _get_device_type(dev, typemap):

found_unlisted = False
for dev in ALL_DEVICES:
if dev not in readme:
regex = rf"^\*.*\s{dev}"
match = re.search(regex, readme, re.MULTILINE)
if match is None:
print(f"{dev} not listed in {_get_device_type(dev, typemap)}")
found_unlisted = True


if found_unlisted:
sys.exit(-1)