Merge pull request #111 from kzosabe/develop

Release 0.4.1

Author: kzosabe

.github/workflows/main.yml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -32,7 +32,7 @@ jobs:
 
       - name: Load cached venv
         id: cached-poetry-dependencies
-        uses: actions/cache@v3.0.2
+        uses: actions/cache@v3.0.9
         with:
           path: .venv
           key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}

CHANGELOG.md

@@ -1,3 +1,13 @@
+0.4.1, 2022-10-22
+-------------------------
+
+- Add new devices
+  - Robot Vacuum Cleaner S1, Robot Vacuum Cleaner S1 Plus
+- Add information about upgrading to API v1.1
+  - The switchbot API has been updated from v1.0 to v1.1
+  - v1.0-compliant implementations will be finalized in this version,
+    and v1.1-compliant development will proceed in switchbot-client-1.x.x
+
 0.4.0, 2022-05-24
 -------------------------
 

README.md

@@ -8,6 +8,13 @@
 
 An unofficial Python client implementation of the SwitchBot API.
 
+## About this version
+
+switchbot-client-0.x.x is the implementation for [SwitchBot API version 1.0](https://github.com/OpenWonderLabs/SwitchBotAPI/blob/main/README-v1.0.md).
+The implementation for API version 1.1 or later will proceed with switchbot-client-1.x.x.
+Please select the library version according to the API version you use.
+Development of switchbot-client-0.x.x will likely cease with the SwitchBot API version update, and we recommend moving to 1.x.x.
+
 ## Table of Contents
 
 - [Authentication](#authentication)
@@ -31,7 +38,7 @@ this client will automatically use this value.
 
 ```shell
 export SWITCHBOT_OPEN_TOKEN=your_switchbot_open_token
-python3 your_script.py
+python your_script.py
 ```
 
 ```python
@@ -62,7 +69,7 @@ this client will automatically use the value.
 ```shell
 mkdir -p ~/.config/switchbot-client
 echo "token: your_switchbot_open_token" >>  ~/.config/switchbot-client/config.yml
-python3 your_script.py
+python your_script.py
 ```
 
 ```python

docs/conf.py

@@ -5,7 +5,7 @@
 project = "switchbot-client"
 copyright = "2021, kzosabe"
 author = "kzosabe"
-release = "0.4.0"
+release = "0.4.1"
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
 templates_path = ["_templates"]
 exclude_patterns = ["_build", ".DS_Store"]

docs/switchbot_client.rst

@@ -9,6 +9,7 @@ Subpackages
 
    switchbot_client.devices
    switchbot_client.scenes
+   switchbot_client.webhooks
 
 Submodules
 ----------

docs/switchbot_client.webhooks.rst

@@ -0,0 +1,21 @@
+switchbot\_client.webhooks package
+==================================
+
+Submodules
+----------
+
+switchbot\_client.webhooks.base module
+--------------------------------------
+
+.. automodule:: switchbot_client.webhooks.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: switchbot_client.webhooks
+   :members:
+   :undoc-members:
+   :show-inheritance: