voids 0.1.4__tar.gz

voids-0.1.4/.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

voids-0.1.4/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

voids-0.1.4/.github/ISSUE_TEMPLATE/issue.yml

@@ -0,0 +1,23 @@
+name: Issue
+description: Report a problem or propose a change.
+title: "[Issue]: "
+body:
+  - type: dropdown
+    id: expected-impact
+    attributes:
+      label: Expected Impact
+      description: Select the expected impact of this issue.
+      options:
+        - Minor
+        - Regular
+        - Major
+    validations:
+      required: true
+  - type: textarea
+    id: overview
+    attributes:
+      label: Overview
+      description: Provide a brief description of the issue.
+      placeholder: Describe the issue, motivation, or observed problem.
+    validations:
+      required: true

voids-0.1.4/.github/dependabot.yml

@@ -0,0 +1,25 @@
+# Each Github Actions has versions, so we somehow need to keep it up-to-date.
+# This GH Actions is an approach to handle this problem using dependabot.
+# See docs here: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+
+version: 2
+updates:
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+
+    # list here the users to be added as reviewers in dependabot PRs
+    reviewers:
+      - volpatto
+
+    # Since we have a lot of workflows, it is better to save time and PRs
+    # and gather them into a single PR.
+    # Based on here: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates#prioritizing-meaningful-updates
+    groups:
+      github-actions:
+        patterns:
+        # A wildcard to collect all the workflows
+          - "*"

voids-0.1.4/.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## Overview
+
+Briefly describe the purpose of this pull request.
+
+## Changes
+
+Describe what code behavior has changed.

voids-0.1.4/.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          environments: docs
+          locked: false
+
+      - name: Build docs
+        run: pixi run -e docs mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

voids-0.1.4/.github/workflows/lint-diff.yml

@@ -0,0 +1,41 @@
+name: Lint Diff
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: lint-diff-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit-diff:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          environments: default
+
+      - name: Fetch PR base branch
+        shell: bash
+        run: |
+          git fetch origin \
+            "${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}"
+
+      - name: Run pre-commit on PR diff
+        shell: bash
+        run: |
+          pixi run -e default pre-commit run \
+            --from-ref "origin/${{ github.base_ref }}" \
+            --to-ref "${{ github.sha }}" \
+            --show-diff-on-failure

voids-0.1.4/.github/workflows/pixi-lock-weekly.yml

@@ -0,0 +1,45 @@
+name: Weekly Pixi Lock Update
+
+on:
+  schedule:
+    - cron: "0 6 * * 0"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency:
+  group: pixi-lock-update
+  cancel-in-progress: false
+
+jobs:
+  refresh-lockfile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          locked: false
+
+      - name: Refresh pixi.lock
+        shell: bash
+        run: pixi update --no-install
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v8
+        with:
+          branch: ci/weekly-pixi-lock
+          delete-branch: true
+          commit-message: "Update pixi lockfile"
+          title: "Update pixi lockfile"
+          body: |
+            Automated weekly refresh of `pixi.lock`.
+
+            This PR was created by the scheduled GitHub Actions workflow.
+          add-paths: |
+            pixi.lock

voids-0.1.4/.github/workflows/publish-pypi.yml

@@ -0,0 +1,88 @@
+name: Publish PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-pypi-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade build twine
+
+      - name: Validate tag matches pyproject version
+        if: github.event_name == 'push'
+        shell: bash
+        run: |
+          python - <<'PY'
+          import tomllib
+          from pathlib import Path
+
+          version = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))["project"]["version"]
+          tag = "${{ github.ref_name }}"
+          expected = f"v{version}"
+          if tag != expected:
+              raise SystemExit(f"Tag/version mismatch: got {tag!r}, expected {expected!r}")
+          print(f"Validated release tag {tag} against pyproject version {version}")
+          PY
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check distribution metadata
+        run: python -m twine check dist/*
+
+      - name: Smoke-test wheel install
+        shell: bash
+        run: |
+          python -m venv .venv-smoke
+          source .venv-smoke/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip install dist/*.whl
+          python -c "import voids; print(voids.__version__)"
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    permissions:
+      id-token: write
+      contents: read
+    environment:
+      name: pypi
+      url: https://pypi.org/project/voids/
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v5
+        with:
+          name: python-dist
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

voids-0.1.4/.github/workflows/tests.yml

@@ -0,0 +1,184 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: test (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          environments: lbm
+
+      - name: Run tests with coverage (Ubuntu only)
+        if: runner.os == 'Linux'
+        shell: bash
+        run: |
+          pixi run -e lbm pytest \
+            --cov=voids \
+            --cov-report=term-missing \
+            --cov-report=xml:coverage.xml \
+            -q
+
+      - name: Run tests
+        if: runner.os != 'Linux'
+        run: pixi run -e lbm pytest -q
+
+      - name: Upload coverage artifact
+        if: runner.os == 'Linux'
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-xml
+          path: coverage.xml
+
+      - name: Fetch PR base branch
+        if: runner.os == 'Linux' && github.event_name == 'pull_request'
+        shell: bash
+        run: |
+          git fetch origin \
+            "${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}"
+
+      - name: Check diff coverage threshold
+        id: diff_cover
+        if: runner.os == 'Linux' && github.event_name == 'pull_request'
+        continue-on-error: true
+        shell: bash
+        run: |
+          python -m pip install --disable-pip-version-check diff-cover
+          diff-cover coverage.xml \
+            --compare-branch "origin/${{ github.base_ref }}" \
+            --fail-under=99 | tee diff-cover.txt
+
+      - name: Summarize coverage
+        id: coverage_summary
+        if: runner.os == 'Linux'
+        shell: bash
+        run: |
+          python - <<'PY'
+          import os
+          import pathlib
+          import re
+          import xml.etree.ElementTree as ET
+
+          overall = 100.0 * float(ET.parse("coverage.xml").getroot().attrib["line-rate"])
+          diff_text = ""
+          diff_path = pathlib.Path("diff-cover.txt")
+          if diff_path.exists():
+              diff_text = diff_path.read_text(encoding="utf-8")
+          match = re.search(r"(?m)^(?:Diff )?Coverage:\s+([0-9.]+)%$", diff_text)
+          diff = match.group(1) if match else "n/a"
+
+          with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as fh:
+              fh.write(f"overall={overall:.2f}\n")
+              fh.write(f"diff={diff}\n")
+          PY
+
+      - name: Comment coverage on PR
+        if: >
+          runner.os == 'Linux' &&
+          github.event_name == 'pull_request' &&
+          github.event.pull_request.head.repo.full_name == github.repository
+        uses: actions/github-script@v8
+        env:
+          OVERALL_COVERAGE: ${{ steps.coverage_summary.outputs.overall }}
+          DIFF_COVERAGE: ${{ steps.coverage_summary.outputs.diff }}
+          DIFF_STATUS: ${{ steps.diff_cover.outcome }}
+        with:
+          script: |
+            const fs = require('fs');
+            const marker = '<!-- voids-coverage-report -->';
+            const diffText = fs.existsSync('diff-cover.txt')
+              ? fs.readFileSync('diff-cover.txt', 'utf8').trim()
+              : 'diff-cover did not run.';
+            const result = process.env.DIFF_STATUS === 'success' ? 'passed' : 'failed';
+            const icon = process.env.DIFF_STATUS === 'success' ? '✅' : '❌';
+            const body = `${marker}
+            ## Coverage
+            - Overall line coverage on Ubuntu: \`${process.env.OVERALL_COVERAGE}%\`
+            - Diff coverage: \`${process.env.DIFF_COVERAGE}%\`
+            - Required diff coverage: \`99%\`
+            - Result: ${icon} ${result}
+
+            <details><summary>diff-cover output</summary>
+
+            \`\`\`text
+            ${diffText}
+            \`\`\`
+            </details>`;
+
+            const { owner, repo } = context.repo;
+            const issue_number = context.issue.number;
+            const comments = await github.paginate(github.rest.issues.listComments, {
+              owner,
+              repo,
+              issue_number,
+            });
+            const previous = comments.find(
+              (comment) =>
+                comment.user.type === 'Bot' &&
+                comment.body &&
+                comment.body.includes(marker),
+            );
+
+            if (previous) {
+              await github.rest.issues.updateComment({
+                owner,
+                repo,
+                comment_id: previous.id,
+                body,
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner,
+                repo,
+                issue_number,
+                body,
+              });
+            }
+
+      - name: Upload coverage to Codecov
+        if: runner.os == 'Linux' && env.CODECOV_TOKEN != ''
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+          token: ${{ env.CODECOV_TOKEN }}
+          verbose: true
+
+      - name: Enforce diff coverage threshold
+        if: runner.os == 'Linux' && github.event_name == 'pull_request' && steps.diff_cover.outcome == 'failure'
+        shell: bash
+        run: |
+          echo "Diff coverage is below the required 99% threshold."
+          exit 1

voids-0.1.4/.github/workflows/typecheck-diff.yml

@@ -0,0 +1,29 @@
+name: Type Check Diff
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: typecheck-diff-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          environments: default
+
+      - name: Run mypy
+        shell: bash
+        run: pixi run -e default typecheck