leneda-client 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

leneda/client.py

@@ -10,9 +10,10 @@ import logging
 from datetime import datetime, timedelta
 from typing import Any, Dict, List, Optional, Union
 
-import requests
+import aiohttp
+from aiohttp import ClientTimeout
 
-from .exceptions import ForbiddenException, InvalidMeteringPointException, UnauthorizedException
+from .exceptions import ForbiddenException, UnauthorizedException
 from .models import (
     AggregatedMeteringData,
     MeteringData,
@@ -27,8 +28,15 @@ class LenedaClient:
     """Client for the Leneda API."""
 
     BASE_URL = "https://api.leneda.lu/api"
+    DEFAULT_TIMEOUT = ClientTimeout(total=30)  # 30 seconds total timeout
 
-    def __init__(self, api_key: str, energy_id: str, debug: bool = False):
+    def __init__(
+        self,
+        api_key: str,
+        energy_id: str,
+        debug: bool = False,
+        timeout: Optional[ClientTimeout] = None,
+    ):
         """
         Initialize the Leneda API client.
 
@@ -36,9 +44,11 @@ class LenedaClient:
             api_key: Your Leneda API key
             energy_id: Your Energy ID
             debug: Enable debug logging
+            timeout: Optional timeout settings for requests
         """
         self.api_key = api_key
         self.energy_id = energy_id
+        self.timeout = timeout or self.DEFAULT_TIMEOUT
 
         # Set up headers for API requests
         self.headers = {
@@ -53,7 +63,7 @@ class LenedaClient:
             logger.setLevel(logging.DEBUG)
             logger.debug("Debug logging enabled for Leneda client")
 
-    def _make_request(
+    async def _make_request(
         self,
         method: str,
         endpoint: str,
@@ -75,7 +85,7 @@ class LenedaClient:
         Raises:
             UnauthorizedException: If the API returns a 401 status code
             ForbiddenException: If the API returns a 403 status code
-            requests.exceptions.RequestException: For other request errors
+            aiohttp.ClientError: For other request errors
             json.JSONDecodeError: If the response cannot be parsed as JSON
         """
         url = f"{self.BASE_URL}/{endpoint}"
@@ -88,52 +98,42 @@ class LenedaClient:
             logger.debug(f"Request data: {json.dumps(json_data, indent=2)}")
 
         try:
-            # Make the request
-            response = requests.request(
-                method=method, url=url, headers=self.headers, params=params, json=json_data
-            )
-
-            # Check for HTTP errors
-            if response.status_code == 401:
-                raise UnauthorizedException(
-                    "API authentication failed. Please check your API key and energy ID."
-                )
-            if response.status_code == 403:
-                raise ForbiddenException(
-                    "Access forbidden. This may be due to Leneda's geoblocking or other access restrictions."
-                )
-            response.raise_for_status()
-
-            # Parse the response
-            if response.content:
-                response_data = response.json()
-                logger.debug(f"Response status: {response.status_code}")
-                logger.debug(f"Response data: {json.dumps(response_data, indent=2)}")
-                return response_data
-            else:
-                logger.debug(f"Response status: {response.status_code} (no content)")
-                return {}
-
-        except requests.exceptions.HTTPError as e:
+            async with aiohttp.ClientSession(timeout=self.timeout) as session:
+                async with session.request(
+                    method=method, url=url, headers=self.headers, params=params, json=json_data
+                ) as response:
+                    # Check for HTTP errors
+                    if response.status == 401:
+                        raise UnauthorizedException(
+                            "API authentication failed. Please check your API key and energy ID."
+                        )
+                    if response.status == 403:
+                        raise ForbiddenException(
+                            "Access forbidden. This may be due to Leneda's geoblocking or other access restrictions."
+                        )
+                    response.raise_for_status()
+
+                    # Parse the response
+                    if response.content:
+                        response_data = await response.json()
+                        logger.debug(f"Response status: {response.status}")
+                        logger.debug(f"Response data: {json.dumps(response_data, indent=2)}")
+                        return response_data
+                    else:
+                        logger.debug(f"Response status: {response.status} (no content)")
+                        return {}
+
+        except aiohttp.ClientError as e:
             # Handle HTTP errors
             logger.error(f"HTTP error: {e}")
-            if hasattr(e, "response") and e.response is not None:
-                logger.error(f"Response status: {e.response.status_code}")
-                logger.error(f"Response body: {e.response.text}")
-            raise
-
-        except requests.exceptions.RequestException as e:
-            # Handle other request errors
-            logger.error(f"Request error: {e}")
             raise
 
         except json.JSONDecodeError as e:
             # Handle JSON parsing errors
             logger.error(f"JSON decode error: {e}")
-            logger.error(f"Response text: {response.text}")
             raise
 
-    def get_metering_data(
+    async def get_metering_data(
         self,
         metering_point_code: str,
         obis_code: ObisCode,
@@ -167,12 +167,12 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_request(method="GET", endpoint=endpoint, params=params)
 
         # Parse the response into a MeteringData object
         return MeteringData.from_dict(response_data)
 
-    def get_aggregated_metering_data(
+    async def get_aggregated_metering_data(
         self,
         metering_point_code: str,
         obis_code: ObisCode,
@@ -212,12 +212,12 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_request(method="GET", endpoint=endpoint, params=params)
 
         # Parse the response into an AggregatedMeteringData object
         return AggregatedMeteringData.from_dict(response_data)
 
-    def request_metering_data_access(
+    async def request_metering_data_access(
         self,
         from_energy_id: str,
         from_name: str,
@@ -246,47 +246,77 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="POST", endpoint=endpoint, json_data=data)
+        response_data = await self._make_request(method="POST", endpoint=endpoint, json_data=data)
 
         return response_data
 
-    def test_metering_point(self, metering_point_code: str) -> bool:
+    async def probe_metering_point_obis_code(
+        self, metering_point_code: str, obis_code: ObisCode
+    ) -> bool:
         """
-        Test if a metering point code is valid and accessible.
+        Probe if a metering point provides data for a specific OBIS code.
+
+        NOTE: This method is essentially a best guess since the Leneda API does not provide a way to check
+        if a metering point provides data for a specific OBIS code or whether a metering point code is valid
 
-        This method checks if a metering point code is valid by making a request
-        for aggregated metering data. If the unit property in the response is null,
-        it indicates that the metering point is invalid or not accessible.
+        This method checks if a metering point provides data for the specified OBIS code by making a request
+        for aggregated metering data. If the unit property in the response is null, it indicates that either:
+        - The metering point is invalid, or
+        - The metering point does not provide data for the specified OBIS code
 
         Args:
-            metering_point_code: The metering point code to test
+            metering_point_code: The metering point code to probe
+            obis_code: The OBIS code to check for data availability
 
         Returns:
-            bool: True if the metering point is valid and accessible, False otherwise
+            bool: True if the metering point provides data for the specified OBIS code, False otherwise
 
         Raises:
             UnauthorizedException: If the API returns a 401 status code
             ForbiddenException: If the API returns a 403 status code
-            requests.exceptions.RequestException: For other request errors
+            aiohttp.ClientError: For other request errors
         """
         # Use arbitrary time window
         end_date = datetime.now()
         start_date = end_date - timedelta(weeks=4)
 
-        # Try to get aggregated data for electricity consumption
-        result = self.get_aggregated_metering_data(
+        # Try to get aggregated data for the specified OBIS code
+        result = await self.get_aggregated_metering_data(
             metering_point_code=metering_point_code,
-            obis_code=ObisCode.ELEC_CONSUMPTION_ACTIVE,
+            obis_code=obis_code,
             start_date=start_date,
             end_date=end_date,
             aggregation_level="Month",
             transformation_mode="Accumulation",
         )
 
-        # If we get here and the unit is None, the metering point is invalid
-        if result.unit is None:
-            raise InvalidMeteringPointException(
-                f"Metering point {metering_point_code} is invalid or not accessible"
-            )
+        # Return True if we got data (unit is not None), False otherwise
+        return result.unit is not None
+
+    async def get_supported_obis_codes(self, metering_point_code: str) -> List[ObisCode]:
+        """
+        Get all OBIS codes that are supported by a given metering point.
+
+        NOTE: Please see the documentation of the probe_metering_point_obis_code method about best guess
+        behaviour. If this method returns an empty list, chances are high that the metering point code
+        is invalid or that the Energy ID has no access to it.
+
+        This method probes each OBIS code defined in the ObisCode enum to determine
+        which ones are supported by the specified metering point.
 
-        return True
+        Args:
+            metering_point_code: The metering point code to check
+
+        Returns:
+            List[ObisCode]: A list of OBIS codes that are supported by the metering point
+
+        Raises:
+            UnauthorizedException: If the API returns a 401 status code
+            ForbiddenException: If the API returns a 403 status code
+            aiohttp.ClientError: For other request errors
+        """
+        supported_codes = []
+        for obis_code in ObisCode:
+            if await self.probe_metering_point_obis_code(metering_point_code, obis_code):
+                supported_codes.append(obis_code)
+        return supported_codes

leneda/exceptions.py

@@ -19,9 +19,3 @@ class ForbiddenException(LenedaException):
     """Raised when access is forbidden (403 Forbidden), typically due to geoblocking or other access restrictions."""
 
     pass
-
-
-class InvalidMeteringPointException(LenedaException):
-    """Raised when a metering point code is invalid or not accessible."""
-
-    pass

leneda/version.py

@@ -1,3 +1,3 @@
 """Version information."""
 
-__version__ = "0.3.0"
+__version__ = "0.5.0"

{leneda_client-0.3.0.dist-info → leneda_client-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leneda-client
-Version: 0.3.0
+Version: 0.5.0
 Summary: Python client for the Leneda energy data platform
 Home-page: https://github.com/fedus/leneda-client
 Author: fedus
@@ -22,8 +22,9 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests>=2.25.0
+Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pytest-asyncio>=0.23.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -46,6 +47,9 @@ Dynamic: summary
 
 A Python client for interacting with the Leneda energy data platform API.
 
+PLEASE NOTE: As long as the library is in a version below 1.0.0, breaking changes
+may also be introduced between minor version bumps.
+
 ## Overview
 
 This client provides a simple interface to the Leneda API, which allows users to:

leneda_client-0.5.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
+leneda/client.py,sha256=aATrm5lI6O97cvVpwdtXGQA5kF3P6I4PZIE6G7y50AQ,12413
+leneda/exceptions.py,sha256=q00gjI5VwXAMF2I1gXfQidZMzbCF6UOSo4i1Wnb-inU,460
+leneda/models.py,sha256=jdU2cIZZDExUSiSfz9zaYjJepr0m3v_x5b1fyOaEI8Q,7930
+leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
+leneda/version.py,sha256=ScwrsoTG4Jp3gCphFH5AJNnhCl94poCw0wfA4QqStu0,50
+leneda_client-0.5.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
+leneda_client-0.5.0.dist-info/METADATA,sha256=lDNsYdQxINFuJtLRcqG2rGW1zRIc9z-34_Kzx3BnSp4,3515
+leneda_client-0.5.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+leneda_client-0.5.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
+leneda_client-0.5.0.dist-info/RECORD,,

{leneda_client-0.3.0.dist-info → leneda_client-0.5.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.1.0)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

leneda_client-0.3.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
-leneda/client.py,sha256=X2seOTrUYLKuLxDJT6ryGdKfNelsOhVq7lenJjI3kmM,10825
-leneda/exceptions.py,sha256=a84T3uSDQsMiKyFUZTbJTAp3hELfI1GQDriqv6aMDb8,600
-leneda/models.py,sha256=jdU2cIZZDExUSiSfz9zaYjJepr0m3v_x5b1fyOaEI8Q,7930
-leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
-leneda/version.py,sha256=wtPxgfjm82dK-e3EK0shDP4_7DlFk8hkRkOIPd6mV58,50
-leneda_client-0.3.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
-leneda_client-0.3.0.dist-info/METADATA,sha256=RHArkKFQqY--FL7-RCwTUQTaJvMWLvdswIYbM-8Yr1U,3344
-leneda_client-0.3.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
-leneda_client-0.3.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
-leneda_client-0.3.0.dist-info/RECORD,,