mdq-models 0.1.0__tar.gz

mdq_models-0.1.0/.gitattributes

@@ -0,0 +1,12 @@
+* text=auto eol=lf
+*.go	text eol=lf
+*.py	text eol=lf
+*.json	text eol=lf
+*.proto	text eol=lf
+*.md	text eol=lf
+*.yml	text eol=lf
+*.golden	text eol=lf
+# the encoding fixtures contain a BOM, UTF-16 and invalid UTF-8: git must not touch their bytes
+testdata/*/invalid/utf8_bom.json	-text
+testdata/*/invalid/utf16_encoded.json	-text
+testdata/*/invalid/invalid_utf8_bytes.json	-text

mdq_models-0.1.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

mdq_models-0.1.0/.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"

mdq_models-0.1.0/.github/workflows/go-lint.yml

@@ -0,0 +1,28 @@
+name: "Go Lint"
+
+on:
+  pull_request: {}
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    name: lint
+    env:
+      # The linter runs on Go 1.27.x, the version named in go.mod.
+      GOTOOLCHAIN: go1.27.0
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v7
+        with:
+          go-version: "1.27.x"
+      - uses: actions/checkout@v7
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v9
+        with:
+          version: v2.15.0
+          args: --enable dupl,gocyclo
+      - name: fmt
+        run: golangci-lint fmt --diff --enable gofmt

mdq_models-0.1.0/.github/workflows/go-test.yml

@@ -0,0 +1,30 @@
+name: "Go Tests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Only supported Go releases; matching go.mod: 1.27.0 (1.23 is end of life)
+        go-version: ["1.27.x"]
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v7
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Checkout code
+        uses: actions/checkout@v7
+      - name: Vet
+        run: go vet ./...
+      - name: Test
+        run: go test -race -covermode=atomic -coverprofile=coverage.out ./...
+      - name: Coverage
+        run: go tool cover -func=coverage.out | tail -1

mdq_models-0.1.0/.github/workflows/packaging-test.yml

@@ -0,0 +1,40 @@
+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.3.2
+        with:
+          python-version: "3.15"
+      - name: Build distributions
+        run: uv build
+      - name: Check distributions
+        run: uv publish --dry-run
+      - name: Check that the wheel has no top-level modules
+        run: |
+          unzip -Z1 dist/*.whl
+          if unzip -Z1 dist/*.whl | grep -E '\.py$' | grep -v '^mdq_models/'; then
+            echo "the wheel contains .py files outside mdq_models/" >&2
+            exit 1
+          fi
+      - name: Install the wheel into a fresh venv and import it
+        run: |
+          uv venv "$RUNNER_TEMP/wheel-venv"
+          uv pip install --python "$RUNNER_TEMP/wheel-venv" dist/*.whl
+          cd "$RUNNER_TEMP"
+          "$RUNNER_TEMP/wheel-venv/bin/python" -c "import mdq_models as m; assert m.__version__; print(m.__version__)"
+      - name: Install the wheel with the polars extra and import the Polars module
+        run: |
+          uv venv "$RUNNER_TEMP/wheel-venv-polars"
+          wheel=$(ls dist/*.whl)
+          uv pip install --python "$RUNNER_TEMP/wheel-venv-polars" "${wheel}[polars]"
+          cd "$RUNNER_TEMP"
+          "$RUNNER_TEMP/wheel-venv-polars/bin/python" -c "import mdq_models.polars as p; print(len(p.CANONICAL_COLUMNS))"

mdq_models-0.1.0/.github/workflows/proto.yml

@@ -0,0 +1,63 @@
+name: "Proto"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+permissions:
+  contents: read
+
+jobs:
+  buf:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0 # buf breaking compares against the PR base branch in the local clone
+      # `buf build` fails on a module without any .proto file ("had no .proto files"), so the buf
+      # steps are guarded instead of committing a placeholder: the job stays green (and the status
+      # check keeps existing) until the first .proto file lands, and enforces everything afterwards.
+      - name: Detect .proto files
+        id: detect
+        env:
+          BASE_REF: ${{ github.base_ref }}
+        run: |
+          if [ -n "$(find proto -name '*.proto' 2>/dev/null)" ]; then
+            echo "present=true" >> "$GITHUB_OUTPUT"
+          elif [ -n "$BASE_REF" ] && git ls-tree -r --name-only "origin/$BASE_REF" | grep -q '\.proto$'; then
+            echo "origin/$BASE_REF has .proto files but this PR has none: refusing to skip buf." >&2
+            exit 1
+          else
+            echo "present=false" >> "$GITHUB_OUTPUT"
+            echo "No .proto files yet, skipping buf."
+          fi
+      - name: Install Go
+        if: steps.detect.outputs.present == 'true'
+        uses: actions/setup-go@v7
+        with:
+          go-version: "1.27.x"
+      - name: Install buf
+        if: steps.detect.outputs.present == 'true'
+        run: go install github.com/bufbuild/buf/cmd/buf@v1.75.0
+      - name: buf build
+        if: steps.detect.outputs.present == 'true'
+        run: buf build
+      - name: buf lint
+        if: steps.detect.outputs.present == 'true'
+        run: buf lint
+      - name: buf format
+        if: steps.detect.outputs.present == 'true'
+        run: buf format --diff --exit-code
+      # Compare against the local clone (works without network access to the remote). Only on pull
+      # requests, and skipped while the base branch has no .proto files: there is nothing to compare to.
+      - name: buf breaking
+        if: steps.detect.outputs.present == 'true' && github.event_name == 'pull_request'
+        env:
+          BASE_REF: ${{ github.base_ref }}
+        run: |
+          if git ls-tree -r --name-only "origin/$BASE_REF" | grep -q '\.proto$'; then
+            buf breaking --against ".git#branch=origin/$BASE_REF"
+          else
+            echo "origin/$BASE_REF has no .proto files yet, skipping buf breaking"
+          fi

mdq_models-0.1.0/.github/workflows/python-coverage.yml

@@ -0,0 +1,23 @@
+name: "Python 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.3.2
+        with:
+          python-version: "3.15"
+      - name: Install dependencies
+        run: uv sync --locked --group coverage --extra polars
+      - name: Run Tests and Record Coverage
+        run: |
+          uv run --locked --extra polars coverage run -m pytest unittests
+          uv run --locked --extra polars coverage html --omit 'unittests/*,.venv/*'
+          uv run --locked --extra polars coverage report --fail-under 80 --omit 'unittests/*,.venv/*'

mdq_models-0.1.0/.github/workflows/python-formatting.yml

@@ -0,0 +1,28 @@
+name: "Python Formatting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+jobs:
+  format:
+    name: "format (${{ matrix.tool }})"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - tool: ruff-format
+            command: "ruff format --check ."
+          - tool: ruff-isort
+            command: "ruff check --select I ."
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.15"
+      - name: Install dependencies
+        run: uv sync --locked --group linting
+      - name: ${{ matrix.tool }}
+        run: uv run --locked ${{ matrix.command }}

mdq_models-0.1.0/.github/workflows/python-lint.yml

@@ -0,0 +1,36 @@
+name: "Python Lint"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+jobs:
+  pylint:
+    name: "Python Code Quality and Lint (${{ matrix.linter-env }})"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - linter-env: linting
+            commands: |
+              uv run --locked ruff check src/mdq_models unittests
+          - linter-env: type_check
+            extras: "--extra polars"  # mypy needs polars to check mdq_models.polars
+            commands: |
+              uv run --locked --extra polars mypy --show-error-codes src/mdq_models --strict
+              uv run --locked --extra polars mypy --show-error-codes unittests --strict
+          - linter-env: spell_check
+            commands: |
+              uv run --locked codespell --ignore-words=domain-specific-terms.txt src
+              uv run --locked codespell --ignore-words=domain-specific-terms.txt unittests README.md doc.go
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.15"
+      - name: Install Dependencies
+        run: uv sync --locked --group ${{ matrix.linter-env }} ${{ matrix.extras }}
+      - name: Run ${{ matrix.linter-env }}
+        run: ${{ matrix.commands }}

mdq_models-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,58 @@
+name: "Publish to PyPI"
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+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.3.2
+        with:
+          python-version: "3.15"
+      - name: Install dependencies
+        run: uv sync --locked --group tests --group linting --group coverage --group type_check
+      - name: Run tests
+        run: uv run --locked pytest unittests
+      - name: Run tests with the polars extra
+        run: uv run --locked --extra polars pytest unittests
+      - name: Run linting
+        run: |
+          uv run --locked ruff check src/mdq_models unittests
+      - name: Run type_check
+        run: |
+          uv run --locked mypy --show-error-codes src/mdq_models --strict
+          uv run --locked mypy --show-error-codes unittests --strict
+      - name: Run coverage
+        run: |
+          uv run --locked coverage run -m pytest unittests
+          uv run --locked coverage report --fail-under 80 --omit 'unittests/*,.venv/*'
+
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: read # job-level permissions replace the workflow-level ones; checkout needs this
+      id-token: write
+    needs: tests
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0 # hatch-vcs derives the package version from the git tag
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.15"
+      - name: Build wheel and source distributions
+        run: uv build
+      - name: Publish distribution to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

mdq_models-0.1.0/.github/workflows/python-test.yml

@@ -0,0 +1,26 @@
+name: "Python Tests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+jobs:
+  pytest:
+    name: "pytest (py${{ matrix.python-version }} ${{ matrix.extras || 'no extras' }})"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
+        os: [ubuntu-latest]
+        extras: ["", "--extra polars"]  # once without and once with the optional polars extra
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: uv sync --locked --group tests ${{ matrix.extras }}
+      - name: Run the Unit Tests
+        run: uv run --locked ${{ matrix.extras }} pytest unittests

mdq_models-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Go
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.test
+*.out
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.tox/
+.mypy_cache/
+htmlcov/
+.coverage
+src/mdq_models/_version.py
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Env
+.env
+.venv/
+coverage.out

mdq_models-0.1.0/.golangci.yml

@@ -0,0 +1,19 @@
+version: "2"
+linters:
+  default: standard
+  enable:
+    - revive
+  settings:
+    revive:
+      enable-default-rules: false
+      rules:
+        - name: exported
+          arguments:
+            - checkPrivateReceivers
+            - sayRepetitiveInsteadOfStutters
+        - name: package-comments
+  exclusions:
+    rules:
+      - path: _test\.go
+        linters:
+          - revive

mdq_models-0.1.0/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.