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

leneda/__init__.py

@@ -17,7 +17,7 @@ from .models import (
 )
 
 # Import the OBIS code constants
-from .obis_codes import ElectricityConsumption, ElectricityProduction, GasConsumption
+from .obis_codes import ObisCode
 
 # Import the version
 from .version import __version__
@@ -25,9 +25,7 @@ from .version import __version__
 # Define what's available when using "from leneda import *"
 __all__ = [
     "LenedaClient",
-    "ElectricityConsumption",
-    "ElectricityProduction",
-    "GasConsumption",
+    "ObisCode",
     "MeteringValue",
     "MeteringData",
     "AggregatedMeteringValue",

leneda/client.py

@@ -7,12 +7,17 @@ energy consumption and production data for electricity and gas.
 
 import json
 import logging
-from datetime import datetime
-from typing import Any, Dict, Union
+from datetime import datetime, timedelta
+from typing import Any, Dict, List, Optional, Union
 
 import requests
 
-from .models import AggregatedMeteringData, MeteringData
+from .exceptions import ForbiddenException, InvalidMeteringPointException, UnauthorizedException
+from .models import (
+    AggregatedMeteringData,
+    MeteringData,
+)
+from .obis_codes import ObisCode
 
 # Set up logging
 logger = logging.getLogger("leneda.client")
@@ -50,22 +55,28 @@ class LenedaClient:
 
     def _make_request(
         self,
+        method: str,
         endpoint: str,
-        method: str = "GET",
-        params: Dict[str, Any] = None,
-        data: Dict[str, Any] = None,
-    ) -> Dict[str, Any]:
+        params: Optional[dict] = None,
+        json_data: Optional[dict] = None,
+    ) -> dict:
         """
         Make a request to the Leneda API.
 
         Args:
-            endpoint: API endpoint to call
-            method: HTTP method to use
-            params: Query parameters
-            data: Request body data
+            method: The HTTP method to use
+            endpoint: The API endpoint to call
+            params: Optional query parameters
+            json_data: Optional JSON data to send in the request body
 
         Returns:
-            API response as a dictionary
+            The JSON response from the API
+
+        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
+            json.JSONDecodeError: If the response cannot be parsed as JSON
         """
         url = f"{self.BASE_URL}/{endpoint}"
 
@@ -73,16 +84,24 @@ class LenedaClient:
         logger.debug(f"Making {method} request to {url}")
         if params:
             logger.debug(f"Query parameters: {params}")
-        if data:
-            logger.debug(f"Request data: {data}")
+        if json_data:
+            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=data
+                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
@@ -117,7 +136,7 @@ class LenedaClient:
     def get_metering_data(
         self,
         metering_point_code: str,
-        obis_code: str,
+        obis_code: ObisCode,
         start_date_time: Union[str, datetime],
         end_date_time: Union[str, datetime],
     ) -> MeteringData:
@@ -126,7 +145,7 @@ class LenedaClient:
 
         Args:
             metering_point_code: The metering point code
-            obis_code: The OBIS code
+            obis_code: The OBIS code (from ElectricityConsumption, ElectricityProduction, or GasConsumption)
             start_date_time: Start date and time (ISO format string or datetime object)
             end_date_time: End date and time (ISO format string or datetime object)
 
@@ -142,23 +161,21 @@ class LenedaClient:
         # Set up the endpoint and parameters
         endpoint = f"metering-points/{metering_point_code}/time-series"
         params = {
-            "obisCode": obis_code,
+            "obisCode": obis_code.value,  # Use enum value for API request
             "startDateTime": start_date_time,
             "endDateTime": end_date_time,
         }
 
         # Make the request
-        response_data = self._make_request(endpoint, params=params)
+        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
 
         # Parse the response into a MeteringData object
-        return MeteringData.from_dict(
-            response_data, metering_point_code=metering_point_code, obis_code=obis_code
-        )
+        return MeteringData.from_dict(response_data)
 
     def get_aggregated_metering_data(
         self,
         metering_point_code: str,
-        obis_code: str,
+        obis_code: ObisCode,
         start_date: Union[str, datetime],
         end_date: Union[str, datetime],
         aggregation_level: str = "Day",
@@ -169,11 +186,11 @@ class LenedaClient:
 
         Args:
             metering_point_code: The metering point code
-            obis_code: The OBIS code
+            obis_code: The OBIS code (from ElectricityConsumption, ElectricityProduction, or GasConsumption)
             start_date: Start date (ISO format string or datetime object)
             end_date: End date (ISO format string or datetime object)
-            aggregation_level: Aggregation level (Day, Week, Month, Quarter, Year)
-            transformation_mode: Transformation mode (Accumulation, Average, Maximum, Minimum)
+            aggregation_level: Aggregation level (Hour, Day, Week, Month, Infinite)
+            transformation_mode: Transformation mode (Accumulation)
 
         Returns:
             AggregatedMeteringData object containing the aggregated time series data
@@ -187,7 +204,7 @@ class LenedaClient:
         # Set up the endpoint and parameters
         endpoint = f"metering-points/{metering_point_code}/time-series/aggregated"
         params = {
-            "obisCode": obis_code,
+            "obisCode": obis_code.value,  # Use enum value for API request
             "startDate": start_date,
             "endDate": end_date,
             "aggregationLevel": aggregation_level,
@@ -195,32 +212,81 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(endpoint, params=params)
+        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
 
         # Parse the response into an AggregatedMeteringData object
-        return AggregatedMeteringData.from_dict(
-            response_data,
-            metering_point_code=metering_point_code,
-            obis_code=obis_code,
-            aggregation_level=aggregation_level,
-            transformation_mode=transformation_mode,
-        )
+        return AggregatedMeteringData.from_dict(response_data)
 
-    def request_metering_data_access(self, metering_point_code: str) -> Dict[str, Any]:
+    def request_metering_data_access(
+        self,
+        from_energy_id: str,
+        from_name: str,
+        metering_point_codes: List[str],
+        obis_codes: List[ObisCode],
+    ) -> Dict[str, Any]:
         """
         Request access to metering data for a specific metering point.
 
         Args:
-            metering_point_code: The metering point code
+            from_energy_id: The energy ID of the requester
+            from_name: The name of the requester
+            metering_point_codes: The metering point codes to access
+            obis_point_codes: The OBIS point codes to access (from ElectricityConsumption, ElectricityProduction, or GasConsumption)
 
         Returns:
             Response data from the API
         """
         # Set up the endpoint and data
         endpoint = "metering-data-access-request"
-        data = {"meteringPointCode": metering_point_code}
+        data = {
+            "from": from_energy_id,
+            "fromName": from_name,
+            "meteringPointCodes": metering_point_codes,
+            "obisCodes": [code.value for code in obis_codes],  # Use enum values for API request
+        }
 
         # Make the request
-        response_data = self._make_request(endpoint, method="POST", data=data)
+        response_data = self._make_request(method="POST", endpoint=endpoint, json_data=data)
 
         return response_data
+
+    def test_metering_point(self, metering_point_code: str) -> bool:
+        """
+        Test if a metering point code is valid and accessible.
+
+        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.
+
+        Args:
+            metering_point_code: The metering point code to test
+
+        Returns:
+            bool: True if the metering point is valid and accessible, 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
+        """
+        # 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(
+            metering_point_code=metering_point_code,
+            obis_code=ObisCode.ELEC_CONSUMPTION_ACTIVE,
+            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

leneda/exceptions.py

@@ -0,0 +1,27 @@
+"""
+Custom exceptions for the Leneda API client.
+"""
+
+
+class LenedaException(Exception):
+    """Base exception for all Leneda API client exceptions."""
+
+    pass
+
+
+class UnauthorizedException(LenedaException):
+    """Raised when API authentication fails (401 Unauthorized)."""
+
+    pass
+
+
+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/models.py

@@ -12,6 +12,8 @@ from typing import Any, Dict, List
 
 from dateutil import parser
 
+from .obis_codes import ObisCode
+
 # Set up logging
 logger = logging.getLogger("leneda.models")
 
@@ -64,23 +66,21 @@ class MeteringData:
     """Metering data for a specific metering point and OBIS code."""
 
     metering_point_code: str
-    obis_code: str
+    obis_code: ObisCode
     interval_length: str
     unit: str
     items: List[MeteringValue] = field(default_factory=list)
 
     @classmethod
-    def from_dict(
-        cls, data: Dict[str, Any], metering_point_code: str = "", obis_code: str = ""
-    ) -> "MeteringData":
+    def from_dict(cls, data: Dict[str, Any]) -> "MeteringData":
         """Create a MeteringData from a dictionary."""
         try:
             # Log the raw data for debugging
             logger.debug(f"Creating MeteringData from: {data}")
 
-            # Use values from the response, falling back to provided values if not in response
-            metering_point_code_value = data.get("meteringPointCode", metering_point_code)
-            obis_code_value = data.get("obisCode", obis_code)
+            # Use values from the response
+            metering_point_code_value = data["meteringPointCode"]
+            obis_code_value = ObisCode(data["obisCode"])
 
             # Extract items safely
             items_data = data.get("items", [])
@@ -101,6 +101,10 @@ class MeteringData:
                 unit=data.get("unit", ""),
                 items=items,
             )
+        except KeyError as e:
+            logger.error(f"Missing key in API response: {e}")
+            logger.debug(f"API response data: {data}")
+            raise
         except Exception as e:
             logger.error(f"Error creating MeteringData: {e}")
             logger.debug(f"API response data: {data}")
@@ -184,10 +188,6 @@ class AggregatedMeteringData:
     def from_dict(
         cls,
         data: Dict[str, Any],
-        metering_point_code: str = "",
-        obis_code: str = "",
-        aggregation_level: str = "",
-        transformation_mode: str = "",
     ) -> "AggregatedMeteringData":
         """Create an AggregatedMeteringData from a dictionary."""
         try:
@@ -206,7 +206,11 @@ class AggregatedMeteringData:
                     logger.warning(f"Skipping invalid aggregated item: {e}")
                     logger.debug(f"Invalid item data: {item_data}")
 
-            return cls(unit=data.get("unit", ""), aggregated_time_series=time_series)
+            return cls(unit=data["unit"], aggregated_time_series=time_series)
+        except KeyError as e:
+            logger.error(f"Missing key in API response: {e}")
+            logger.debug(f"API response data: {data}")
+            raise
         except Exception as e:
             logger.error(f"Error creating AggregatedMeteringData: {e}")
             logger.debug(f"API response data: {data}")

leneda/obis_codes.py

@@ -20,139 +20,136 @@ class ObisCodeInfo:
     description: str
 
 
-class ElectricityConsumption(str, Enum):
-    """OBIS codes for electricity consumption."""
+class ObisCode(str, Enum):
+    """OBIS codes for all energy types."""
 
-    ACTIVE = "1-1:1.29.0"  # Measured active consumption (kW)
-    REACTIVE = "1-1:3.29.0"  # Measured reactive consumption (kVAR)
+    # Electricity Consumption
+    ELEC_CONSUMPTION_ACTIVE = "1-1:1.29.0"  # Measured active consumption (kW)
+    ELEC_CONSUMPTION_REACTIVE = "1-1:3.29.0"  # Measured reactive consumption (kVAR)
 
     # Consumption covered by production sharing groups
-    COVERED_LAYER1 = "1-65:1.29.1"  # Layer 1 sharing Group (AIR)
-    COVERED_LAYER2 = "1-65:1.29.3"  # Layer 2 sharing Group (ACR/ACF/AC1)
-    COVERED_LAYER3 = "1-65:1.29.2"  # Layer 3 sharing Group (CEL)
-    COVERED_LAYER4 = "1-65:1.29.4"  # Layer 4 sharing Group (APS/CER/CEN)
-    REMAINING = "1-65:1.29.9"  # Remaining consumption after sharing invoiced by supplier
-
+    ELEC_CONSUMPTION_COVERED_LAYER1 = "1-65:1.29.1"  # Layer 1 sharing Group (AIR)
+    ELEC_CONSUMPTION_COVERED_LAYER2 = "1-65:1.29.3"  # Layer 2 sharing Group (ACR/ACF/AC1)
+    ELEC_CONSUMPTION_COVERED_LAYER3 = "1-65:1.29.2"  # Layer 3 sharing Group (CEL)
+    ELEC_CONSUMPTION_COVERED_LAYER4 = "1-65:1.29.4"  # Layer 4 sharing Group (APS/CER/CEN)
+    ELEC_CONSUMPTION_REMAINING = (
+        "1-65:1.29.9"  # Remaining consumption after sharing invoiced by supplier
+    )
 
-class ElectricityProduction(str, Enum):
-    """OBIS codes for electricity production."""
-
-    ACTIVE = "1-1:2.29.0"  # Measured active production (kW)
-    REACTIVE = "1-1:4.29.0"  # Measured reactive production (kVAR)
+    # Electricity Production
+    ELEC_PRODUCTION_ACTIVE = "1-1:2.29.0"  # Measured active production (kW)
+    ELEC_PRODUCTION_REACTIVE = "1-1:4.29.0"  # Measured reactive production (kVAR)
 
     # Production shared within sharing groups
-    SHARED_LAYER1 = "1-65:2.29.1"  # Layer 1 sharing Group (AIR)
-    SHARED_LAYER2 = "1-65:2.29.3"  # Layer 2 sharing Group (ACR/ACF/AC1)
-    SHARED_LAYER3 = "1-65:2.29.2"  # Layer 3 sharing Group (CEL)
-    SHARED_LAYER4 = "1-65:2.29.4"  # Layer 4 sharing Group (APS/CER/CEN)
-    REMAINING = "1-65:2.29.9"  # Remaining production after sharing sold to market
+    ELEC_PRODUCTION_SHARED_LAYER1 = "1-65:2.29.1"  # Layer 1 sharing Group (AIR)
+    ELEC_PRODUCTION_SHARED_LAYER2 = "1-65:2.29.3"  # Layer 2 sharing Group (ACR/ACF/AC1)
+    ELEC_PRODUCTION_SHARED_LAYER3 = "1-65:2.29.2"  # Layer 3 sharing Group (CEL)
+    ELEC_PRODUCTION_SHARED_LAYER4 = "1-65:2.29.4"  # Layer 4 sharing Group (APS/CER/CEN)
+    ELEC_PRODUCTION_REMAINING = "1-65:2.29.9"  # Remaining production after sharing sold to market
 
-
-class GasConsumption(str, Enum):
-    """OBIS codes for gas consumption."""
-
-    VOLUME = "7-1:99.23.15"  # Measured consumed volume (m³)
-    STANDARD_VOLUME = "7-1:99.23.17"  # Measured consumed standard volume (Nm³)
-    ENERGY = "7-20:99.33.17"  # Measured consumed energy (kWh)
+    # Gas Consumption
+    GAS_CONSUMPTION_VOLUME = "7-1:99.23.15"  # Measured consumed volume (m³)
+    GAS_CONSUMPTION_STANDARD_VOLUME = "7-1:99.23.17"  # Measured consumed standard volume (Nm³)
+    GAS_CONSUMPTION_ENERGY = "7-20:99.33.17"  # Measured consumed energy (kWh)
 
 
 # Complete mapping of all OBIS codes to their details
 OBIS_CODES: Dict[str, ObisCodeInfo] = {
     # Electricity Consumption
-    ElectricityConsumption.ACTIVE: ObisCodeInfo(
-        ElectricityConsumption.ACTIVE,
+    ObisCode.ELEC_CONSUMPTION_ACTIVE: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_ACTIVE,
         "kW",
         "Consumption",
         "Measured active consumption",
     ),
-    ElectricityConsumption.REACTIVE: ObisCodeInfo(
-        ElectricityConsumption.REACTIVE,
+    ObisCode.ELEC_CONSUMPTION_REACTIVE: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_REACTIVE,
         "kVAR",
         "Consumption",
         "Measured reactive consumption",
     ),
-    ElectricityConsumption.COVERED_LAYER1: ObisCodeInfo(
-        ElectricityConsumption.COVERED_LAYER1,
+    ObisCode.ELEC_CONSUMPTION_COVERED_LAYER1: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_COVERED_LAYER1,
         "kW",
         "Consumption",
         "Consumption covered by production of layer 1 sharing Group (AIR)",
     ),
-    ElectricityConsumption.COVERED_LAYER2: ObisCodeInfo(
-        ElectricityConsumption.COVERED_LAYER2,
+    ObisCode.ELEC_CONSUMPTION_COVERED_LAYER2: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_COVERED_LAYER2,
         "kW",
         "Consumption",
         "Consumption covered by production of layer 2 sharing Group (ACR/ACF/AC1)",
     ),
-    ElectricityConsumption.COVERED_LAYER3: ObisCodeInfo(
-        ElectricityConsumption.COVERED_LAYER3,
+    ObisCode.ELEC_CONSUMPTION_COVERED_LAYER3: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_COVERED_LAYER3,
         "kW",
         "Consumption",
         "Consumption covered by production of layer 3 sharing Group (CEL)",
     ),
-    ElectricityConsumption.COVERED_LAYER4: ObisCodeInfo(
-        ElectricityConsumption.COVERED_LAYER4,
+    ObisCode.ELEC_CONSUMPTION_COVERED_LAYER4: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_COVERED_LAYER4,
         "kW",
         "Consumption",
         "Consumption covered by production of layer 4 sharing Group (APS/CER/CEN)",
     ),
-    ElectricityConsumption.REMAINING: ObisCodeInfo(
-        ElectricityConsumption.REMAINING,
+    ObisCode.ELEC_CONSUMPTION_REMAINING: ObisCodeInfo(
+        ObisCode.ELEC_CONSUMPTION_REMAINING,
         "kW",
         "Consumption",
         "Remaining consumption after sharing invoiced by supplier",
     ),
     # Electricity Production
-    ElectricityProduction.ACTIVE: ObisCodeInfo(
-        ElectricityProduction.ACTIVE, "kW", "Production", "Measured active production"
+    ObisCode.ELEC_PRODUCTION_ACTIVE: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_ACTIVE, "kW", "Production", "Measured active production"
     ),
-    ElectricityProduction.REACTIVE: ObisCodeInfo(
-        ElectricityProduction.REACTIVE,
+    ObisCode.ELEC_PRODUCTION_REACTIVE: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_REACTIVE,
         "kVAR",
         "Consumption",
         "Measured reactive production",
     ),
-    ElectricityProduction.SHARED_LAYER1: ObisCodeInfo(
-        ElectricityProduction.SHARED_LAYER1,
+    ObisCode.ELEC_PRODUCTION_SHARED_LAYER1: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_SHARED_LAYER1,
         "kW",
         "Production",
         "Production shared within layer 1 sharing Group (AIR)",
     ),
-    ElectricityProduction.SHARED_LAYER2: ObisCodeInfo(
-        ElectricityProduction.SHARED_LAYER2,
+    ObisCode.ELEC_PRODUCTION_SHARED_LAYER2: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_SHARED_LAYER2,
         "kW",
         "Production",
         "Production shared within layer 2 sharing Group (ACR/ACF/AC1)",
     ),
-    ElectricityProduction.SHARED_LAYER3: ObisCodeInfo(
-        ElectricityProduction.SHARED_LAYER3,
+    ObisCode.ELEC_PRODUCTION_SHARED_LAYER3: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_SHARED_LAYER3,
         "kW",
         "Production",
         "Production shared within layer 3 sharing Group (CEL)",
     ),
-    ElectricityProduction.SHARED_LAYER4: ObisCodeInfo(
-        ElectricityProduction.SHARED_LAYER4,
+    ObisCode.ELEC_PRODUCTION_SHARED_LAYER4: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_SHARED_LAYER4,
         "kW",
         "Production",
         "Production shared within layer 4 sharing Group (APS/CER/CEN)",
     ),
-    ElectricityProduction.REMAINING: ObisCodeInfo(
-        ElectricityProduction.REMAINING,
+    ObisCode.ELEC_PRODUCTION_REMAINING: ObisCodeInfo(
+        ObisCode.ELEC_PRODUCTION_REMAINING,
         "kW",
         "Production",
         "Remaining production after sharing sold to market",
     ),
     # Gas Consumption
-    GasConsumption.VOLUME: ObisCodeInfo(
-        GasConsumption.VOLUME, "m³", "Consumption", "Measured consumed volume"
+    ObisCode.GAS_CONSUMPTION_VOLUME: ObisCodeInfo(
+        ObisCode.GAS_CONSUMPTION_VOLUME, "m³", "Consumption", "Measured consumed volume"
     ),
-    GasConsumption.STANDARD_VOLUME: ObisCodeInfo(
-        GasConsumption.STANDARD_VOLUME,
+    ObisCode.GAS_CONSUMPTION_STANDARD_VOLUME: ObisCodeInfo(
+        ObisCode.GAS_CONSUMPTION_STANDARD_VOLUME,
         "Nm³",
         "Consumption",
         "Measured consumed standard volume",
     ),
-    GasConsumption.ENERGY: ObisCodeInfo(
-        GasConsumption.ENERGY, "kWh", "Consumption", "Measured consumed energy"
+    ObisCode.GAS_CONSUMPTION_ENERGY: ObisCodeInfo(
+        ObisCode.GAS_CONSUMPTION_ENERGY, "kWh", "Consumption", "Measured consumed energy"
     ),
 }
 
@@ -171,7 +168,7 @@ def get_obis_info(obis_code: str) -> ObisCodeInfo:
         KeyError: If the OBIS code is not found
 
     Example:
-        >>> info = get_obis_info(ElectricityConsumption.ACTIVE)
+        >>> info = get_obis_info(ObisCode.ELEC_CONSUMPTION_ACTIVE)
         >>> print(info.unit)
         'kW'
     """
@@ -192,7 +189,7 @@ def get_unit(obis_code: str) -> str:
         KeyError: If the OBIS code is not found
 
     Example:
-        >>> unit = get_unit(ElectricityConsumption.ACTIVE)
+        >>> unit = get_unit(ObisCode.ELEC_CONSUMPTION_ACTIVE)
         >>> print(unit)
         'kW'
     """

leneda/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leneda-client
-Version: 0.1.1
+Version: 0.3.0
 Summary: Python client for the Leneda energy data platform
 Home-page: https://github.com/fedus/leneda-client
 Author: fedus
@@ -21,6 +21,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: requests>=2.25.0
 Requires-Dist: python-dateutil>=2.8.2
 Dynamic: author
@@ -30,6 +31,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: requires-python
@@ -37,9 +39,10 @@ Dynamic: summary
 
 # Leneda API Client
 
-[![PyPI version]](https://pypi.org/project/leneda-client/)
-[![Python versions]](https://pypi.org/project/leneda-client/)
-[![License]](https://github.com/fedus/leneda-client/blob/main/LICENSE)
+[![PyPI version](https://img.shields.io/pypi/v/leneda-client.svg)](https://pypi.org/project/leneda-client/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/leneda-client)](https://pypi.org/project/leneda-client/)
+[![License](https://img.shields.io/github/license/fedus/leneda-client)](https://github.com/fedus/leneda-client/blob/main/LICENSE)
+
 
 A Python client for interacting with the Leneda energy data platform API.
 
@@ -56,3 +59,33 @@ This client provides a simple interface to the Leneda API, which allows users to
 
 ```bash
 pip install leneda-client
+```
+
+## Trying it out
+
+```bash
+$ export LENEDA_ENERGY_ID='LUXE-xx-yy-1234'
+$ export LENEDA_API_KEY='YOUR-API-KEY'
+$ python examples/basic_usage.py --metering-point LU0000012345678901234000000000000
+Example 1: Getting hourly electricity consumption data for the last 7 days
+Retrieved 514 consumption measurements
+Unit: kW
+Interval length: PT15M
+Metering point: LU0000012345678901234000000000000
+OBIS code: ObisCode.ELEC_CONSUMPTION_ACTIVE
+
+First 3 measurements:
+Time: 2025-04-18T13:30:00+00:00, Value: 0.048 kW, Type: Actual, Version: 2, Calculated: False
+Time: 2025-04-18T13:45:00+00:00, Value: 0.08 kW, Type: Actual, Version: 2, Calculated: False
+Time: 2025-04-18T14:00:00+00:00, Value: 0.08 kW, Type: Actual, Version: 2, Calculated: False
+
+Example 2: Getting monthly aggregated electricity consumption for 2025
+Retrieved 4 monthly aggregations
+Unit: kWh
+
+Monthly consumption:
+Period: 2024-12 to 2025-01, Value: 30.858 kWh, Calculated: False
+Period: 2025-01 to 2025-02, Value: 148.985 kWh, Calculated: False
+Period: 2025-02 to 2025-03, Value: 44.619 kWh, Calculated: False
+Period: 2025-03 to 2025-04, Value: 29.662 kWh, Calculated: False
+```

leneda_client-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+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,,

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

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

leneda_client-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 fedus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

leneda_client-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-leneda/__init__.py,sha256=JLvEM9M0jk2LcYK9DWYKrSF_BXTvmC8i570N_BggPck,850
-leneda/client.py,sha256=G_4kQi54ob3Te5gcQqH1KBRfkYBe00b-WDDTn6HCMNI,7716
-leneda/models.py,sha256=hTDEsdgUZJA-9jSqbOOoeJbCvFmgHMj3eZ8JZilWGpo,7861
-leneda/obis_codes.py,sha256=gPrxnYfUNvWrbKFA3z-4TSTHnOhWHt5hkm5GAwoo0-w,7170
-leneda/version.py,sha256=YYQdu6Uqy9CTkjnQKsNKvrOd3DH1zWTn0ajJafGZDIc,50
-leneda_client-0.1.1.dist-info/METADATA,sha256=5JebX58dz2b6fsPnFYIZx6Lh2ClUaC6fbJEb6zic-ZA,1994
-leneda_client-0.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-leneda_client-0.1.1.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
-leneda_client-0.1.1.dist-info/RECORD,,