pydiagral 1.4.0__tar.gz → 1.5.0__tar.gz

pydiagral-1.5.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,101 @@
+---
+name: "Bug report"
+description: "Report a bug with the pydiagral package"
+title: "[Bug]:  "
+labels: [bug]
+assignees: mguyard
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!NOTE]
+        >
+        > This issue form is for reporting bugs only!
+        >
+        > Before you open a new issue, search through the [existing issues][ei] to see if others have had the same problem.
+        >
+        > [ei]: https://github.com/mguyard/pydiagral/issues?q=label%3Abug
+
+  - type: textarea
+    attributes:
+      label: Reproduction steps
+      description: "Without steps to reproduce, it will be hard to fix, it is very important that you fill out this part, issues without it will be closed"
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: The problem
+      description: >-
+        Describe the issue you are experiencing here, to communicate to the
+        maintainers. Tell us what you were trying to do and what happened.
+
+        Provide a clear and concise description of what the problem is.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+
+  - type: input
+    id: version
+    validations:
+      required: true
+    attributes:
+      label: What version of pydiagral has the issue?
+
+  - type: input
+    attributes:
+      label: What was the last working version of pydiagral?
+      description: >
+        If known, otherwise leave blank.
+
+  - type: input
+    id: python-version
+    validations:
+      required: true
+    attributes:
+      label: What version of python are you running?
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Details
+
+  - type: textarea
+    id: script-log
+    validations:
+      required: true
+    attributes:
+      label: Script Log
+      description: >
+        Copy and paste the relevant parts of the script log here.
+
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        If you have any additional information for us, use the field below.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Confirmation
+
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+        - label: I have filled out the issue template to the best of my ability.
+          required: true
+        - label: This issue only contains 1 issue (if you have multiple issues, open one issue for each issue).
+          required: true
+        - label: This issue is not a duplicate issue of currently [previous issues](https://github.com/mguyard/pydiagral/issues?q=label%3Abug)..
+          required: true

pydiagral-1.5.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,64 @@
+---
+name: "Feature request"
+description: "Suggest an idea for this project"
+title: "[Feature Request]:  "
+labels: [feature]
+assignees: mguyard
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!NOTE]
+        >
+        > This issue form is for reporting Feature Request only!
+        >
+        > Before you open a new feature request, search through the existing [feature requests][fr] to see if others have had the same idea.
+        >
+        > [fr]: https://github.com/mguyard/pydiagral/issues?q=label%3Afeature
+
+  - type: textarea
+    attributes:
+      label: "Is your feature request related to a problem? Please describe."
+      description: "A clear and concise description of what the problem is."
+      placeholder: "I'm always frustrated when [...]"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Describe the solution you'd like"
+      description: "A clear and concise description of what you want to happen."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Describe alternatives you've considered"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Additional context"
+      description: "Add any other context or screenshots about the feature request here."
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        > [!TIP]
+        >
+        > Keep in mind you can also help the project by contributing to it, if you have the skills to do so, you can open a pull request with the changes you want to see in the project.
+
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+        - label: I have filled out the template to the best of my ability.
+          required: true
+        - label: This only contains 1 feature request (if you have multiple feature requests, open one feature request for each feature request).
+          required: true
+        - label: This issue is not a duplicate feature request of [previous feature requests](https://github.com/mguyard/pydiagral/issues?q=label%3Afeature).
+          required: true

pydiagral-1.5.0/.github/copilot-commit-message-instructions.md

@@ -0,0 +1,25 @@
+Follow the Conventional Commits format strictly for commit messages. Use the structure below:
+
+```
+<type>[optional scope]: <gitmoji> <description>
+
+[optional body]
+```
+
+Guidelines:
+
+1. **Type and Scope**: Choose an appropriate type (e.g., `feat`, `fix`) and optional scope to describe the affected module or feature.
+
+2. **Gitmoji**: Include a relevant `gitmoji` that best represents the nature of the change.
+
+3. **Description**: Write a concise, informative description in the header; use backticks if referencing code or specific terms.
+
+4. **Body**: For additional details, use a well-structured body section:
+   - Use bullet points (`*`) for clarity.
+   - Clearly describe the motivation, context, or technical details behind the change, if applicable.
+
+Commit messages should be clear, informative, and professional, aiding readability and project tracking.
+
+Limit the first line to 72 characters or less.
+
+Always write in English to maintain consistency and clarity across the project.

pydiagral-1.5.0/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "github.copilot.chat.commitMessageGeneration.instructions": [
+        {
+            "file": ".github/copilot-commit-message-instructions.md"
+        }
+    ]
+}

pydiagral-1.5.0/CHANGELOG.md

@@ -0,0 +1,63 @@
+# [1.5.0](https://github.com/mguyard/pydiagral/compare/v1.4.0...v1.5.0) (2025-03-02)
+
+
+### Bug Fixes
+
+* **api:** 🔧 Clean up API keys on connection failure ([c8f87c6](https://github.com/mguyard/pydiagral/commit/c8f87c6b4e0091775bf948d6471bc8966c9d25ad))
+* **api:** 🔧 Refactor API key handling and introduce new exceptions ([b1f6d06](https://github.com/mguyard/pydiagral/commit/b1f6d060e52c0c660e760c1dc86c5fa75613e4b2))
+* **api:** 🔧 Update log message for alarm name retrieval ([fca40e4](https://github.com/mguyard/pydiagral/commit/fca40e44bccd59f6399ae2b89a29c2b4fcc80172))
+
+
+### Features
+
+* **api:** 🚀 Add `get_alarm_name` method and log alarm name in tests ([96e727f](https://github.com/mguyard/pydiagral/commit/96e727fe851a1086d8689c6fb7204efdb702938d))
+* **api:** 🚀 Add connection testing functionality with result handling ([a07bbfc](https://github.com/mguyard/pydiagral/commit/a07bbfc22a1f41418dad0347394cadcab31685e8))
+* **api:** 🚀 Add testing connection feature ([53981f6](https://github.com/mguyard/pydiagral/commit/53981f6bdb8b797b7f4408fbaf2264b66a58ab38))
+
+# [1.5.0-beta.6](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.5...v1.5.0-beta.6) (2025-03-01)
+
+
+### Bug Fixes
+
+* **api:** 🔧 Clean up API keys on connection failure ([c8f87c6](https://github.com/mguyard/pydiagral/commit/c8f87c6b4e0091775bf948d6471bc8966c9d25ad))
+
+# [1.5.0-beta.5](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.4...v1.5.0-beta.5) (2025-03-01)
+
+
+### Bug Fixes
+
+* **api:** 🔧 Refactor API key handling and introduce new exceptions ([b1f6d06](https://github.com/mguyard/pydiagral/commit/b1f6d060e52c0c660e760c1dc86c5fa75613e4b2))
+
+# [1.5.0-beta.4](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.3...v1.5.0-beta.4) (2025-02-28)
+
+
+### Bug Fixes
+
+* **api:** 🔧 Update log message for alarm name retrieval ([fca40e4](https://github.com/mguyard/pydiagral/commit/fca40e44bccd59f6399ae2b89a29c2b4fcc80172))
+
+# [1.5.0-beta.3](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.2...v1.5.0-beta.3) (2025-02-28)
+
+
+### Features
+
+* **api:** 🚀 Add `get_alarm_name` method and log alarm name in tests ([96e727f](https://github.com/mguyard/pydiagral/commit/96e727fe851a1086d8689c6fb7204efdb702938d))
+
+# [1.5.0-beta.2](https://github.com/mguyard/pydiagral/compare/v1.5.0-beta.1...v1.5.0-beta.2) (2025-02-28)
+
+
+### Features
+
+* **api:** 🚀 Add connection testing functionality with result handling ([a07bbfc](https://github.com/mguyard/pydiagral/commit/a07bbfc22a1f41418dad0347394cadcab31685e8))
+
+# [1.5.0-beta.1](https://github.com/mguyard/pydiagral/compare/v1.4.0...v1.5.0-beta.1) (2025-02-28)
+
+
+### Features
+
+* **api:** 🚀 Add testing connection feature ([53981f6](https://github.com/mguyard/pydiagral/commit/53981f6bdb8b797b7f4408fbaf2264b66a58ab38))
+
+# 1.4.0 (2025-02-23)
+
+### Features
+
+- Initial Public release

{pydiagral-1.4.0 → pydiagral-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.4.0
+Version: 1.5.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
@@ -685,7 +685,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 License-File: LICENSE
 Keywords: diagral,home automation,python
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
@@ -702,9 +702,6 @@ Description-Content-Type: text/markdown
 <p align="center">
   <img src="https://raw.githubusercontent.com/mguyard/pydiagral/main/docs/pydiagral-Logo.png" width="400" />
 </p>
-<p align="center">
-    <h1 align="center">PyDiagral</h1>
-</p>
 <p align="center">
     A powerful and easy-to-use Python library for seamless integration with the Diagral alarm system.
 </p>
@@ -729,19 +726,25 @@ Description-Content-Type: text/markdown
 </p>
 <br /><br />
 
-# Documentation pydiagral
+# pydiagral
 
 Welcome to the documentation for pydiagral, a Python library for interacting with the Diagral API.
 
-## About pydiagral
+## 📍 About pydiagral
 
-pydiagral is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.
+`pydiagral` is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.
 
-## Requirement
+> [!CAUTION]
+>
+> Please note that the Diagral alarm system is a security system, and it may be preferable not to connect it to any automation platform for security reasons.
+> In no event shall the developer of [`pydiagral`](https://github.com/mguyard/pydiagral) library be held liable for any issues arising from the use of this [`pydiagral`](https://github.com/mguyard/pydiagral) library.
+> The user installs and uses this integration at their own risk and with full knowledge of the potential implications.
+
+## ✅ Requirement
 
 To use this library, which leverages the Diagral APIs, you must have a Diagral box (DIAG56AAX). This box connects your Diagral alarm system to the internet, enabling interaction with the alarm system via the API. You can find more information about the Diagral box [here](https://www.diagral.fr/commande/box-alerte-et-pilotage).
 
-## Key Features
+## 📦 Key Features
 
 The `DiagralAPI` class offers the following functionalities:
 
@@ -766,7 +769,7 @@ The `DiagralAPI` class offers the following functionalities:
   - Activate or Desactivate system (partially or globally)
   - Automatism actions
 
-## Quick Start
+## 🚀 Quick Start
 
 To get started with pydiagral, follow these steps:
 
@@ -796,33 +799,72 @@ And run the [example_code.py](https://github.com/mguyard/pydiagral/blob/main/exa
 >
 > 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.
 
+# 📖 Documentations
+
+## Package Documentation
+
+Library documentation is available [here](https://mguyard.github.io/pydiagral/).
+
+### Package Structure
+
+For detailed library documentation, please refer to the following sections:
+
+- [API Reference](https://mguyard.github.io/pydiagral/api/): Comprehensive documentation of the DiagralAPI class and its methods
+- [Data Models](https://mguyard.github.io/pydiagral/models/): Description of the data structures used
+- [Exceptions](https://mguyard.github.io/pydiagral/exceptions/): List of package exceptions
+
 ## Diagral API Official documentation
 
 Official Diagral API is available [here](https://appv3.tt-monitor.com/emerald/redoc).
 
+# 🙋 FAQ
+
 ## How to find Serial on DIAG56AAX
 
 The serial number can only be found with physical access to the box. You need to open it, and you will find a label with a QR Code.
+
 On this label, there is a 15-character code that represents the serial number of the box.
 
-![How to find your Diagral Serial](docs/how-to-find-diagral-serial.png)
+![How to find your Diagral Serial](https://raw.githubusercontent.com/mguyard/pydiagral/main/docs/how-to-find-diagral-serial.png)
 
 > [!IMPORTANT]
 >
 > This code is necessary to use this library and Diagral API.
 
-## API Structure
+# 🤝 Contribution
+
+Contributions are welcome! Here are several ways you can contribute:
+
+- **Submit Pull Requests**: Review open PRs, and submit your own PRs.
+- **Report Issues**: Submit bugs found or log feature requests.
 
-For detailed API documentation, please refer to the following sections:
+<details closed>
+    <summary>Contributing Guidelines</summary>
 
-- [API Reference](https://XXXXXXXXXXXXXXXX): Comprehensive documentation of the DiagralAPI class and its methods
-- [Data Models](https://XXXXXXXXXXXXXXXX): Description of the data structures used
-- [Exceptions](https://XXXXXXXXXXXXXXXX): List of package exceptions
+1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
+2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
+   ```sh
+   git clone https://github.com/mguyard/pydiagral
+   ```
+3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
+   ```sh
+   git checkout -b new-feature-x
+   ```
+4. **Make Your Changes**: Develop and test your changes locally.
+5. **Commit Your Changes**: Commit your changes with a clear and concise message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
+   ```sh
+   git commit -m 'feat: Implemented new feature x.'
+   ```
+6. **Push to GitHub**: Push the changes to your forked repository.
+   ```sh
+   git push origin new-feature-x
+   ```
+7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
 
-## Contribution
+Once your PR is reviewed and approved, it will be merged into the `beta` branch. After final testing, it will be merged into the `main` branch.
 
-Contributions to pydiagral are welcome! Please check our contribution guidelines for more information on how to participate in the development of this library.
+</details>
 
-## License
+# 📄 License
 
 pydiagral is distributed under the GPL-v3 License. See the [LICENSE](https://github.com/mguyard/pydiagral/blob/main/LICENSE) file for more details.

{pydiagral-1.4.0 → pydiagral-1.5.0}/README.md

@@ -1,9 +1,6 @@
 <p align="center">
   <img src="https://raw.githubusercontent.com/mguyard/pydiagral/main/docs/pydiagral-Logo.png" width="400" />
 </p>
-<p align="center">
-    <h1 align="center">PyDiagral</h1>
-</p>
 <p align="center">
     A powerful and easy-to-use Python library for seamless integration with the Diagral alarm system.
 </p>
@@ -28,19 +25,25 @@
 </p>
 <br /><br />
 
-# Documentation pydiagral
+# pydiagral
 
 Welcome to the documentation for pydiagral, a Python library for interacting with the Diagral API.
 
-## About pydiagral
+## 📍 About pydiagral
 
-pydiagral is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.
+`pydiagral` is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.
 
-## Requirement
+> [!CAUTION]
+>
+> Please note that the Diagral alarm system is a security system, and it may be preferable not to connect it to any automation platform for security reasons.
+> In no event shall the developer of [`pydiagral`](https://github.com/mguyard/pydiagral) library be held liable for any issues arising from the use of this [`pydiagral`](https://github.com/mguyard/pydiagral) library.
+> The user installs and uses this integration at their own risk and with full knowledge of the potential implications.
+
+## ✅ Requirement
 
 To use this library, which leverages the Diagral APIs, you must have a Diagral box (DIAG56AAX). This box connects your Diagral alarm system to the internet, enabling interaction with the alarm system via the API. You can find more information about the Diagral box [here](https://www.diagral.fr/commande/box-alerte-et-pilotage).
 
-## Key Features
+## 📦 Key Features
 
 The `DiagralAPI` class offers the following functionalities:
 
@@ -65,7 +68,7 @@ The `DiagralAPI` class offers the following functionalities:
   - Activate or Desactivate system (partially or globally)
   - Automatism actions
 
-## Quick Start
+## 🚀 Quick Start
 
 To get started with pydiagral, follow these steps:
 
@@ -95,33 +98,72 @@ And run the [example_code.py](https://github.com/mguyard/pydiagral/blob/main/exa
 >
 > 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.
 
+# 📖 Documentations
+
+## Package Documentation
+
+Library documentation is available [here](https://mguyard.github.io/pydiagral/).
+
+### Package Structure
+
+For detailed library documentation, please refer to the following sections:
+
+- [API Reference](https://mguyard.github.io/pydiagral/api/): Comprehensive documentation of the DiagralAPI class and its methods
+- [Data Models](https://mguyard.github.io/pydiagral/models/): Description of the data structures used
+- [Exceptions](https://mguyard.github.io/pydiagral/exceptions/): List of package exceptions
+
 ## Diagral API Official documentation
 
 Official Diagral API is available [here](https://appv3.tt-monitor.com/emerald/redoc).
 
+# 🙋 FAQ
+
 ## How to find Serial on DIAG56AAX
 
 The serial number can only be found with physical access to the box. You need to open it, and you will find a label with a QR Code.
+
 On this label, there is a 15-character code that represents the serial number of the box.
 
-![How to find your Diagral Serial](docs/how-to-find-diagral-serial.png)
+![How to find your Diagral Serial](https://raw.githubusercontent.com/mguyard/pydiagral/main/docs/how-to-find-diagral-serial.png)
 
 > [!IMPORTANT]
 >
 > This code is necessary to use this library and Diagral API.
 
-## API Structure
+# 🤝 Contribution
+
+Contributions are welcome! Here are several ways you can contribute:
+
+- **Submit Pull Requests**: Review open PRs, and submit your own PRs.
+- **Report Issues**: Submit bugs found or log feature requests.
 
-For detailed API documentation, please refer to the following sections:
+<details closed>
+    <summary>Contributing Guidelines</summary>
 
-- [API Reference](https://XXXXXXXXXXXXXXXX): Comprehensive documentation of the DiagralAPI class and its methods
-- [Data Models](https://XXXXXXXXXXXXXXXX): Description of the data structures used
-- [Exceptions](https://XXXXXXXXXXXXXXXX): List of package exceptions
+1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
+2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
+   ```sh
+   git clone https://github.com/mguyard/pydiagral
+   ```
+3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
+   ```sh
+   git checkout -b new-feature-x
+   ```
+4. **Make Your Changes**: Develop and test your changes locally.
+5. **Commit Your Changes**: Commit your changes with a clear and concise message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
+   ```sh
+   git commit -m 'feat: Implemented new feature x.'
+   ```
+6. **Push to GitHub**: Push the changes to your forked repository.
+   ```sh
+   git push origin new-feature-x
+   ```
+7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
 
-## Contribution
+Once your PR is reviewed and approved, it will be merged into the `beta` branch. After final testing, it will be merged into the `main` branch.
 
-Contributions to pydiagral are welcome! Please check our contribution guidelines for more information on how to participate in the development of this library.
+</details>
 
-## License
+# 📄 License
 
 pydiagral is distributed under the GPL-v3 License. See the [LICENSE](https://github.com/mguyard/pydiagral/blob/main/LICENSE) file for more details.

{pydiagral-1.4.0 → pydiagral-1.5.0}/docs/index.md

@@ -8,6 +8,12 @@ Welcome to the documentation for pydiagral, a Python library for interacting wit
 
 pydiagral is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.
 
+> [!CAUTION]
+>
+> Please note that the Diagral alarm system is a security system, and it may be preferable not to connect it to any automation platform for security reasons.
+> In no event shall the developer of [`pydiagral`](https://github.com/mguyard/pydiagral) library be held liable for any issues arising from the use of this [`pydiagral`](https://github.com/mguyard/pydiagral) library.
+> The user installs and uses this integration at their own risk and with full knowledge of the potential implications.
+
 ## Requirement
 
 To use this library, which leverages the Diagral APIs, you must have a Diagral box (DIAG56AAX). This box connects your Diagral alarm system to the internet, enabling interaction with the alarm system via the API. You can find more information about the Diagral box [here](https://www.diagral.fr/commande/box-alerte-et-pilotage).