From 7bf5ee3e97ed6f93e495764941917d532ef504e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20BOU=C3=89?= Date: Sun, 15 Mar 2026 17:24:45 +0100 Subject: [PATCH] Add environment setup section and fix script path Updated the README to include environment setup instructions and correct script path. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d31bcbc..729736ac 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ Library to control Switchbot IoT devices https://www.switch-bot.com/bot +## Setting up the environment + +```shell +python3 -m venv .venv +source .venv/bin/activate +pip install . +``` + ## Obtaining encryption key for Switchbot Locks Using the script `scripts/get_encryption_key.py` you can manually obtain locks encryption key. @@ -9,7 +17,7 @@ Using the script `scripts/get_encryption_key.py` you can manually obtain locks e Usage: ```shell -$ python3 get_encryption_key.py MAC USERNAME +$ python3 scripts/get_encryption_key.py MAC USERNAME Key ID: XX Encryption key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ```