Add script to check supported devices, update README (#242)

* check_readme_vs_fixtures.py checks if a device with a fixture is listed in the README
* Add missing entries to README.md
This commit is contained in:
Teemu R
2021-10-25 09:17:35 +02:00
committed by GitHub
parent d75e1adaba
commit 8a4068c623
2 changed files with 30 additions and 0 deletions

View File

@@ -0,0 +1,25 @@
"""Script that checks if README.md is missing devices that have fixtures."""
from kasa.tests.conftest import ALL_DEVICES, BULBS, DIMMERS, LIGHT_STRIPS, PLUGS, STRIPS
readme = open("README.md").read()
typemap = {
"light strips": LIGHT_STRIPS,
"bulbs": BULBS,
"plugs": PLUGS,
"strips": STRIPS,
"dimmers": DIMMERS,
}
def _get_device_type(dev, typemap):
for typename, devs in typemap.items():
if dev in devs:
return typename
else:
return "Unknown type"
for dev in ALL_DEVICES:
if dev not in readme:
print(f"{dev} not listed in {_get_device_type(dev, typemap)}")