pydiagral 1.0.0__tar.gz

pydiagral-1.0.0/.devcontainer/Dockerfile.dev

@@ -0,0 +1,30 @@
+# Use the Python 3.12 base image for development containers
+ARG VARIANT="3.12"
+FROM mcr.microsoft.com/devcontainers/python:1-${VARIANT}
+
+# Configure the shell for RUN commands
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+# Set the working directory
+WORKDIR /workspaces
+
+# Copy files into the container
+COPY pyproject.toml ./
+COPY LICENSE ./
+COPY README.md ./
+
+# Install pip-tools
+RUN pip install --upgrade pip && pip install pip-tools
+
+# Generate requirements.txt from pyproject.toml and install dependencies
+RUN pip-compile pyproject.toml -o requirements.txt && \
+    pip install -r requirements.txt
+
+# Install the project in editable mode
+RUN pip install -e .[dev]
+
+# Set the default shell to bash instead of sh
+ENV SHELL /bin/bash
+
+# Keep the container running
+CMD ["bash"]

pydiagral-1.0.0/.devcontainer/devcontainer.json

@@ -0,0 +1,48 @@
+{
+    "name": "pydiagral Dev",
+    "context": "..",
+    "dockerFile": "./Dockerfile.dev",
+    "features": {
+      "ghcr.io/devcontainers/features/github-cli:1": {}
+    },
+    "postCreateCommand": "pip install -e .",
+    "runArgs": ["-e", "GIT_EDITOR=code --wait"],
+    "customizations": {
+      "vscode": {
+        "extensions": [
+          "charliermarsh.ruff",
+          "ms-python.vscode-pylance",
+          "visualstudioexptteam.vscodeintellicode",
+          "redhat.vscode-yaml",
+          "esbenp.prettier-vscode",
+          "GitHub.vscode-pull-request-github",
+          "GitHub.copilot"
+        ],
+        // Please keep this file in sync with settings in .vscode/settings.default.json
+        "settings": {
+          "python.defaultInterpreterPath": "/usr/local/bin/python",
+          "python.pythonPath": "/usr/local/bin/python",
+          "python.terminal.activateEnvInCurrentTerminal": true,
+          "python.testing.pytestArgs": ["--no-cov"],
+          "pylint.importStrategy": "fromEnvironment",
+          "python.linting.enabled": true,
+          "python.linting.ruffEnabled": true,
+          "python.linting.pylintEnabled": false,
+          "python.linting.flake8Enabled": false,
+          "editor.formatOnPaste": false,
+          "editor.formatOnSave": true,
+          "editor.formatOnType": true,
+          "files.trimTrailingWhitespace": true,
+          "terminal.integrated.profiles.linux": {
+            "zsh": {
+              "path": "/usr/bin/zsh"
+            }
+          },
+          "terminal.integrated.defaultProfile.linux": "zsh",
+          "[python]": {
+            "editor.defaultFormatter": "charliermarsh.ruff"
+          }
+        }
+      }
+    }
+  }

pydiagral-1.0.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [mguyard]

pydiagral-1.0.0/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: 'dev'

pydiagral-1.0.0/.github/labels.yml

@@ -0,0 +1,40 @@
+---
+# Conventional Commit related labels (match entries in `semantics-prs.yml`).
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+- name: chore
+  description: Chore
+  color: bfdadc
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+- name: feature
+  description: New feature or request
+  color: a2eeef
+- name: performance
+  description: Performance
+  color: '016175'
+- name: refactoring
+  description: Refactoring
+  color: ef67c4
+- name: testing
+  description: Testing
+  color: b1fc6f
+
+# Other labels
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+- name: help wanted
+  description: Extra attention is needed
+  color: 008672
+- name: question
+  description: Further information is requested
+  color: d876e3
+- name: waiting
+  description: Waiting for something
+  color: daa036

pydiagral-1.0.0/.github/workflows/docs.yaml

@@ -0,0 +1,39 @@
+name: Generate and Deploy Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      release:
+        description: 'Release to generate and deploy documentation for'
+        required: true
+        default: 'latest'
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.release || github.ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install mkdocs mkdocstrings[python] mkdocs-material
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

pydiagral-1.0.0/.github/workflows/labeler.yml

@@ -0,0 +1,21 @@
+---
+name: Manage labels
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  labeler:
+    name: Labeler
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Run Labeler
+        uses: crazy-max/ghaction-github-labeler@v5.0.0
+        with:
+          skip-delete: true

pydiagral-1.0.0/.github/workflows/lint.yaml

@@ -0,0 +1,26 @@
+name: Ruff Linter
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ main, beta ]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Branch to run linter on'
+        required: true
+        default: 'dev'
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    if: github.event_name != 'workflow_dispatch' || github.event.inputs.branch == 'dev'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.inputs.branch || github.ref }}
+    - uses: chartboost/ruff-action@v1
+      with:
+        args: check --output-format=github --verbose
+        src: "."

pydiagral-1.0.0/.github/workflows/lock.yml

@@ -0,0 +1,21 @@
+name: Lock
+
+# yamllint disable-line rule:truthy
+on:
+  schedule:
+    - cron: '23 13 * * *'
+  workflow_dispatch:
+
+jobs:
+  lock:
+    if: github.repository_owner == 'mguyard'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v5.0.1
+        with:
+          github-token: ${{ github.token }}
+          issue-inactive-days: '30'
+          issue-lock-reason: ''
+          pr-inactive-days: '30'
+          pr-lock-reason: ''
+          log-output: true

pydiagral-1.0.0/.github/workflows/pytest.yaml

@@ -0,0 +1,50 @@
+name: PyTest
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ main, beta ]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Branch to run linter on'
+        required: true
+        default: 'dev'
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'  # Replace with the version of Python you are using
+
+    - name: Set the PYPROJECT_VERSION environment variable
+      run: echo "PYPROJECT_VERSION=0.1.0-dev" >> $GITHUB_ENV
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools wheel hatchling
+        pip install pytest pytest-asyncio pytest-html
+
+    - name: Install pydiagral
+      run: |
+        pip install --upgrade hatchling
+        pip install -e .
+
+    - name: Run tests
+      run: |
+        pytest -v --html=report.html --self-contained-html
+
+    - name: Upload test report
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-report
+        path: report.html

pydiagral-1.0.0/.github/workflows/release.yaml

@@ -0,0 +1,57 @@
+name: Generate Release and publish to PyPI
+
+on:
+  push:
+    branches:
+      - main
+      - beta
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    environment:
+      name: Semver
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install hatchling twine
+
+      - 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 }}
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Show version
+        if: steps.semantic.outputs.new_release_published == 'true'
+        run: |
+          echo ${{ steps.semantic.outputs.new_release_version }}
+          echo ${{ steps.semantic.outputs.new_release_major_version }}
+          echo ${{ steps.semantic.outputs.new_release_minor_version }}
+          echo ${{ steps.semantic.outputs.new_release_patch_version }}
+
+      - name: Build package
+        if: steps.semantic.outputs.new_release_published == 'true'
+        run: python -m hatchling build
+        env:
+          PYPROJECT_VERSION: ${{ steps.semantic.outputs.new_release_version }}
+
+      - name: Publish to PyPI
+        if: steps.semantic.outputs.new_release_published == 'true'
+        run: twine upload dist/* -u __token__ -p "${{ secrets.PYPI_TOKEN }}"

pydiagral-1.0.0/.github/workflows/semantic-prs.yml

@@ -0,0 +1,20 @@
+---
+name: Semantic PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ytanikin/PRConventionalCommits@1.2.0
+        with:
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore"]'
+          custom_labels: '{"feat": "feature", "fix": "bug", "docs": "documentation", "test": "testing", "ci": "ci", "refactor": "refactoring", "perf": "performance", "chore": "chore"}'

pydiagral-1.0.0/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Exclusion of env file
+.env

pydiagral-1.0.0/.releaserc

@@ -0,0 +1,27 @@
+{
+    "branches": [
+        "main",
+        {
+            "name": "beta",
+            "prerelease": true
+        }
+    ],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "CHANGELOG.md"
+            }
+        ],
+        ["@semantic-release/git", {
+            "assets": [
+                "CHANGELOG.md",
+                "pyproject.toml"
+            ],
+            "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }],
+        "@semantic-release/github"
+        ]
+}

pydiagral-1.0.0/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+      "charliermarsh.ruff",
+      "esbenp.prettier-vscode",
+      "ms-python.python"
+    ]
+  }

pydiagral-1.0.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

pydiagral-1.0.0/CHANGELOG.md

@@ -0,0 +1,41 @@
+# 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))