kuckuck 0.0.1__tar.gz

kuckuck-0.0.1/.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"

kuckuck-0.0.1/.github/workflows/build_executable.yml

@@ -0,0 +1,123 @@
+name: "Build Executable"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+  release:
+    types: [created]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            tox_env: build_executable
+            artifact: kuckuck_windows
+            binary: kuckuck_windows.exe
+          - os: macos-latest
+            tox_env: build_executable_macos
+            artifact: kuckuck_macos_arm64
+            binary: kuckuck_macos_arm64
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Build Executable
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+          tox -e ${{ matrix.tox_env }}
+      - name: Freeze build dependencies
+        run: tox exec -e ${{ matrix.tox_env }} -- pip freeze > dist/build-dependencies.txt
+        shell: bash
+      - name: Upload Executable as Artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: ${{ matrix.artifact }}
+          path: |
+            dist/${{ matrix.binary }}
+            dist/build-dependencies.txt
+
+  smoke_test:
+    needs: build
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            artifact: kuckuck_windows
+            binary: kuckuck_windows.exe
+          - os: macos-latest
+            artifact: kuckuck_macos_arm64
+            binary: kuckuck_macos_arm64
+    runs-on: ${{ matrix.os }}
+    name: "Smoke Test (${{ matrix.os }})"
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Download Executable
+        uses: actions/download-artifact@v8
+        with:
+          name: ${{ matrix.artifact }}
+          path: dist
+      # actions/upload-artifact zips contents and the zip format does not
+      # reliably preserve Unix mode bits on download — restore +x.
+      - name: Make binary executable (macOS)
+        if: matrix.os == 'macos-latest'
+        run: chmod +x dist/${{ matrix.binary }}
+        shell: bash
+      - name: Smoke Test
+        run: python unittests/smoke_test_exe.py dist/${{ matrix.binary }}
+
+  release:
+    needs: [build, smoke_test]
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download Windows Executable
+        uses: actions/download-artifact@v8
+        with:
+          name: kuckuck_windows
+          path: dist/windows
+        continue-on-error: true
+      - name: Download macOS Executable
+        uses: actions/download-artifact@v8
+        with:
+          name: kuckuck_macos_arm64
+          path: dist/macos
+        continue-on-error: true
+      - name: Rename Executables with version
+        run: |
+          set -eu
+          mkdir -p dist/release
+          if [ -f ./dist/windows/kuckuck_windows.exe ]; then
+            mv ./dist/windows/kuckuck_windows.exe \
+              ./dist/release/kuckuck_windows_${{ github.ref_name }}.exe
+          else
+            echo "::warning::Windows artifact missing; skipping"
+          fi
+          if [ -f ./dist/macos/kuckuck_macos_arm64 ]; then
+            mv ./dist/macos/kuckuck_macos_arm64 \
+              ./dist/release/kuckuck_macos_arm64_${{ github.ref_name }}
+          else
+            echo "::warning::macOS arm64 artifact missing; skipping"
+          fi
+          ls -la dist/release/
+      - name: Upload Executable to Release
+        uses: softprops/action-gh-release@v3
+        with:
+          files: |
+            ./dist/release/kuckuck_windows_${{ github.ref_name }}.exe
+            ./dist/release/kuckuck_macos_arm64_${{ github.ref_name }}
+          fail_on_unmatched_files: false

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

kuckuck-0.0.1/.github/workflows/coverage.yml

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

kuckuck-0.0.1/.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"

kuckuck-0.0.1/.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", "3.13", "3.14"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        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

kuckuck-0.0.1/.github/workflows/formatting.yml

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

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

kuckuck-0.0.1/.github/workflows/packaging_test.yml

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

kuckuck-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,75 @@
+# Publishes the Kuckuck wheel + sdist to PyPI on GitHub releases tagged `v*`.
+#
+# Prerequisites (one-time, done outside this repo):
+#   1. A GitHub environment named `release` exists on Hochfrequenz/kuckuck
+#      (Repo Settings -> Environments -> New environment).
+#   2. PyPI has a Trusted Publisher registered for this workflow:
+#      Owner  = Hochfrequenz
+#      Repo   = kuckuck
+#      Workflow file = python-publish.yml
+#      Environment   = release
+#      Register at https://pypi.org/manage/account/publishing/
+#
+# When a release tagged `v<version>` is created on GitHub:
+#   - The `tests` job re-runs the full test suite on the tagged commit.
+#   - The `build-n-publish` job builds wheel + sdist and uploads to PyPI
+#     via OIDC (no API token needed thanks to the trusted publisher).
+
+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.14"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        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
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.14"]
+        os: [ubuntu-latest]
+    # Required by PyPI trusted publishing:
+    # https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+    environment: release
+    permissions:
+      # Mandatory for trusted publishing via OIDC.
+      id-token: write
+    needs: tests
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[packaging]
+      - name: Build wheel and source distribution
+        run: |
+          python -m build
+      - name: Publish distribution to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

kuckuck-0.0.1/.github/workflows/pythonlint.yml

@@ -0,0 +1,26 @@
+name: "Linting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pylint:
+    name: Python Code Quality and Lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        linter-env: ["linting", "type_check", "spell_check"]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - 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 }}

kuckuck-0.0.1/.github/workflows/unittests.yml

@@ -0,0 +1,27 @@
+name: "Unittests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        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

kuckuck-0.0.1/.gitignore

@@ -0,0 +1,142 @@
+# 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/
+
+src/_kuckuck_version.py
+
+# Kuckuck artifacts (never commit)
+.kuckuck-key
+*.kuckuck-map.enc
+*.pseudonymized.*
+kuckuck-log.jsonl

kuckuck-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hochfrequenz Unternehmensberatung GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.