Initial commit

.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"

.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@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        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@v3
+
+      # ℹ️ 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@v3

.github/workflows/coverage.yml

@@ -0,0 +1,26 @@
+name: "Coverage"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Tests and Record Coverage
+        run: |
+          tox -e coverage

.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"

.github/workflows/dev_test.yml

@@ -0,0 +1,28 @@
+name: "Test Dev Environment"
+# Checks that the dev environment (tox -e dev) can be set up.
+# This might not work, if different linting/testing envs refer to different versions of the same lib (e.g. typing-extensions).
+# Different versions of the same package might work for isolated specific envs (only linting, only testing...) but the dev environment 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"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Create a Dev Environment
+        run: |
+          tox -e dev

.github/workflows/formatting.yml

@@ -0,0 +1,27 @@
+name: "Formatting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  black:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        tool: ["black", "isort"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev_requirements/requirements-formatting.txt
+      - name: ${{ matrix.tool }} Code Formatter
+        run: |
+          ${{ matrix.tool }} . --check

.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@v4
+      - uses: arma-actions/bom-check@v1
+        name: Check for BOM

.github/workflows/packaging_test.yml

@@ -0,0 +1,26 @@
+name: "Packaging Test"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check_packaging:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Packaging Test
+        run: |
+          tox -e test_packaging

.github/workflows/python-publish.yml

@@ -0,0 +1,62 @@
+# This GitHub workflow is only needed for python package releases which are supposed to be published on pypi.
+# It requires the Github "environments" feature (see instructions below) it might not be available for private free accounts (but works for public or organization repos).
+# After creating the "release" environment in the Github repo settings, you need to enter your Github organization/user name + repo name + "python-publish.yml" workflow file name in the PyPI UI to make this work.
+
+# This workflow uploads a Python Package using Twine when a release is created.
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# name: Upload Python Package
+
+# on:
+#   release:
+#     types: [created, edited]
+
+# jobs:
+#   tests:
+#     if: startsWith(github.ref, 'refs/tags/v')
+#     runs-on: ${{ matrix.os }}
+#     strategy:
+#       matrix:
+#         python-version: ["3.12"]
+#         os: [ubuntu-latest]
+#     steps:
+#       - uses: actions/checkout@v4
+#       - name: Set up Python ${{ matrix.python-version }}
+#         uses: actions/setup-python@v5
+#         with:
+#           python-version: ${{ matrix.python-version }}
+#       - name: Install tox
+#         run: |
+#           python -m pip install --upgrade pip
+#           pip install tox
+#       - name: Run tox
+#         run: |
+#           tox
+
+#   build-n-publish:
+#     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+#     runs-on: ubuntu-latest
+#     # Specifying a GitHub environment, # Specifying a GitHub environment, which is strongly recommended by PyPI: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+#     # you have to create an environment in your repository settings and add the environment name here
+#     environment: release
+#     permissions:
+#         # IMPORTANT: this permission is mandatory for trusted publishing
+#         id-token: write
+#     needs: tests
+#     steps:
+#       - uses: actions/checkout@v4
+#       - name: Set up Python
+#         uses: actions/setup-python@v5
+#         with:
+#           python-version: ${{ matrix.python-version }}
+#       - name: Install dependencies
+#         run: |
+#           python -m pip install --upgrade pip
+#           pip install -r dev_requirements/requirements-packaging.txt
+#       - name: Build wheel and source distributions
+#         run: |
+#           python -m build
+#       - name: Publish distribution 📦 to PyPI
+#         if: startsWith(github.ref, 'refs/tags/v')
+#         uses: pypa/gh-action-pypi-publish@release/v1
+

.github/workflows/pythonlint.yml

@@ -0,0 +1,28 @@
+name: "Linting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pylint:
+    name: Python Code Quality and Lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        linter-env: ["linting", "type_check", "spell_check"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run ${{ matrix.linter-env }} via Tox
+        run: |
+          tox -e ${{ matrix.linter-env }}

.github/workflows/unittests.yml

@@ -0,0 +1,26 @@
+name: "Unittests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run the Unit Tests via Tox
+        run: |
+          tox -e tests