weclapp-client 0.1.0a1__tar.gz

weclapp_client-0.1.0a1/.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "@Hochfrequenz/python-developers-review-team"
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

weclapp_client-0.1.0a1/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: "29 14 * * 6"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4.38.2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v4.38.2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4.38.2

weclapp_client-0.1.0a1/.github/workflows/coverage.yml

@@ -0,0 +1,23 @@
+name: "Coverage"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install Dependencies
+        run: uv sync --group coverage
+      - name: Run Tests and Record Coverage
+        working-directory: unittests
+        run: |
+          uv run coverage run -m pytest --basetemp=.tmp
+          uv run coverage html --omit .venv/*,unittests/*
+          uv run coverage report --fail-under 80 --omit .venv/*,unittests/*

weclapp_client-0.1.0a1/.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,18 @@
+name: Dependabot auto-approve / -merge
+on: pull_request
+
+jobs:
+  dependabot:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    env:
+      PR_URL: ${{github.event.pull_request.html_url}}
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Approve a PR
+        run: gh pr review --approve "$PR_URL"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --squash "$PR_URL"

weclapp_client-0.1.0a1/.github/workflows/dev_test.yml

@@ -0,0 +1,23 @@
+name: "Test Dev Environment"
+# Checks that the dev environment (uv sync --group dev) can be set up.
+# This might not work, if different linting/testing groups refer to different versions of the same lib (e.g. typing-extensions).
+# Different versions of the same package might work for isolated specific groups (only linting, only testing...) but the dev group inherits from all of them.
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Create a Dev Environment
+        run: uv sync --group dev

weclapp_client-0.1.0a1/.github/workflows/formatting.yml

@@ -0,0 +1,30 @@
+name: "Formatting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  format:
+    # the "black"/"isort" matrix values are kept only so the required status check names
+    # ("format (black)", "format (isort)") stay stable; both now run ruff under the hood.
+    # Renaming them would require updating the branch protection required-checks list too.
+    name: "format (${{ matrix.tool }})"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - tool: code
+            command: ruff format --check .
+          - tool: imports
+            command: ruff check --select I .
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install dependencies
+        run: uv sync --group linting
+      - name: ${{ matrix.tool }} Code Formatter
+        run: uv run ${{ matrix.command }}

weclapp_client-0.1.0a1/.github/workflows/no_byte_order_mark.yml

@@ -0,0 +1,15 @@
+name: Prevent ByteOrderMarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  bom-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: arma-actions/bom-check@v1
+        name: Check for BOM

weclapp_client-0.1.0a1/.github/workflows/packaging_test.yml

@@ -0,0 +1,21 @@
+name: "Packaging Test"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check_packaging:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install dependencies
+        run: uv sync --group packaging
+      - name: Run Packaging Test
+        run: |
+          uv run python -m build
+          uv run twine check dist/*

weclapp_client-0.1.0a1/.github/workflows/python-publish.yml

@@ -0,0 +1,56 @@
+# Publishes the package to PyPI via trusted publishing when a GitHub release with a tag "v*" is published.
+#
+# One-time setup (see README, section "Releasing"):
+# - GitHub environment "release" in the repository settings. If its deployment branches are restricted, add a rule of
+#   type *Tag* matching "v*": a release deploys from the tag, not from a branch.
+# - Trusted publisher on PyPI: project "weclapp-client", owner "Hochfrequenz", repository "weclapp_client.py",
+#   workflow "python-publish.yml", environment "release".
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  tests:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install dependencies
+        run: uv sync --group tests
+      - name: Run tests
+        run: uv run pytest
+
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI
+    runs-on: ubuntu-latest
+    needs: tests
+    # strongly recommended by PyPI for trusted publishing: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+    environment: release
+    permissions:
+      # mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          # hatch-vcs derives the version from the git tag
+          fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install dependencies
+        run: uv sync --group packaging
+      - name: Build wheel and source distributions
+        run: uv run python -m build
+      - name: Check distributions
+        run: uv run twine check dist/*
+      - name: Publish distributions to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

weclapp_client-0.1.0a1/.github/workflows/pythonlint.yml

@@ -0,0 +1,38 @@
+name: "Linting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  lint:
+    # the name must not depend on the commands below: repositories built from this template use it as a
+    # required status check in their branch ruleset, and GitHub would otherwise append the whole command
+    # string - so renaming the package, or any edit to a lint invocation, silently makes the required
+    # check unreportable and blocks every pull request
+    name: "Python Code Quality and Lint (${{ matrix.linter-env }})"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - linter-env: linting
+            commands: |
+              uv run ruff check src/weclapp_client unittests
+          - linter-env: type_check
+            commands: |
+              uv run mypy --show-error-codes src/weclapp_client --strict
+              uv run mypy --show-error-codes unittests --strict
+          - linter-env: spell_check
+            commands: |
+              uv run codespell --ignore-words=domain-specific-terms.txt src
+              uv run codespell --ignore-words=domain-specific-terms.txt README.md
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: "3.14"
+      - name: Install Dependencies
+        run: uv sync --group ${{ matrix.linter-env }}
+      - name: Run ${{ matrix.linter-env }}
+        run: ${{ matrix.commands }}

weclapp_client-0.1.0a1/.github/workflows/unittests.yml

@@ -0,0 +1,23 @@
+name: "Unittests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: uv sync --group tests
+      - name: Run the Unit Tests
+        run: uv run pytest

weclapp_client-0.1.0a1/.gitignore

@@ -0,0 +1,138 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+.idea/
+
+# vscode settings
+.vscode/
+
+
+# pytest basetemp used by the coverage workflow
+.tmp/

weclapp_client-0.1.0a1/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# to update all repo revisions just run: pre-commit autoupdate
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+        files: ^(src/weclapp_client|unittests)/
+      - id: ruff-format