pydiagral 1.5.2__tar.gz → 1.6.0__tar.gz

{pydiagral-1.5.2 → 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.2 → pydiagral-1.6.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
 
 

{pydiagral-1.5.2 → pydiagral-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.5.2
+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.2 → 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.2 → 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.2 → 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"