pydiagral 1.5.1b1__tar.gz → 1.6.0__tar.gz

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/.github/workflows/labeler.yml

@@ -16,6 +16,6 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v5.2.0
+        uses: crazy-max/ghaction-github-labeler@v5.3.0
         with:
           skip-delete: true

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [1.6.0](https://github.com/mguyard/pydiagral/compare/v1.5.2...v1.6.0) (2025-05-02)
+
+
+### Features
+
+* **api:** ✨ Change `pincode` type from `int` to `str` in `DiagralAPI` ([d5e8afe](https://github.com/mguyard/pydiagral/commit/d5e8afe47c727202b91b9dbd24ac3b60762cfa16))
+
+# [1.6.0-beta.1](https://github.com/mguyard/pydiagral/compare/v1.5.2...v1.6.0-beta.1) (2025-04-01)
+
+
+### Features
+
+* **api:** ✨ Change `pincode` type from `int` to `str` in `DiagralAPI` ([d5e8afe](https://github.com/mguyard/pydiagral/commit/d5e8afe47c727202b91b9dbd24ac3b60762cfa16))
+
+## [1.5.2](https://github.com/mguyard/pydiagral/compare/v1.5.1...v1.5.2) (2025-03-22)
+
+
+### Bug Fixes
+
+* **models:** ✨ Rename fields in `AlarmConfiguration` following Diagral changes ([3a56923](https://github.com/mguyard/pydiagral/commit/3a56923c553d5d4d31508e64c55ada64c3126ba0))
+
+## [1.5.1](https://github.com/mguyard/pydiagral/compare/v1.5.0...v1.5.1) (2025-03-09)
+
+
+### Bug Fixes
+
+* **models:** 🐛 Allow `username` and `user_type` to be optional ([d0f173c](https://github.com/mguyard/pydiagral/commit/d0f173cae4377cded21a7f4a6bc9ca0d13035df5))
+
 ## [1.5.1-beta.1](https://github.com/mguyard/pydiagral/compare/v1.5.0...v1.5.1-beta.1) (2025-03-09)
 
 

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.5.1b1
+Version: 1.6.0
 Summary: A Python library for interacting with Diagral systems
 Project-URL: Homepage, https://github.com/mguyard/pydiagral
 Project-URL: Documentation, https://github.com/mguyard/pydiagral

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/example_code.py

@@ -35,12 +35,12 @@ _LOGGER: logging.Logger = logging.getLogger(__name__)
 #   PIN_CODE=your_pin_code
 #   WEBHOOK_URL=your_webhook_url
 #   LOG_LEVEL=INFO
-USERNAME: str | None = os.getenv("USERNAME")
-PASSWORD: str | None = os.getenv("PASSWORD")
-SERIAL_ID: str | None = os.getenv("SERIAL_ID")
+USERNAME: str = os.getenv("USERNAME")
+PASSWORD: str = os.getenv("PASSWORD")
+SERIAL_ID: str = os.getenv("SERIAL_ID")
 API_KEY: str | None = os.getenv("API_KEY")  # Optional
 SECRET_KEY: str | None = os.getenv("SECRET_KEY")  # Optional
-PIN_CODE = int(os.getenv("PIN_CODE"))  # Optional
+PIN_CODE: str | None = str(os.getenv("PIN_CODE"))  # Optional
 WEBHOOK_URL: str | None = os.getenv("WEBHOOK_URL")  # Optional
 
 ######################################## CUSTOMIZE THE TESTS ########################################
@@ -50,9 +50,9 @@ TRY_CONNECTION_WITH_KEYS = False
 TRY_CONNECTION_WITHOUT_KEYS = False
 TRY_CONNECTION_WITH_KEYS_EPHEMERAL = False
 TRY_CONNECTION_WITHOUT_KEYS_EPHEMERAL = False
-APIKEY_CREATION = False
-APIKEY_DELETION = False
-LIST_GROUPS = False
+APIKEY_CREATION = True
+APIKEY_DELETION = True
+LIST_GROUPS = True
 LIST_SYSTEM_DETAILS = False
 LIST_SYSTEM_STATUS = False
 LIST_SYSTEM_CONFIGURATION = False

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/src/pydiagral/api.py

@@ -63,7 +63,7 @@ class DiagralAPI:
         serial_id: str,
         apikey: str | None = None,
         secret_key: str | None = None,
-        pincode: int | None = None,
+        pincode: str | None = None,
     ) -> None:
         """Initialize the DiagralAPI instance.
 
@@ -73,7 +73,7 @@ class DiagralAPI:
             serial_id (str): The serial ID of the Diagral system.
             apikey (str | None, optional): The API key for additional authentication. Defaults to None.
             secret_key (str | None, optional): The secret key for additional authentication. Defaults to None.
-            pincode (int | None, optional): The PIN code for the Diagral system. Defaults to None.
+            pincode (str | None, optional): The PIN code for the Diagral system. Defaults to None.
 
         Raises:
             ConfigurationError: If any required field is empty or invalid.
@@ -104,9 +104,11 @@ class DiagralAPI:
 
         # Validate pincode
         if pincode is not None:
-            if not isinstance(pincode, int):
-                raise ConfigurationError("pincode must be an integer")
-        self.__pincode: int | None = pincode
+            if not isinstance(pincode, str) or (
+                isinstance(pincode, str) and not pincode.isdigit()
+            ):
+                raise ConfigurationError("pincode must be an string of digits")
+        self.__pincode: str | None = pincode
 
         # Initialize session and access_token
         self.session: aiohttp.ClientSession | None = None
@@ -597,7 +599,7 @@ class DiagralAPI:
         )
 
         _HEADERS: dict[str, str] = {
-            "X-PIN-CODE": str(self.__pincode),
+            "X-PIN-CODE": self.__pincode,
             "X-HMAC": _HMAC,
             "X-TIMESTAMP": _TIMESTAMP,
             "X-APIKEY": self.__apikey,
@@ -640,7 +642,7 @@ class DiagralAPI:
         )
 
         _HEADERS: dict[str, str] = {
-            "X-PIN-CODE": str(self.__pincode),
+            "X-PIN-CODE": self.__pincode,
             "X-HMAC": _HMAC,
             "X-TIMESTAMP": _TIMESTAMP,
             "X-APIKEY": self.__apikey,
@@ -694,7 +696,7 @@ class DiagralAPI:
         )
 
         _HEADERS: dict[str, str] = {
-            "X-PIN-CODE": str(self.__pincode),
+            "X-PIN-CODE": self.__pincode,
             "X-HMAC": _HMAC,
             "X-TIMESTAMP": _TIMESTAMP,
             "X-APIKEY": self.__apikey,
@@ -829,7 +831,7 @@ class DiagralAPI:
         )
 
         _HEADERS: dict[str, str] = {
-            "X-PIN-CODE": str(self.__pincode),
+            "X-PIN-CODE": self.__pincode,
             "X-HMAC": _HMAC,
             "X-TIMESTAMP": _TIMESTAMP,
             "X-APIKEY": self.__apikey,
@@ -936,7 +938,7 @@ class DiagralAPI:
         )
 
         _HEADERS: dict[str, str] = {
-            "X-PIN-CODE": str(self.__pincode),
+            "X-PIN-CODE": self.__pincode,
             "X-HMAC": _HMAC,
             "X-TIMESTAMP": _TIMESTAMP,
             "X-APIKEY": self.__apikey,

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/src/pydiagral/models.py

@@ -13,7 +13,7 @@ from datetime import datetime, timezone
 import logging
 import re
 import types
-from typing import TypeVar, Union, get_args, get_origin, get_type_hints
+from typing import Self, Union, get_args, get_origin, get_type_hints
 
 logger: logging.Logger = logging.getLogger(__name__)
 
@@ -54,9 +54,6 @@ class CamelCaseModel:
 
     """
 
-    # Type variable for the class itself
-    T = TypeVar("T", bound="CamelCaseModel")
-
     def to_dict(self) -> dict:
         """Convert the instance attributes to a dictionary, transforming attribute names.
 
@@ -90,7 +87,7 @@ class CamelCaseModel:
         return result
 
     @classmethod
-    def _from_dict_recursive(cls: type[T], data: dict, target_cls: type[T]) -> T:
+    def _from_dict_recursive(cls, data: dict, target_cls: type[Self]) -> Self:
         """Recursively converts a dictionary to an instance of the specified target class.
 
         This method handles nested dictionaries and lists, converting them to the appropriate
@@ -98,12 +95,12 @@ class CamelCaseModel:
         by handling `Union` types and removing `None` from the type hints.
 
         Args:
-            cls (type[T]): The class that this method is a part of.
+            cls (type[Self]): The class that this method is a part of.
             data (dict): The dictionary to convert.
-            target_cls (type[T]): The target class to convert the dictionary to.
+            target_cls (type[Self]): The target class to convert the dictionary to.
 
         Returns:
-            T: An instance of the target class populated with the data from the dictionary.
+            An instance of the target class populated with the data from the dictionary.
 
         Raises:
             TypeError: If the target class cannot be instantiated with the provided data.
@@ -187,15 +184,15 @@ class CamelCaseModel:
         return target_cls(**init_values)
 
     @classmethod
-    def from_dict(cls: type[T], data: dict) -> T:
+    def from_dict(cls, data: dict) -> Self:
         """Create an instance of the class from a dictionary.
 
         Args:
-            cls (type[T]): The class type to instantiate.
+            cls (type[Self]): The class type to instantiate.
             data (dict): The dictionary containing the data to populate the instance.
 
         Returns:
-            T: An instance of the class populated with the data from the dictionary.
+            An instance of the class populated with the data from the dictionary.
 
         Example:
             >>> data = {"diagral_id": 123, "user_id": 456, "access_token": "abc123"}
@@ -830,11 +827,11 @@ class AlarmConfiguration(CamelCaseModel):
         reading_date (datetime | None): The date when the configuration was read, aliased as "readingDate".
         transceivers (list[TransceiverModel] | None): A list of transceiver models.
         transmitters (list[TransmitterModel] | None): A list of transmitter models.
-        grp_marche_presence (list[int] | None): A list of group marche presence, aliased as "grpMarchePresence".
+        presence_group (list[int] | None): A list of group marche presence, aliased as "presenceGroup".
         installation_state (int | None): The state of the installation, aliased as "installationState".
         central_information (CentralInformation | None): Information about the central unit, aliased as "centralInformation".
-        grp_marche_partielle1 (list[int] | None): A list of group marche partielle 1, aliased as "grpMarchePartielle1".
-        grp_marche_partielle2 (list[int] | None): A list of group marche partielle 2, aliased as "grpMarchePartielle2".
+        partial_group1 (list[int] | None): A list of group marche partielle 1, aliased as "partialGroup1".
+        partial_group2 (list[int] | None): A list of group marche partielle 2, aliased as "partialGroup2".
 
     Example:
         >>> alarm_config = AlarmConfiguration(
@@ -847,11 +844,11 @@ class AlarmConfiguration(CamelCaseModel):
         ...     reading_date=datetime(2023, 10, 1),
         ...     transceivers=[TransceiverModel(uid="11223", type=5)],
         ...     transmitters=[TransmitterModel(uid="44556", type=6)],
-        ...     grp_marche_presence=[1, 2, 3],
+        ...     presence_group=[1, 2, 3],
         ...     installation_state=1,
         ...     central_information=CentralInformation(has_plug=True),
-        ...     grp_marche_partielle1=[4, 5, 6],
-        ...     grp_marche_partielle2=[7, 8, 9]
+        ...     partial_group1=[4, 5, 6],
+        ...     partial_group2=[7, 8, 9]
         ... )
         >>> print(alarm_config.alarm.name)
         Home Alarm
@@ -870,8 +867,8 @@ class AlarmConfiguration(CamelCaseModel):
     )
     transceivers: list[TransceiverModel] | None = None
     transmitters: list[TransmitterModel] | None = None
-    grp_marche_presence: list[int] | None = field(
-        default=None, metadata={"alias": "grpMarchePresence"}
+    presence_group: list[int] | None = field(
+        default=None, metadata={"alias": "presenceGroup"}
     )
     installation_state: int | None = field(
         default=None, metadata={"alias": "installationState"}
@@ -879,11 +876,11 @@ class AlarmConfiguration(CamelCaseModel):
     central_information: CentralInformation | None = field(
         default=None, metadata={"alias": "centralInformation"}
     )
-    grp_marche_partielle1: list[int] | None = field(
-        default=None, metadata={"alias": "grpMarchePartielle1"}
+    partial_group1: list[int] | None = field(
+        default=None, metadata={"alias": "partialGroup1"}
     )
-    grp_marche_partielle2: list[int] | None = field(
-        default=None, metadata={"alias": "grpMarchePartielle2"}
+    partial_group2: list[int] | None = field(
+        default=None, metadata={"alias": "partialGroup2"}
     )
 
 

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/tests/data/configuration_sample.json

@@ -323,7 +323,7 @@
             "canInhibit": false
         }
     ],
-    "grpMarchePresence": [
+    "presenceGroup": [
         1,
         2,
         4
@@ -345,10 +345,10 @@
         "canInhibit": false,
         "parameterGsmSaved": false
     },
-    "grpMarchePartielle1": [
+    "partialGroup1": [
         1
     ],
-    "grpMarchePartielle2": [
+    "partialGroup2": [
         2
     ]
 }

{pydiagral-1.5.1b1 → pydiagral-1.6.0}/tests/test_pydiagral_api.py

@@ -45,7 +45,7 @@ PASSWORD = "test_password"
 SERIAL_ID = "test_serial_id"
 API_KEY = "test_api_key"
 SECRET_KEY = "test_secret_key"
-PIN_CODE = 1234
+PIN_CODE = "1234"
 FAKE_TOKEN = "test_fake_token"
 WEBHOOK_URL = "https://hook.example.com/webhook"