weheat 2025.1.14rc1__tar.gz → 2025.1.15rc2__tar.gz

weheat-2025.1.15rc2/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.2
+Name: weheat
+Version: 2025.1.15rc2
+Summary: Weheat Backend client
+Home-page: https://github.com/wefabricate/wh-python
+Author: Jesper Raemaekers
+Author-email: jesper.raemaekers@wefabricate.com
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,Weheat Backend
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: aiohttp>=3.0.0
+Requires-Dist: aiohttp-retry>=2.8.3
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# Weheat backend client
+
+This is a client for the Weheat backend. It is automatically generated from the OpenAPI specification.
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+You can install directly using:
+
+```sh
+pip install weheat
+```
+
+Then import the package:
+
+```python
+import weheat
+```
+
+
+
+## Getting Started
+
+After installation, you can now use the client to interact with the Weheat backend. Note that all methods are async as of version 2025.1.15.
+
+```python
+import asyncio
+import datetime
+from keycloak import KeycloakOpenID  # install with pip install python-keycloak
+from weheat import ApiClient, Configuration, HeatPumpApi, HeatPumpLogApi, EnergyLogApi, UserApi
+
+auth_url = 'https://auth.weheat.nl/auth/'
+api_url = 'https://api.weheat.nl'
+realm_name = 'Weheat'
+my_client_id = 'WeheatCommunityAPI' # client ID and secret provided by Weheat
+my_client_secret = ''
+username = '' # username and password used for the online portal
+password = ''
+my_heat_pump_id = '' # your heat pump UUID
+
+
+async def demo():
+    keycloak_open_id = KeycloakOpenID(server_url=auth_url,
+                                      client_id=my_client_id,
+                                      realm_name=realm_name,
+                                      client_secret_key=my_client_secret)
+
+    token_response = keycloak_open_id.token(username, password)
+    keycloak_open_id.logout(token_response['refresh_token'])
+
+    config = Configuration(host=api_url, access_token=token_response['access_token'])
+    async with ApiClient(configuration=config) as client:
+        response = await UserApi(client).api_v1_users_me_get_with_http_info()
+
+        if response.status_code == 200:
+            print(f'My user: {response.data}')
+
+        response = await HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info()
+
+        if response.status_code == 200:
+            print(f'My heat pump: {response.data}')
+
+        response = await HeatPumpLogApi(client).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
+            heat_pump_id=my_heat_pump_id)
+
+        if response.status_code == 200:
+            print(f'My heat pump logs: {response.data}')
+
+        response = await EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=my_heat_pump_id,
+                                                                                     start_time=datetime.datetime(2024, 6,
+                                                                                                                  22, 0, 0,
+                                                                                                                  0),
+                                                                                     end_time=datetime.datetime(2024, 6, 22,
+                                                                                                                15, 0, 0),
+                                                                                     interval='Hour')
+
+        if response.status_code == 200:
+            print(f'My energy logs: {response.data}')
+
+asyncio.get_event_loop().run_until_complete(demo())
+
+```
+
+
+

weheat-2025.1.15rc2/README.md

@@ -0,0 +1,88 @@
+# Weheat backend client
+
+This is a client for the Weheat backend. It is automatically generated from the OpenAPI specification.
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+You can install directly using:
+
+```sh
+pip install weheat
+```
+
+Then import the package:
+
+```python
+import weheat
+```
+
+
+
+## Getting Started
+
+After installation, you can now use the client to interact with the Weheat backend. Note that all methods are async as of version 2025.1.15.
+
+```python
+import asyncio
+import datetime
+from keycloak import KeycloakOpenID  # install with pip install python-keycloak
+from weheat import ApiClient, Configuration, HeatPumpApi, HeatPumpLogApi, EnergyLogApi, UserApi
+
+auth_url = 'https://auth.weheat.nl/auth/'
+api_url = 'https://api.weheat.nl'
+realm_name = 'Weheat'
+my_client_id = 'WeheatCommunityAPI' # client ID and secret provided by Weheat
+my_client_secret = ''
+username = '' # username and password used for the online portal
+password = ''
+my_heat_pump_id = '' # your heat pump UUID
+
+
+async def demo():
+    keycloak_open_id = KeycloakOpenID(server_url=auth_url,
+                                      client_id=my_client_id,
+                                      realm_name=realm_name,
+                                      client_secret_key=my_client_secret)
+
+    token_response = keycloak_open_id.token(username, password)
+    keycloak_open_id.logout(token_response['refresh_token'])
+
+    config = Configuration(host=api_url, access_token=token_response['access_token'])
+    async with ApiClient(configuration=config) as client:
+        response = await UserApi(client).api_v1_users_me_get_with_http_info()
+
+        if response.status_code == 200:
+            print(f'My user: {response.data}')
+
+        response = await HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info()
+
+        if response.status_code == 200:
+            print(f'My heat pump: {response.data}')
+
+        response = await HeatPumpLogApi(client).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
+            heat_pump_id=my_heat_pump_id)
+
+        if response.status_code == 200:
+            print(f'My heat pump logs: {response.data}')
+
+        response = await EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=my_heat_pump_id,
+                                                                                     start_time=datetime.datetime(2024, 6,
+                                                                                                                  22, 0, 0,
+                                                                                                                  0),
+                                                                                     end_time=datetime.datetime(2024, 6, 22,
+                                                                                                                15, 0, 0),
+                                                                                     interval='Hour')
+
+        if response.status_code == 200:
+            print(f'My energy logs: {response.data}')
+
+asyncio.get_event_loop().run_until_complete(demo())
+
+```
+
+
+

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "weheat"
-version = "2025.1.14rc1"
+version = "2025.1.15rc2"
 description = "Weheat Backend"
 authors = ["Jesper Raemaekers <jesper.raemaekers@wefabricate.com>", "Kjell van Straaten <kjell.van.straaten@wefabricate.com>"]
 license = "MIT"
@@ -14,8 +14,10 @@ python = "^3.7"
 
 urllib3 = ">= 1.25.3"
 python-dateutil = ">=2.8.2"
-pydantic = ">=1.10.5, < 3"
-aenum = ">=3.1.11"
+aiohttp = ">= 3.8.4"
+aiohttp-retry = ">= 2.8.3"
+pydantic = ">=2"
+typing-extensions = ">=4.7.1"
 
 [tool.poetry.dev-dependencies]
 pytest = ">=7.2.1"

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/setup.cfg

@@ -1,9 +1,6 @@
 [flake8]
 max-line-length = 99
 
-[metadata]
-license_files = LICENSE
-
 [egg_info]
 tag_build = 
 tag_date = 0

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/setup.py

@@ -21,14 +21,15 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "weheat"
-VERSION = "2025.1.14rc1"
+VERSION = "2025.1.15rc2"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",
     "python-dateutil",
-    "pydantic >= 1.10.5, < 3",
-    "aenum",
-    "aiohttp"
+    "aiohttp >= 3.0.0",
+    "aiohttp-retry >= 2.8.3",
+    "pydantic >= 2",
+    "typing-extensions >= 4.7.1",
 ]
 
 setup(
@@ -46,5 +47,5 @@ setup(
     long_description=pathlib.Path("README.md").read_text(),  # noqa: E501
     package_data={"weheat": ["py.typed"]},
     license="MIT",
-    license_files = ('LICENSE',),
+    license_files=('LICENSE',),
 )

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/weheat/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "2024.07.08"
+__version__ = "2024.11.15"
 
 # import apis into sdk package
 from weheat.api.energy_log_api import EnergyLogApi
@@ -34,12 +34,17 @@ from weheat.exceptions import ApiAttributeError
 from weheat.exceptions import ApiException
 
 # import models into sdk package
+from weheat.models.boiler_type import BoilerType
 from weheat.models.device_state import DeviceState
+from weheat.models.dhw_type import DhwType
 from weheat.models.energy_view_dto import EnergyViewDto
 from weheat.models.heat_pump_log_view_dto import HeatPumpLogViewDto
+from weheat.models.heat_pump_model import HeatPumpModel
+from weheat.models.heat_pump_status_enum import HeatPumpStatusEnum
+from weheat.models.heat_pump_type import HeatPumpType
 from weheat.models.raw_heat_pump_log_dto import RawHeatPumpLogDto
 from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
 from weheat.models.read_heat_pump_dto import ReadHeatPumpDto
 from weheat.models.read_user_dto import ReadUserDto
+from weheat.models.read_user_me_dto import ReadUserMeDto
 from weheat.models.role import Role
-

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/weheat/abstractions/discovery.py

@@ -1,6 +1,8 @@
 import asyncio
 from dataclasses import dataclass
 
+import aiohttp
+
 from weheat import DeviceState
 from weheat.configuration import Configuration
 from weheat.api_client import ApiClient
@@ -17,16 +19,14 @@ class HeatPumpDiscovery:
         has_dhw: bool = False
 
     @staticmethod
-    async def async_discover_active(api_url: str, access_token: str) -> list[HeatPumpInfo]:
+    async def async_discover_active(api_url: str, access_token: str, client_session:aiohttp.ClientSession|None = None) -> list[HeatPumpInfo]:
         discovered_pumps = []
 
-        config = Configuration(host=api_url, access_token=access_token)
-
-        with ApiClient(configuration=config) as client:
+        config = Configuration(host=api_url, access_token=access_token, client_session=client_session)
 
-            response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info('', 1, 1000, DeviceState.NUMBER_3 ,async_req=True)
+        async with ApiClient(configuration=config) as client:
 
-            response = await asyncio.to_thread(response.get)
+            response = await  HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info('', 1, 1000, DeviceState.NUMBER_3)
 
             if response.status_code == 200:
                 for pump in response.data:

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/weheat/abstractions/heat_pump.py

@@ -2,6 +2,8 @@
 import asyncio
 from enum import Enum, auto
 
+import aiohttp
+
 from weheat import HeatPumpApi
 from weheat.configuration import Configuration
 from weheat.api_client import ApiClient
@@ -26,49 +28,43 @@ class HeatPump:
         SELF_TEST = auto()
         MANUAL_CONTROL = auto()
 
-    def __init__(self, api_url: str, uuid: str) -> None:
+    def __init__(self, api_url: str, uuid: str, client_session:aiohttp.ClientSession|None = None) -> None:
         self._api_url = api_url
         self._uuid = uuid
         self._last_log = None
         self._energy_consumption = None
         self._energy_output = None
         self._nominal_max_power = None
+        self._client = client_session
 
     async def async_get_status(self, access_token: str):
         """Updates the heat pump instance with data from the API."""
         try:
-            config = Configuration(host=self._api_url, access_token=access_token)
+            config = Configuration(host=self._api_url, access_token=access_token, client_session=self._client)
 
-            with ApiClient(configuration=config) as client:
+            async with ApiClient(configuration=config) as client:
                 # Set the max power once
                 if self._nominal_max_power is None:
-                    response = HeatPumpApi(client).api_v1_heat_pumps_heat_pump_id_get_with_http_info(heat_pump_id=self._uuid, async_req=True)
-
-                    response = await asyncio.to_thread(response.get)
+                    response = await HeatPumpApi(client).api_v1_heat_pumps_heat_pump_id_get_with_http_info(heat_pump_id=self._uuid)
 
                     if response.status_code == 200:
                         self._set_nominal_max_power_for_model(response.data.model)
 
 
-                response = HeatPumpLogApi(
+                response = await HeatPumpLogApi(
                     client
                 ).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
-                    heat_pump_id=self._uuid, async_req=True
-                )
-
-                response = await asyncio.to_thread(response.get)
+                    heat_pump_id=self._uuid                )
 
                 if response.status_code == 200:
                     self._last_log = response.data
 
                 # Also get all energy totals form past years and add them together
                 # As end time pick today + 1 day to avoid issues with timezones
-                response = EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=self._uuid,
+                response = await EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=self._uuid,
                                                                                 start_time=START_DATE,
                                                                                 end_time=datetime.now() + timedelta(days=1),
-                                                                                interval='Month', async_req=True)
-
-                response = await asyncio.to_thread(response.get)
+                                                                                interval='Month')
 
                 if response.status_code == 200:
                     # aggregate the energy consumption

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/weheat/abstractions/user.py

@@ -1,21 +1,21 @@
 import asyncio
 
+import aiohttp
+
 from weheat.configuration import Configuration
 from weheat.api_client import ApiClient
 from weheat.api.user_api import UserApi
 
 
-async def async_get_user_id_from_token(api_url: str, access_token: str):
+async def async_get_user_id_from_token(api_url: str, access_token: str, client_session:aiohttp.ClientSession|None = None):
     """ Get the user id from the current logged-in user. """
     try:
-        config = Configuration(host=api_url, access_token=access_token)
+        config = Configuration(host=api_url, access_token=access_token, client_session=client_session)
 
-        with ApiClient(configuration=config) as client:
-            response = UserApi(
+        async with ApiClient(configuration=config) as client:
+            response = await UserApi(
                 client
-            ).api_v1_users_me_get_with_http_info(async_req=True)
-
-            response = await asyncio.to_thread(response.get)
+            ).api_v1_users_me_get_with_http_info()
 
             if response.status_code == 200:
                 return response.data.id

{weheat-2025.1.14rc1 → weheat-2025.1.15rc2}/weheat/api/__init__.py

@@ -5,3 +5,4 @@ from weheat.api.energy_log_api import EnergyLogApi
 from weheat.api.heat_pump_api import HeatPumpApi
 from weheat.api.heat_pump_log_api import HeatPumpLogApi
 from weheat.api.user_api import UserApi
+