pydiagral 1.2.0__tar.gz → 1.2.0b1__tar.gz

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/.github/workflows/release_and_doc.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          persist-credentials: false
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -35,11 +35,10 @@ jobs:
       - name: Semantic Release
         id: semantic
         uses: cycjimmy/semantic-release-action@v4
-        with:
-          branch: ${{ github.ref_name }}  # Utiliser la branche actuelle
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          DEBUG: semantic-release:*
 
       - name: Show version
         if: steps.semantic.outputs.new_release_published == 'true'
@@ -57,7 +56,7 @@ jobs:
 
       - name: Publish to PyPI
         if: steps.semantic.outputs.new_release_published == 'true'
-        run: twine upload dist/* -u __token__ -p "${{ secrets.PYPI_TOKEN }}"
+        run: twine upload dist/* --skip-existing -u __token__ -p "${{ secrets.PYPI_TOKEN }}"
 
   deploy-docs:
     runs-on: ubuntu-latest
@@ -84,7 +83,7 @@ jobs:
           pip install -e .
 
       - name: Build documentation
-        run: mkdocs build --strict --verbose
+        run: mkdocs build --strict #--verbose
 
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/.releaserc

@@ -3,7 +3,6 @@
         "main",
         {
             "name": "beta",
-            "channel": "beta",
             "prerelease": true
         }
     ],

pydiagral-1.2.0b1/CHANGELOG.md

@@ -0,0 +1,22 @@
+# [1.2.0-beta.1](https://github.com/mguyard/pydiagral/compare/v1.1.0...v1.2.0-beta.1) (2025-02-23)
+
+
+### Features
+
+* Upgrade release ([bf300de](https://github.com/mguyard/pydiagral/commit/bf300de439c11b5bb2874043e1d2fe649d8f3073))
+
+# [1.1.0](https://github.com/mguyard/pydiagral/compare/v1.0.0...v1.1.0) (2025-02-23)
+
+
+### Features
+
+* **pencil:** Enable semantic debugs ([3d46b6e](https://github.com/mguyard/pydiagral/commit/3d46b6e220a7a26bea9f67112bfaea87419a9717))
+* Upgrade release ([1e1909b](https://github.com/mguyard/pydiagral/commit/1e1909bbf6b0626d23584f98d0ff02d55f0f264c))
+
+# [1.1.0-beta.1](https://github.com/mguyard/pydiagral/compare/v1.0.0...v1.1.0-beta.1) (2025-02-23)
+
+
+### Features
+
+* **pencil:** Enable semantic debugs ([3d46b6e](https://github.com/mguyard/pydiagral/commit/3d46b6e220a7a26bea9f67112bfaea87419a9717))
+* Upgrade release ([1e1909b](https://github.com/mguyard/pydiagral/commit/1e1909bbf6b0626d23584f98d0ff02d55f0f264c))

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.2.0
+Version: 1.2.0b1
 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.2.0 → pydiagral-1.2.0b1}/docs/api.md

@@ -4,9 +4,9 @@
 
 ::: pydiagral.api
     handler: python
-    selection:
-      members:
-        - "!^_"  # Excludes members starting with an underscore
-        - DiagralAPI
+    options:
+      show_root_heading: true
+      show_root_toc_entry: false
+      members_order: source
 
 <!-- prettier-ignore-end -->

pydiagral-1.2.0b1/docs/exceptions.md

@@ -0,0 +1,12 @@
+<!-- prettier-ignore-start -->
+
+# Exceptions Reference
+
+::: pydiagral.exceptions
+    handler: python
+    options:
+      show_root_heading: true
+      members_order: source
+
+
+<!-- prettier-ignore-end -->

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/docs/index.md

@@ -1,3 +1,5 @@
+![Logo](pydiagral-Logo.png)
+
 # Documentation pydiagral
 
 Welcome to the documentation for pydiagral, a Python library for interacting with the Diagral API.
@@ -61,7 +63,7 @@ LOG_LEVEL=DEBUG
 
 And run the [example_code.py](https://github.com/mguyard/pydiagral/blob/main/example_code.py).
 
-> [!TIP]
+> TIP
 >
 > You can customize the actions performed by [example_code.py](https://github.com/mguyard/pydiagral/blob/main/example_code.py) by modifying the parameters in the code, as indicated by the `CUSTOMIZE THE TESTS` section title.
 

pydiagral-1.2.0b1/docs/models.md

@@ -0,0 +1,11 @@
+<!-- prettier-ignore-start -->
+
+# Models Reference
+
+::: pydiagral.models
+    handler: python
+    options:
+      show_root_heading: true
+      members_order: source
+
+<!-- prettier-ignore-end -->

pydiagral-1.2.0b1/release-upgrade

@@ -0,0 +1 @@
+1

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/src/pydiagral/api.py

@@ -642,7 +642,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after starting the system.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -657,7 +658,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after stopping the system.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -670,7 +672,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after starting the system in presence mode.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -687,7 +690,6 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the provided ID is not 1 or 2.
-            All other exceptions from __system_action function are propagated.
 
         """
 
@@ -781,7 +783,7 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the action is not one of the allowed actions.
-            All other exceptions from __action_group_system function are propagated.
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
 
@@ -803,7 +805,7 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the action is not one of the allowed actions.
-            All other exceptions from __action_group_system function are propagated.
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
 
@@ -885,7 +887,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after enabling the product.
 
         Raises:
-            All exceptions from __action_product function are propagated.
+            ConfigurationError: If the action is not 'enable'
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
         return await self.__action_product(
@@ -905,7 +908,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after disabling the product.
 
         Raises:
-            All exceptions from __action_product function are propagated.
+            ConfigurationError: If the action is not 'disable'
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
         return await self.__action_product(
@@ -977,7 +981,6 @@ class DiagralAPI:
 
         Raises:
             AuthenticationError: If the API key or secret key is not provided.
-            All other exceptions from _request function are propagated.
 
         """
 

{pydiagral-1.2.0 → pydiagral-1.2.0b1}/src/pydiagral/models.py

@@ -90,7 +90,7 @@ class CamelCaseModel:
         return result
 
     @classmethod
-    def _from_dict_recursive(cls, data: dict, target_cls: type[T]) -> T:
+    def _from_dict_recursive(cls: type[T], data: dict, target_cls: type[T]) -> T:
         """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,7 +98,7 @@ class CamelCaseModel:
         by handling `Union` types and removing `None` from the type hints.
 
         Args:
-            cls: The class that this method is a part of.
+            cls (type[T]): 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.
 

pydiagral-1.2.0/CHANGELOG.md

@@ -1,55 +0,0 @@
-# [1.2.0](https://github.com/mguyard/pydiagral/compare/v1.1.0...v1.2.0) (2025-02-22)
-
-
-### Features
-
-* test1 ([e7bf5e6](https://github.com/mguyard/pydiagral/commit/e7bf5e6a4a72121a98e413541a0699d195190612))
-
-# [1.1.0](https://github.com/mguyard/pydiagral/compare/v1.0.0...v1.1.0) (2025-02-22)
-
-
-### Features
-
-* test ([75ec27f](https://github.com/mguyard/pydiagral/commit/75ec27f885ce4e9be08b3b194446d49709d5107d))
-
-# 1.0.0 (2025-02-22)
-
-
-### Bug Fixes
-
-* Add data in debug request log ([8951ce5](https://github.com/mguyard/pydiagral/commit/8951ce5cc4e7c896aa87bf99312253138fa8a247))
-* Allow detail and user fields in WebHookNotification model to be optional ([0ca68c3](https://github.com/mguyard/pydiagral/commit/0ca68c348a8dcaa58929c987f97ef57b3c8a5efc))
-* Allow detail and user fields in WebHookNotification model to be optional ([5499bbb](https://github.com/mguyard/pydiagral/commit/5499bbbb341f82b19a1513441b861ea720ad0363))
-* Bad object name use in test script ([71d740d](https://github.com/mguyard/pydiagral/commit/71d740daa812daf4d704581c0e4a862565b5c441))
-* Change aiohttp dependancy from static version 3.10.5 to ^3.8.0 ([d509427](https://github.com/mguyard/pydiagral/commit/d50942725f424d361f725999c803470c8a5636e0))
-* Rename test script to don't block pytest ([ec8323f](https://github.com/mguyard/pydiagral/commit/ec8323fdcd6e06ee6aadf5cd2005e7245aa0d219))
-* Resolve aiohttp dependancy syntax ([d9fddcf](https://github.com/mguyard/pydiagral/commit/d9fddcf5801d41f54d1f0409ded98ff7e9717f6c))
-* Resolve issue with Anomalies model and optional fields ([027289a](https://github.com/mguyard/pydiagral/commit/027289a78356ecceb4cf5b8d3121dbcba258b619))
-* Resolve issue with field name containing underscore but without field alias ([1ee94a5](https://github.com/mguyard/pydiagral/commit/1ee94a5de79efa61de668434de830df5abd7ed2d))
-* Resolve issue with previous commit where body data was extracted and not passed ([957a49a](https://github.com/mguyard/pydiagral/commit/957a49af6ceff43fbc07662bef2bb6e5da08cb80))
-* Resolve issue with WebHookNotification dataclass ([b0a4c46](https://github.com/mguyard/pydiagral/commit/b0a4c46fcf817e509879da8046a7f90a1a2d9afb))
-* Return User in WebHookNotification model ([39fc249](https://github.com/mguyard/pydiagral/commit/39fc2493e4abe3aa2e2c2c94ffc483e197efc12d))
-* set is_valid_email methode as private with __ ([90795a5](https://github.com/mguyard/pydiagral/commit/90795a5a15c6c110b1eda56309450e2c042e7721))
-* Update of models to more match models name purposed in Diagral API and ajust test.py script ([798ddd0](https://github.com/mguyard/pydiagral/commit/798ddd039db6909faf354b7fc463446c260d24eb))
-* Update return types in DiagralAPI::get_devices_info methods for improved data handling ([a48ea90](https://github.com/mguyard/pydiagral/commit/a48ea90f97f3c9ac72c5b0ef736feaa301720e54))
-* Update WebHookNotification model to require detail and user fields with improved initialization ([b373e3e](https://github.com/mguyard/pydiagral/commit/b373e3e0727334a422c741e64da0947d69c43df5))
-
-
-### Features
-
-* Add a class method to create a WebHookNotification instance from a dictionary ([1e17e78](https://github.com/mguyard/pydiagral/commit/1e17e78cbb0275424b4a3c4a1731a23d2b57660a))
-* Add a data model for the device list and update the method for retrieving device information ([8b4160a](https://github.com/mguyard/pydiagral/commit/8b4160a8d9426ab3ffe79ce44cdecba82ae90e8b))
-* Add alarm_type to WebHookNotification and implement alarm type determination based on alarm_code ([fc87d91](https://github.com/mguyard/pydiagral/commit/fc87d91f868e10cf8594cc916167b2ba0ae68927))
-* Add an asynchronous method to retrieve device information from the alarm configuration ([fe1bd8f](https://github.com/mguyard/pydiagral/commit/fe1bd8f46894af25399c27fac07ed6c49c6f644c))
-* Add an optional device_label field to WebHookNotificationDetail ([c429777](https://github.com/mguyard/pydiagral/commit/c42977737b9ac83d7c17b0a48667c0c2f9f362d5))
-* Add apikey argument in validate_apikey and delete_apikey function ([3c40eab](https://github.com/mguyard/pydiagral/commit/3c40eabfe6100bea6715a789b4d9bb03500fe962))
-* Add function to identity webhook type based on alarm_code provided in webhook notification ([088a3c0](https://github.com/mguyard/pydiagral/commit/088a3c03e4aed8f20074ed1b55e1880f9e0ee242))
-* Add model for Webhook Notification ([ca1fe40](https://github.com/mguyard/pydiagral/commit/ca1fe4079ef3c0c54c0589ced92621fef73fa6cf))
-* Add WebHookNotificationUser model to represent users triggering webhook notifications and include it in WebHookNotification model ([d13341f](https://github.com/mguyard/pydiagral/commit/d13341f5ee328c6c4c8c56d046182885d1fc256c))
-* Allow get_configuration function to return results ([f94956a](https://github.com/mguyard/pydiagral/commit/f94956abb4aea8e38aa78451e2d0d6c28c162405))
-* Implement webhook registration, update, and deletion functionality ([37d2c40](https://github.com/mguyard/pydiagral/commit/37d2c40151bd7dbe3244bd33ae97e88589aad6d0))
-* Improve test script example with more easy usage ([8636b6f](https://github.com/mguyard/pydiagral/commit/8636b6f0c809af94f9b090e5decdfc46dac05e4c))
-* Improve test script example with more easy usage ([3199f64](https://github.com/mguyard/pydiagral/commit/3199f64e154f848c745d7e0e6287325b04479355))
-* Include timezone (utc) in the created_at answer for get_anomalies function + test adaptation ([9005af8](https://github.com/mguyard/pydiagral/commit/9005af8637000f94e3ff3007696b228d855565f0))
-* Inplementation of new methods ([d8a2c18](https://github.com/mguyard/pydiagral/commit/d8a2c18637803436a12b13fe7ce813217b5c8357))
-* Update get_anomalies method to return an empty dict if no anomalies are found ([ad2b1da](https://github.com/mguyard/pydiagral/commit/ad2b1daa3b2396866a7f69bfe6aefc0b054dc76d))

pydiagral-1.2.0/docs/exceptions.md

@@ -1,18 +0,0 @@
-<!-- prettier-ignore-start -->
-
-# Exceptions Reference
-
-::: pydiagral.exceptions
-    handler: python
-    selection:
-      members:
-        - DiagralAPIError
-        - AuthenticationError
-        - ClientError
-        - ConfigurationError
-        - ServerError
-        - SessionError
-        - ValidationError
-
-
-<!-- prettier-ignore-end -->

pydiagral-1.2.0/docs/models.md

@@ -1,16 +0,0 @@
-<!-- prettier-ignore-start -->
-
-# Models Reference
-
-::: pydiagral.models
-    handler: python
-    options:
-      show_root_heading: true
-      show_source: false
-      members: true
-      filters:
-        - "!^_"  # Excludes members starting with an underscore
-        - "!CamelCaseModel"  # Specifically excludes the CamelCaseModel class
-        - - "!^[a-z]"  # Excludes members starting with a minus letter (following Python convention match functions)
-
-<!-- prettier-ignore-end -->

pydiagral-1.2.0/test.txt

@@ -1 +0,0 @@
-test