Add all changes for 1.0.0 to master (#148)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Moritz <88738242+Moritz-Schmidt@users.noreply.github.com>
Co-authored-by: Malachi Soord <inverse.chi@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Erwin Douna <e.douna@gmail.com>
Co-authored-by: Michael Scott <micsco@gmail.com>

Author: 6 people

.vscode/settings.json

@@ -1,8 +1,14 @@
 {
     "python.linting.pylintEnabled": true,
     "cSpell.words": [
-        "Tado"
+        "Tado",
+        "Pythonize",
+        "pypi",
+        "pytado"
     ],
+    "python.linting.flake8Enabled": true,
+    "python.linting.enabled": true,
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
     "python.testing.pytestArgs": [
         "."
     ],

MigrationV1.0.0.md

@@ -0,0 +1,7 @@
+"""Factory method for easy initialization."""
+
+from ..interface.api.hops_tado import TadoX
+from ..interface.api.my_tado import Tado
+from .initializer import TadoClientInitializer
+
+__all__ = ["Tado", "TadoX", "TadoClientInitializer"]

PyTado/factory/__init__.py

@@ -0,0 +1,90 @@
+"""
+PyTado API factory to use app.tado.com or hops.tado.com
+"""
+
+from typing import Self
+
+import requests
+
+import PyTado.interface.api as API
+from PyTado.exceptions import TadoException
+from PyTado.http import DeviceActivationStatus, Http
+
+
+class TadoClientInitializer:
+    """Class to authenticate and get the Tado client."""
+
+    http: Http
+    debug: bool = False
+    token_file_path: str | None = None
+    saved_refresh_token: str | None = None
+    http_session: requests.Session | None = None
+
+    def __init__(
+        self,
+        token_file_path: str | None = None,
+        saved_refresh_token: str | None = None,
+        http_session: requests.Session | None = None,
+        debug: bool = False,
+    ):
+        self.token_file_path = token_file_path
+        self.saved_refresh_token = saved_refresh_token
+        self.http_session = http_session
+        self.debug = debug
+        self.http = Http(
+            token_file_path=token_file_path,
+            saved_refresh_token=saved_refresh_token,
+            http_session=http_session,
+            debug=debug,
+        )
+
+    def get_verification_url(self) -> str | None:
+        """Returns the URL for device verification."""
+        if self.http.device_activation_status == DeviceActivationStatus.NOT_STARTED:
+            self.device_activation()
+
+        return self.http.device_verification_url
+
+    def device_activation(self) -> Self:
+        """Activates the device.
+
+        Caution: this method will block until the device is activated or the timeout is reached.
+        """
+        self.http.device_activation()
+
+        return self
+
+    def get_client(self) -> API.TadoX | API.Tado:
+        """Returns the client instance after device activation."""
+        if self.http.device_activation_status == DeviceActivationStatus.COMPLETED:
+            if self.http.is_x_line:
+                return API.TadoX.from_http(http=self.http, debug=self.debug)
+
+            return API.Tado.from_http(http=self.http, debug=self.debug)
+
+        raise TadoException(
+            "Authentication failed. Please check the device verification URL and try again."
+        )
+
+    def authenticate_and_get_client(self) -> API.TadoX | API.Tado:
+        """Authenticate and get the client instance, prompting for device activation if needed."""
+        print("Starting device activation process...")
+        print("Device activation status: ", self.http.device_activation_status)
+
+        if self.http.device_activation_status != DeviceActivationStatus.COMPLETED:
+            print("Click on the link to log in to your Tado account.")
+            print("Device verification URL: ", self.get_verification_url())
+
+            self.device_activation()
+
+            if (
+                self.http.device_activation_status == DeviceActivationStatus.COMPLETED
+            ):  # pyright: ignore[reportUnnecessaryComparison]
+                print("Device activation completed successfully.")
+            else:
+                raise TadoException(
+                    "Device activation failed. "
+                    "Please check the device verification URL and try again."
+                )
+
+        return self.get_client()

PyTado/factory/initializer.py

@@ -100,7 +100,7 @@ class TadoXRequest(TadoRequest):
     def __post_init__(self) -> None:
         self._action = self.action
 
-    @property
+    @property  # type: ignore
     def action(self) -> Action | str:
         """Get request action for Tado X"""
         if self._action == Action.CHANGE:

PyTado/http.py

@@ -65,12 +65,10 @@ def log_failed_validation(
         cls, data: Any, handler: ModelWrapValidatorHandler[Self]
     ) -> Self:
         """Model validation debug helper.
-
         Logs in the following cases:
             - (Debug) Keys in data that are not in the model
             - (Debug) Keys in the model that are not in the data
             - (Error) Validation errors
-
         (This is just for debugging and development, can be removed if not needed anymore)
         """
         try:

PyTado/models/util.py

@@ -39,7 +39,6 @@
     from PyTado.interface.api.hops_tado import TadoX  # pragma: no cover
 
 _LOGGER = logging.getLogger(__name__)
-_LOGGER.setLevel(logging.DEBUG)
 
 
 @final

PyTado/zone/hops_zone.py

@@ -10,14 +10,14 @@ PyTado is a Python module implementing an interface to the Tado web API. It allo
 Tado heating system for the purposes of monitoring or controlling their heating system, beyond what Tado themselves
 currently offer.
 
-It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimise their
+It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimize their
 heating setups.
 
 ---
 
 Original author: Chris Jewell <chrism0dwk@gmail.com>
 
-Licence: GPL v3
+License: GPL v3
 
 Copyright: Chris Jewell 2016-2018
 
@@ -26,7 +26,7 @@ Copyright: Chris Jewell 2016-2018
 Besides owning a Tado system, I have no connection with the Tado company themselves. PyTado was created for my own use,
 and for others who may wish to experiment with personal Internet of Things systems. I receive no help (financial or
 otherwise) from Tado, and have no business interest with them. This software is provided without warranty, according to
-the GNU Public Licence version 3, and should therefore not be used where it may endanger life, financial stakes, or
+the GNU Public License version 3, and should therefore not be used where it may endanger life, financial stakes, or
 cause discomfort and inconvenience to others.
 
 ## Usage
@@ -54,7 +54,7 @@ It is possible to save the refresh token and reuse to skip the next login.
 
 The following code will use the `refresh_token` file to save the refresh-token after login, and load the refresh-token if you create the Tado interface class again.
 
-If the file doesn't exists, the webbrowser is started and the device authentication url is automatically opened. You can activate the device in the browser. When you restart the program, the refresh-token is reused and no webbrowser will be opened.
+If the file doesn't exists, the web browser is started and the device authentication url is automatically opened. You can activate the device in the browser. When you restart the program, the refresh-token is reused and no web browser will be opened.
 
 ```python
 import webbrowser   # only needed for direct web browser access
@@ -111,7 +111,6 @@ if __name__ == "__main__":
 Note: For developers, there is an `example.py` script in `examples/` which is configured to fetch data from your account.
 You can then invoke `python examples/example.py`.
 
-
 ## Contributing
 
 We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!
@@ -143,20 +142,7 @@ git clone https://github.com/yourusername/PyTado.git
 cd PyTado
 ```
 
-Then, to create your development environment and install the project with its dependencies, execute the following
-commands in your terminal:
-
-```bash
-# Create and activate a new virtual environment
-python3 -m venv venv
-source venv/bin/activate
-
-# install all dependencies
-poetry install
-
-# Install pre-commit hooks
-poetry run pre-commit install
-```
+Then, to create your development environment and install the project with its dependencies, execute the `./scripts/bootstrap` script.
 
 ### Coding Guidelines
 
@@ -195,6 +181,5 @@ A message from the original author:
 >
 > Chris Jewell
 
-
 [devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
 [devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/wmalgadey/PyTado

README.md

@@ -1,21 +1,14 @@
 """Example client for PyTado"""
 
-from PyTado.interface.interface import Tado
+from PyTado.factory import TadoClientInitializer
 
 
 def main() -> None:
     """Retrieve all zones, once successfully logged in"""
-    tado = Tado()
-
-    print("Device activation status: ", tado.device_activation_status())
-    print("Device verification URL: ", tado.device_verification_url())
-
-    print("Starting device activation")
-    tado.device_activation()
-
-    print("Device activation status: ", tado.device_activation_status())
+    tado = TadoClientInitializer().authenticate_and_get_client()
 
     zones = tado.get_zones()
+
     print(zones)