python-tado 0.18.4__tar.gz → 0.18.6__tar.gz

{python_tado-0.18.4/python_tado.egg-info → python_tado-0.18.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-tado
-Version: 0.18.4
+Version: 0.18.6
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
 Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -696,43 +696,145 @@ License-File: AUTHORS
 Requires-Dist: requests
 Provides-Extra: dev
 Requires-Dist: black>=24.3; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytype; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: requests; extra == "dev"
 Requires-Dist: responses; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: all
+Requires-Dist: python-tado[dev]; extra == "all"
 
-PyTado -- Pythonize your central heating
-========================================
+# PyTado -- Pythonize your central heating
 
-Author: Chris Jewell <chrism0dwk@gmail.com>  
-Modified: Wolfgang Malgadey <wolfgang@malgadey.de>
+[![Linting and testing](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml)
+[![Build and deploy to pypi](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml)
+[![PyPI version](https://badge.fury.io/py/python-tado.svg)](https://badge.fury.io/py/python-tado)
+
+PyTado is a Python module implementing an interface to the Tado web API. It allows a user to interact with their
+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
+heating setups.
+
+---
+
+Original author: Chris Jewell <chrism0dwk@gmail.com>  
 
 Licence: GPL v3
 
 Copyright: Chris Jewell 2016-2018
 
-PyTado is a Python module implementing an interface to the Tado web API.  It allows a user to interact with their Tado heating system for the purposes of monitoring or controlling their heating system, beyond what Tado themselves currently offer.
+## Disclaimer
 
-It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimise their heating setups.
+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
+cause discomfort and inconvenience to others.
 
-Disclaimer
-----------
-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 cause discomfort and inconvenience to others.
-
-Example basic usage
--------------------
+## Example basic usage
 
     >>> from PyTado.interface import Tado
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
-Development
------------
-This software is at a purely experimental stage.  If you're interested and can write Python, clone the Github repo, drop me a line, and get involved!
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
+## Contributing
+
+We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!
+
+You don't need to be a Python expert to provide meaningful improvements. To learn how to get started, check out our
+[Contributor Guidelines](https://github.com/wmalgadey/econnect-python/blob/main/CONTRIBUTING.md) first, and ask for help
+in [GitHub Discussions](https://github.com/wmalgadey/PyTado/discussions) if you have questions.
+
+## Development
+
+We welcome external contributions, even though the project was initially intended for personal use. If you think some
+parts could be exposed with a more generic interface, please open a [GitHub issue](https://github.com/wmalgadey/PyTado/issues)
+to discuss your suggestion.
+
+### Dev Environment
+
+To contribute to this repository, you should first clone your fork and then setup your development environment. Clone
+your repository as follows (replace yourusername with your GitHub account name):
+
+```bash
+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
+
+# Upgrade pip and install all projects and their dependencies
+pip install --upgrade pip
+pip install -e '.[all]'
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Coding Guidelines
+
+To maintain a consistent codebase, we utilize [black][1]. Consistency is crucial as it helps readability, reduces errors,
+and facilitates collaboration among developers.
+
+To ensure that every commit adheres to our coding standards, we've integrated [pre-commit hooks][2]. These hooks
+automatically run `black` before each commit, ensuring that all code changes are automatically checked and formatted.
+
+For details on how to set up your development environment to make use of these hooks, please refer to the
+[Development][3] section of our documentation.
+
+[1]: https://github.com/ambv/black
+[2]: https://pre-commit.com/
+[3]: https://github.com/wmalgadey/PyTado#development
+
+### Testing
+
+Ensuring the robustness and reliability of our code is paramount. Therefore, all contributions must include at least one
+test to verify the intended behavior.
+
+To run tests locally, execute the test suite using `pytest` with the following command:
+
+```bash
+pytest tests/ --cov --cov-branch -vv
+```
+
+---
 
-Best wishes and a warm winter to all!
+A message from the original author:
 
-Chris Jewell
+> This software is at a purely experimental stage. If you're interested and can write Python, clone the Github repo,
+> drop me a line, and get involved!
+>
+> Best wishes and a warm winter to all!
+>
+> Chris Jewell

{python_tado-0.18.4 → python_tado-0.18.6}/PyTado/http.py

@@ -8,6 +8,7 @@ import logging
 import pprint
 from datetime import datetime, timedelta
 from typing import Any
+from urllib.parse import urlencode
 
 import requests
 
@@ -27,6 +28,7 @@ class Endpoint(enum.StrEnum):
     EIQ = "https://energy-insights.tado.com/api/"
     TARIFF = "https://tariff-experience.tado.com/api/"
     GENIE = "https://genie.tado.com/api/v2/"
+    MINDER = "https://minder.tado.com/v1/"
 
 
 class Domain(enum.StrEnum):
@@ -65,6 +67,7 @@ class TadoRequest:
         domain: Domain = Domain.HOME,
         device: int | None = None,
         mode: Mode = Mode.OBJECT,
+        params: dict[str, Any] | None = None,
     ):
         self.endpoint = endpoint
         self.command = command
@@ -73,6 +76,7 @@ class TadoRequest:
         self.domain = domain
         self.device = device
         self.mode = mode
+        self.params = params
 
 
 class TadoXRequest(TadoRequest):
@@ -87,6 +91,7 @@ class TadoXRequest(TadoRequest):
         domain: Domain = Domain.HOME,
         device: int | None = None,
         mode: Mode = Mode.OBJECT,
+        params: dict[str, Any] | None = None,
     ):
         super().__init__(
             endpoint=endpoint,
@@ -96,6 +101,7 @@ class TadoXRequest(TadoRequest):
             domain=domain,
             device=device,
             mode=mode,
+            params=params,
         )
         self._action = action
 
@@ -214,6 +220,8 @@ class Http:
             url = f"{request.endpoint}{request.domain}/{request.device}/{request.command}"
         elif request.domain == Domain.ME:
             url = f"{request.endpoint}{request.domain}"
+        elif request.endpoint == Endpoint.MINDER:
+            url = f"{request.endpoint}{request.domain}/{self.id:d}/{request.command}?{urlencode(request.params)}"
         else:
             url = f"{request.endpoint}{request.domain}/{self._id:d}/{request.command}"
         return url

{python_tado-0.18.4 → python_tado-0.18.6}/PyTado/interface/api/hops_tado.py

@@ -335,3 +335,15 @@ class TadoX(Tado):
         request.payload = {"temperatureOffset": offset}
 
         return self._http.request(request)
+
+    def set_child_lock(self, device_id, child_lock):
+        """ "
+        Set and toggle the child lock on the device.
+        """
+
+        request = TadoXRequest()
+        request.command = f"roomsAndDevices/devices/{device_id}"
+        request.action = Action.CHANGE
+        request.payload = {"childLockEnabled": child_lock}
+
+        self._http.request(request)

{python_tado-0.18.4 → python_tado-0.18.6}/PyTado/interface/api/my_tado.py

@@ -424,6 +424,20 @@ class Tado:
 
         self._http.request(request)
 
+    def set_child_lock(self, device_id, child_lock) -> None:
+        """
+        Sets the child lock on a device
+        """
+
+        request = TadoRequest()
+        request.command = "childLock"
+        request.action = Action.CHANGE
+        request.device = device_id
+        request.domain = Domain.DEVICES
+        request.payload = {"childLockEnabled": child_lock}
+
+        self._http.request(request)
+
     def set_auto(self) -> None:
         """
         Sets HomeState to AUTO
@@ -621,3 +635,18 @@ class Tado:
         request.payload = {"circuitNumber": heating_circuit}
 
         return self._http.request(request)
+
+    def get_running_times(
+        self, date=datetime.datetime.now().strftime("%Y-%m-%d")
+    ) -> dict:
+        """
+        Get the running times from the Minder API
+        """
+
+        request = TadoRequest()
+        request.command = "runningTimes"
+        request.action = Action.GET
+        request.endpoint = Endpoint.MINDER
+        request.params = {"from": date}
+
+        return self._http.request(request)

python_tado-0.18.6/PyTado/interface/interface.py

@@ -0,0 +1,303 @@
+"""
+PyTado interface abstraction to use app.tado.com or hops.tado.com
+"""
+
+import datetime
+import warnings
+import functools
+
+from PyTado.http import Http
+import PyTado.interface.api as API
+
+
+def deprecated(new_func_name):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                f"The '{func.__name__}' method is deprecated, use '{new_func_name}' instead. "
+                "Deprecated methods will be removed with 1.0.0.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return getattr(args[0], new_func_name)(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+class Tado:
+    """Interacts with a Tado thermostat via public API.
+
+    Example usage: t = Tado('me@somewhere.com', 'mypasswd')
+                   t.get_climate(1) # Get climate, zone 1.
+    """
+
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        http_session=None,
+        debug: bool = False,
+    ):
+        """Class Constructor"""
+
+        self._http = Http(
+            username=username,
+            password=password,
+            http_session=http_session,
+            debug=debug,
+        )
+
+        if self._http.is_x_line:
+            self._api = API.TadoX(http=self._http, debug=debug)
+        else:
+            self._api = API.Tado(http=self._http, debug=debug)
+
+    def __getattr__(self, name):
+        """Delegiert den Aufruf von Methoden an die richtige API-Client-Implementierung."""
+        return getattr(self._api, name)
+
+    # region Deprecated Methods
+    # pylint: disable=invalid-name
+
+    @deprecated("get_me")
+    def getMe(self):
+        """Gets home information. (deprecated)"""
+        return self.get_me()
+
+    @deprecated("get_devices")
+    def getDevices(self):
+        """Gets device information. (deprecated)"""
+        return self.get_devices()
+
+    @deprecated("get_zones")
+    def getZones(self):
+        """Gets zones information. (deprecated)"""
+        return self.get_zones()
+
+    @deprecated("set_child_lock")
+    def setChildLock(self, device_id, enabled):
+        """Set the child lock for a device"""
+        return self.set_child_lock(device_id, enabled)
+
+    @deprecated("get_zone_state")
+    def getZoneState(self, zone):
+        """Gets current state of Zone as a TadoZone object. (deprecated)"""
+        return self.get_zone_state(zone)
+
+    @deprecated("get_zone_states")
+    def getZoneStates(self):
+        """Gets current states of all zones. (deprecated)"""
+        return self.get_zone_states()
+
+    @deprecated("get_state")
+    def getState(self, zone):
+        """Gets current state of Zone. (deprecated)"""
+        return self.get_state(zone)
+
+    @deprecated("get_home_state")
+    def getHomeState(self):
+        """Gets current state of Home. (deprecated)"""
+        return self.get_home_state()
+
+    @deprecated("get_auto_geofencing_supported")
+    def getAutoGeofencingSupported(self):
+        """Return whether the Tado Home supports auto geofencing (deprecated)"""
+        return self.get_auto_geofencing_supported()
+
+    @deprecated("get_capabilities")
+    def getCapabilities(self, zone):
+        """Gets current capabilities of Zone zone. (deprecated)"""
+        return self.get_capabilities(zone)
+
+    @deprecated("get_climate")
+    def getClimate(self, zone):
+        """Gets temp (centigrade) and humidity (% RH) for Zone zone. (deprecated)"""
+        return self.get_climate(zone)
+
+    @deprecated("get_timetable")
+    def getTimetable(self, zone):
+        """Get the Timetable type currently active (Deprecated)"""
+        return self.get_timetable(zone)
+
+    @deprecated("get_historic")
+    def getHistoric(self, zone, date):
+        """Gets historic information on given date for zone. (Deprecated)"""
+        return self.get_historic(zone, date)
+
+    @deprecated("set_timetable")
+    def setTimetable(self, zone, _id):
+        """Set the Timetable type currently active (Deprecated)
+        id = 0 : ONE_DAY (MONDAY_TO_SUNDAY)
+        id = 1 : THREE_DAY (MONDAY_TO_FRIDAY, SATURDAY, SUNDAY)
+        id = 3 : SEVEN_DAY (MONDAY, TUESDAY, WEDNESDAY ...)"""
+        return self.set_timetable(zone, _id)
+
+    @deprecated("get_schedule")
+    def getSchedule(self, zone, _id, day=None):
+        """Get the JSON representation of the schedule for a zone. Zone has 3 different schedules,
+        one for each timetable (see setTimetable)"""
+        return self.get_schedule(zone, _id, day)
+
+    @deprecated("set_schedule")
+    def setSchedule(self, zone, _id, day, data):
+        """Set the schedule for a zone, day is required"""
+        return self.set_schedule(zone, _id, day, data)
+
+    @deprecated("get_weather")
+    def getWeather(self):
+        """Gets outside weather data (Deprecated)"""
+        return self.get_weather()
+
+    @deprecated("get_air_comfort")
+    def getAirComfort(self):
+        """Gets air quality information (Deprecated)"""
+        return self.get_air_comfort()
+
+    @deprecated("get_users")
+    def getAppUsers(self):
+        """Gets getAppUsers data (deprecated)"""
+        return self.get_app_user()
+
+    @deprecated("get_mobile_devices")
+    def getMobileDevices(self):
+        """Gets information about mobile devices (Deprecated)"""
+        return self.get_mobile_devices()
+
+    @deprecated("reset_zone_overlay")
+    def resetZoneOverlay(self, zone):
+        """Delete current overlay (Deprecated)"""
+        return self.reset_zone_overlay(zone)
+
+    @deprecated("set_zone_overlay")
+    def setZoneOverlay(
+        self,
+        zone,
+        overlayMode,
+        setTemp=None,
+        duration=None,
+        deviceType="HEATING",
+        power="ON",
+        mode=None,
+        fanSpeed=None,
+        swing=None,
+        fanLevel=None,
+        verticalSwing=None,
+        horizontalSwing=None,
+    ):
+        """Set current overlay for a zone (Deprecated)"""
+        return self.set_zone_overlay(
+            zone,
+            overlay_mode=overlayMode,
+            set_temp=setTemp,
+            duration=duration,
+            device_type=deviceType,
+            power=power,
+            mode=mode,
+            fan_speed=fanSpeed,
+            swing=swing,
+            fan_level=fanLevel,
+            vertical_swing=verticalSwing,
+            horizontal_swing=horizontalSwing,
+        )
+
+    @deprecated("get_zone_overlay_default")
+    def getZoneOverlayDefault(self, zone):
+        """Get current overlay default settings for zone. (Deprecated)"""
+        return self.get_zone_overlay_default(zone)
+
+    @deprecated("set_home")
+    def setHome(self):
+        """Sets HomeState to HOME (Deprecated)"""
+        return self.set_home()
+
+    @deprecated("set_away")
+    def setAway(self):
+        """Sets HomeState to AWAY  (Deprecated)"""
+        return self.set_away()
+
+    @deprecated("change_presence")
+    def changePresence(self, presence):
+        """Sets HomeState to presence (Deprecated)"""
+        return self.change_presence(presence=presence)
+
+    @deprecated("set_auto")
+    def setAuto(self):
+        """Sets HomeState to AUTO (Deprecated)"""
+        return self.set_auto()
+
+    @deprecated("get_window_state")
+    def getWindowState(self, zone):
+        """Returns the state of the window for zone (Deprecated)"""
+        return self.get_window_state(zone=zone)
+
+    @deprecated("get_open_window_detected")
+    def getOpenWindowDetected(self, zone):
+        """Returns whether an open window is detected. (Deprecated)"""
+        return self.get_open_window_detected(zone=zone)
+
+    @deprecated("set_open_window")
+    def setOpenWindow(self, zone):
+        """Sets the window in zone to open (Deprecated)"""
+        return self.set_open_window(zone=zone)
+
+    @deprecated("reset_open_window")
+    def resetOpenWindow(self, zone):
+        """Sets the window in zone to closed (Deprecated)"""
+        return self.reset_open_window(zone=zone)
+
+    @deprecated("get_device_info")
+    def getDeviceInfo(self, device_id, cmd=""):
+        """Gets information about devices
+        with option to get specific info i.e. cmd='temperatureOffset' (Deprecated)
+        """
+        return self.get_device_info(device_id=device_id, cmd=cmd)
+
+    @deprecated("set_temp_offset")
+    def setTempOffset(self, device_id, offset=0, measure="celsius"):
+        """Set the Temperature offset on the device. (Deprecated)"""
+        return self.set_temp_offset(
+            device_id=device_id, offset=offset, measure=measure
+        )
+
+    @deprecated("get_eiq_tariffs")
+    def getEIQTariffs(self):
+        """Get Energy IQ tariff history (Deprecated)"""
+        return self.get_eiq_tariffs()
+
+    @deprecated("get_eiq_meter_readings")
+    def getEIQMeterReadings(self):
+        """Get Energy IQ meter readings (Deprecated)"""
+        return self.get_eiq_meter_readings()
+
+    @deprecated("set_eiq_meter_readings")
+    def setEIQMeterReadings(
+        self, date=datetime.datetime.now().strftime("%Y-%m-%d"), reading=0
+    ):
+        """Send Meter Readings to Tado, date format is YYYY-MM-DD, reading is without decimals (Deprecated)"""
+        return self.set_eiq_meter_readings(date=date, reading=reading)
+
+    @deprecated("set_eiq_tariff")
+    def setEIQTariff(
+        self,
+        from_date=datetime.datetime.now().strftime("%Y-%m-%d"),
+        to_date=datetime.datetime.now().strftime("%Y-%m-%d"),
+        tariff=0,
+        unit="m3",
+        is_period=False,
+    ):
+        """Send Tariffs to Tado, date format is YYYY-MM-DD,
+        tariff is with decimals, unit is either m3 or kWh, set is_period to true to set a period of price (Deprecated)
+        """
+        return self.set_eiq_tariff(
+            from_date=from_date,
+            to_date=to_date,
+            tariff=tariff,
+            unit=unit,
+            is_period=is_period,
+        )
+
+    # pylint: enable=invalid-name
+    # endregion

python_tado-0.18.6/README.md

@@ -0,0 +1,130 @@
+# PyTado -- Pythonize your central heating
+
+[![Linting and testing](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml)
+[![Build and deploy to pypi](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml)
+[![PyPI version](https://badge.fury.io/py/python-tado.svg)](https://badge.fury.io/py/python-tado)
+
+PyTado is a Python module implementing an interface to the Tado web API. It allows a user to interact with their
+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
+heating setups.
+
+---
+
+Original author: Chris Jewell <chrism0dwk@gmail.com>  
+
+Licence: GPL v3
+
+Copyright: Chris Jewell 2016-2018
+
+## Disclaimer
+
+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
+cause discomfort and inconvenience to others.
+
+## Example basic usage
+
+    >>> from PyTado.interface import Tado
+    >>> t = Tado('my@username.com', 'mypassword')
+    >>> climate = t.get_climate(zone=1)
+
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
+## Contributing
+
+We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!
+
+You don't need to be a Python expert to provide meaningful improvements. To learn how to get started, check out our
+[Contributor Guidelines](https://github.com/wmalgadey/econnect-python/blob/main/CONTRIBUTING.md) first, and ask for help
+in [GitHub Discussions](https://github.com/wmalgadey/PyTado/discussions) if you have questions.
+
+## Development
+
+We welcome external contributions, even though the project was initially intended for personal use. If you think some
+parts could be exposed with a more generic interface, please open a [GitHub issue](https://github.com/wmalgadey/PyTado/issues)
+to discuss your suggestion.
+
+### Dev Environment
+
+To contribute to this repository, you should first clone your fork and then setup your development environment. Clone
+your repository as follows (replace yourusername with your GitHub account name):
+
+```bash
+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
+
+# Upgrade pip and install all projects and their dependencies
+pip install --upgrade pip
+pip install -e '.[all]'
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Coding Guidelines
+
+To maintain a consistent codebase, we utilize [black][1]. Consistency is crucial as it helps readability, reduces errors,
+and facilitates collaboration among developers.
+
+To ensure that every commit adheres to our coding standards, we've integrated [pre-commit hooks][2]. These hooks
+automatically run `black` before each commit, ensuring that all code changes are automatically checked and formatted.
+
+For details on how to set up your development environment to make use of these hooks, please refer to the
+[Development][3] section of our documentation.
+
+[1]: https://github.com/ambv/black
+[2]: https://pre-commit.com/
+[3]: https://github.com/wmalgadey/PyTado#development
+
+### Testing
+
+Ensuring the robustness and reliability of our code is paramount. Therefore, all contributions must include at least one
+test to verify the intended behavior.
+
+To run tests locally, execute the test suite using `pytest` with the following command:
+
+```bash
+pytest tests/ --cov --cov-branch -vv
+```
+
+---
+
+A message from the original author:
+
+> This software is at a purely experimental stage. If you're interested and can write Python, clone the Github repo,
+> drop me a line, and get involved!
+>
+> Best wishes and a warm winter to all!
+>
+> Chris Jewell

{python_tado-0.18.4 → python_tado-0.18.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-tado"
-version = "0.18.4"
+version = "0.18.6"
 description = "PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem"
 authors = [
     { name = "Chris Jewell", email = "chrism0dwk@gmail.com" },
@@ -31,7 +31,11 @@ classifiers = [
 GitHub = "https://github.com/wmalgadey/PyTado"
 
 [project.optional-dependencies]
-dev = ["black>=24.3", "pytype", "pylint", "types-requests", "responses", "coverage", "pytest", "pytest-cov"]
+dev = ["black>=24.3", "pre-commit", "pytype", "pylint", "types-requests", "requests", "responses", "coverage", "pytest", "pytest-cov"]
+
+all = [
+  "python-tado[dev]",
+]
 
 [project.scripts]
 pytado = "pytado.__main__:main"

{python_tado-0.18.4 → python_tado-0.18.6/python_tado.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-tado
-Version: 0.18.4
+Version: 0.18.6
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
 Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -696,43 +696,145 @@ License-File: AUTHORS
 Requires-Dist: requests
 Provides-Extra: dev
 Requires-Dist: black>=24.3; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytype; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: requests; extra == "dev"
 Requires-Dist: responses; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: all
+Requires-Dist: python-tado[dev]; extra == "all"
 
-PyTado -- Pythonize your central heating
-========================================
+# PyTado -- Pythonize your central heating
 
-Author: Chris Jewell <chrism0dwk@gmail.com>  
-Modified: Wolfgang Malgadey <wolfgang@malgadey.de>
+[![Linting and testing](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml)
+[![Build and deploy to pypi](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml)
+[![PyPI version](https://badge.fury.io/py/python-tado.svg)](https://badge.fury.io/py/python-tado)
+
+PyTado is a Python module implementing an interface to the Tado web API. It allows a user to interact with their
+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
+heating setups.
+
+---
+
+Original author: Chris Jewell <chrism0dwk@gmail.com>  
 
 Licence: GPL v3
 
 Copyright: Chris Jewell 2016-2018
 
-PyTado is a Python module implementing an interface to the Tado web API.  It allows a user to interact with their Tado heating system for the purposes of monitoring or controlling their heating system, beyond what Tado themselves currently offer.
+## Disclaimer
 
-It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimise their heating setups.
+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
+cause discomfort and inconvenience to others.
 
-Disclaimer
-----------
-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 cause discomfort and inconvenience to others.
-
-Example basic usage
--------------------
+## Example basic usage
 
     >>> from PyTado.interface import Tado
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
-Development
------------
-This software is at a purely experimental stage.  If you're interested and can write Python, clone the Github repo, drop me a line, and get involved!
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
+## Contributing
+
+We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!
+
+You don't need to be a Python expert to provide meaningful improvements. To learn how to get started, check out our
+[Contributor Guidelines](https://github.com/wmalgadey/econnect-python/blob/main/CONTRIBUTING.md) first, and ask for help
+in [GitHub Discussions](https://github.com/wmalgadey/PyTado/discussions) if you have questions.
+
+## Development
+
+We welcome external contributions, even though the project was initially intended for personal use. If you think some
+parts could be exposed with a more generic interface, please open a [GitHub issue](https://github.com/wmalgadey/PyTado/issues)
+to discuss your suggestion.
+
+### Dev Environment
+
+To contribute to this repository, you should first clone your fork and then setup your development environment. Clone
+your repository as follows (replace yourusername with your GitHub account name):
+
+```bash
+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
+
+# Upgrade pip and install all projects and their dependencies
+pip install --upgrade pip
+pip install -e '.[all]'
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Coding Guidelines
+
+To maintain a consistent codebase, we utilize [black][1]. Consistency is crucial as it helps readability, reduces errors,
+and facilitates collaboration among developers.
+
+To ensure that every commit adheres to our coding standards, we've integrated [pre-commit hooks][2]. These hooks
+automatically run `black` before each commit, ensuring that all code changes are automatically checked and formatted.
+
+For details on how to set up your development environment to make use of these hooks, please refer to the
+[Development][3] section of our documentation.
+
+[1]: https://github.com/ambv/black
+[2]: https://pre-commit.com/
+[3]: https://github.com/wmalgadey/PyTado#development
+
+### Testing
+
+Ensuring the robustness and reliability of our code is paramount. Therefore, all contributions must include at least one
+test to verify the intended behavior.
+
+To run tests locally, execute the test suite using `pytest` with the following command:
+
+```bash
+pytest tests/ --cov --cov-branch -vv
+```
+
+---
 
-Best wishes and a warm winter to all!
+A message from the original author:
 
-Chris Jewell
+> This software is at a purely experimental stage. If you're interested and can write Python, clone the Github repo,
+> drop me a line, and get involved!
+>
+> Best wishes and a warm winter to all!
+>
+> Chris Jewell

{python_tado-0.18.4 → python_tado-0.18.6}/python_tado.egg-info/requires.txt

@@ -1,10 +1,15 @@
 requests
 
+[all]
+python-tado[dev]
+
 [dev]
 black>=24.3
+pre-commit
 pytype
 pylint
 types-requests
+requests
 responses
 coverage
 pytest

{python_tado-0.18.4 → python_tado-0.18.6}/tests/test_my_tado.py

@@ -79,3 +79,16 @@ class TadoTestCase(unittest.TestCase):
         with mock.patch("PyTado.http.Http.request"):
             with self.assertRaises(Exception):
                 self.tado_client.set_auto()
+
+    def test_get_running_times(self):
+        """Test the get_running_times method."""
+
+        with mock.patch(
+            "PyTado.http.Http.request",
+            return_value=json.loads(common.load_fixture("running_times.json")),
+        ):
+            running_times = self.tado_client.get_running_times("2023-08-01")
+
+            assert self.tado_client._http.request.called
+            assert running_times["lastUpdated"] == "2023-08-05T19:50:21Z"
+            assert running_times["runningTimes"][0]["zones"][0]["id"] == 1

python_tado-0.18.4/PyTado/interface/interface.py

@@ -1,39 +0,0 @@
-"""
-PyTado interface abstraction to use app.tado.com or hops.tado.com
-"""
-
-from PyTado.http import Http
-import PyTado.interface.api as API
-
-
-class Tado:
-    """Interacts with a Tado thermostat via public API.
-
-    Example usage: t = Tado('me@somewhere.com', 'mypasswd')
-                   t.get_climate(1) # Get climate, zone 1.
-    """
-
-    def __init__(
-        self,
-        username: str,
-        password: str,
-        http_session=None,
-        debug: bool = False,
-    ):
-        """Class Constructor"""
-
-        self._http = Http(
-            username=username,
-            password=password,
-            http_session=http_session,
-            debug=debug,
-        )
-
-        if self._http.is_x_line:
-            self._api = API.TadoX(http=self._http, debug=debug)
-        else:
-            self._api = API.Tado(http=self._http, debug=debug)
-
-    def __getattr__(self, name):
-        """Delegiert den Aufruf von Methoden an die richtige API-Client-Implementierung."""
-        return getattr(self._api, name)

python_tado-0.18.4/README.md

@@ -1,32 +0,0 @@
-PyTado -- Pythonize your central heating
-========================================
-
-Author: Chris Jewell <chrism0dwk@gmail.com>  
-Modified: Wolfgang Malgadey <wolfgang@malgadey.de>
-
-Licence: GPL v3
-
-Copyright: Chris Jewell 2016-2018
-
-PyTado is a Python module implementing an interface to the Tado web API.  It allows a user to interact with their 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 heating setups.
-
-Disclaimer
-----------
-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 cause discomfort and inconvenience to others.
-
-Example basic usage
--------------------
-
-    >>> from PyTado.interface import Tado
-    >>> t = Tado('my@username.com', 'mypassword')
-    >>> climate = t.get_climate(zone=1)
-
-Development
------------
-This software is at a purely experimental stage.  If you're interested and can write Python, clone the Github repo, drop me a line, and get involved!
-
-Best wishes and a warm winter to all!
-
-Chris Jewell