localqueue 1.1.0__tar.gz → 1.1.1__tar.gz

{localqueue-1.1.0 → localqueue-1.1.1}/.github/workflows/ci.yml

@@ -14,6 +14,52 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  python-quality:
+    name: Python lint and types
+    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.14'
+          cache: pip
+
+      - name: Install Python quality tools
+        run: |
+          python -m pip install --upgrade \
+            "pydantic>=2,<3" \
+            "ruff>=0.15,<1" \
+            "pyrefly>=1.1,<2"
+
+      - name: Run Ruff
+        run: |
+          ruff check .
+          ruff format --check .
+
+      - name: Run Pyrefly
+        env:
+          PYTHONPATH: python
+        run: pyrefly check --preset default --progress-bar no python/localqueue
+
+  secrets:
+    name: Secret scan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Run Gitleaks
+        uses: gitleaks/gitleaks-action@v2
+        env:
+          # The CLI result is the quality gate. Keep SARIF uploads opt-in so
+          # a transient Actions artifact quota cannot hide scan results.
+          GITLEAKS_ENABLE_UPLOAD_ARTIFACT: "false"
+
   rust-quality:
     name: Rust format and Clippy
     runs-on: ubuntu-latest
@@ -43,6 +89,18 @@ jobs:
       - name: Run Clippy
         run: cargo clippy --locked --all-targets --all-features -- -D warnings
 
+  rust-dependencies:
+    name: Rust dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Run cargo-deny
+        uses: EmbarkStudios/cargo-deny-action@v2
+        with:
+          command: check
+
   msrv:
     name: Rust MSRV 1.83
     runs-on: ubuntu-latest
@@ -81,7 +139,19 @@ jobs:
           python-version: ${{ matrix.python }}
           cache: pip
 
-      - name: Build extension and run tests in a virtual environment
+      - name: Cache Cargo dependencies and build outputs
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-py${{ matrix.python }}-${{ hashFiles('Cargo.toml', 'Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-py${{ matrix.python }}-
+            ${{ runner.os }}-cargo-
+
+      - name: Build extension in a virtual environment
         shell: bash
         run: |
           python -m venv .venv
@@ -93,13 +163,44 @@ jobs:
           python -m pip install --upgrade \
             "maturin>=1.14,<2" \
             "pytest>=8,<10" \
+            "pytest-cov>=7,<8" \
             "pydantic>=2,<3"
-          maturin develop --release --locked
+          maturin develop --locked
+
+      - name: Run tests
+        if: matrix.os != 'ubuntu-latest' || matrix.python != '3.14'
+        shell: bash
+        run: |
+          if [ "$RUNNER_OS" = "Windows" ]; then
+            source .venv/Scripts/activate
+          else
+            source .venv/bin/activate
+          fi
           pytest -ra
 
+      - name: Run tests with branch coverage
+        if: matrix.os == 'ubuntu-latest' && matrix.python == '3.14'
+        shell: bash
+        run: |
+          source .venv/bin/activate
+          pytest -ra \
+            --cov=localqueue \
+            --cov-branch \
+            --cov-report=term-missing \
+            --cov-report=xml \
+            --cov-fail-under=80
+
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-latest' && matrix.python == '3.14'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          fail_ci_if_error: false
+
   wheel-smoke:
     name: Build and smoke-test wheel
-    needs: [rust-quality, python-tests]
+    needs: [python-quality, secrets, rust-quality, rust-dependencies, python-tests]
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository

localqueue-1.1.1/.github/workflows/docs.yml

@@ -0,0 +1,68 @@
+name: Documentation
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+      - "zensical.toml"
+      - ".github/workflows/docs.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "zensical.toml"
+      - ".github/workflows/docs.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: docs-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build documentation
+    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.14'
+          cache: pip
+
+      - name: Install Zensical
+        run: python -m pip install --upgrade "zensical>=0.0.51,<0.1"
+
+      - name: Build site
+        run: zensical build --clean
+
+      - name: Upload Pages artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+
+  deploy:
+    name: Deploy documentation
+    if: github.event_name != 'pull_request'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

localqueue-1.1.1/.github/workflows/release.yml

@@ -0,0 +1,91 @@
+name: Create release tag
+
+on:
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: Calculate the next version without writing, tagging, or pushing
+        required: true
+        default: true
+        type: boolean
+
+permissions:
+  contents: write
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    name: Calculate and tag release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out main with full history
+        uses: actions/checkout@v6
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Confirm main is current
+        run: |
+          git fetch origin main --tags
+          test "$(git rev-parse HEAD)" = "$(git rev-parse origin/main)"
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install release and test tooling
+        run: |
+          python -m pip install --upgrade \
+            "python-semantic-release>=10.6,<11" \
+            "maturin>=1.14,<2" \
+            "pytest>=8,<10" \
+            "pydantic>=2,<3"
+
+      - name: Validate release history
+        run: |
+          current_version=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+          last_released=$(semantic-release version --print-last-released)
+          test "$current_version" = "$last_released" || {
+            echo "pyproject.toml is $current_version but Semantic Release sees $last_released." >&2
+            echo "Reconcile the published release tag with main before automating the next release." >&2
+            exit 1
+          }
+
+      - name: Calculate next version
+        id: version
+        run: |
+          version=$(semantic-release version --print)
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          echo "tag=v$version" >> "$GITHUB_OUTPUT"
+
+      - name: Report dry run
+        if: inputs.dry_run
+        run: |
+          echo "Next release would be ${{ steps.version.outputs.tag }}"
+
+      - name: Create local release commit and tag
+        if: inputs.dry_run == false
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: semantic-release version --no-push --no-vcs-release
+
+      - name: Validate versioned tree
+        if: inputs.dry_run == false
+        run: |
+          python scripts/check_release_version.py --tag "${{ steps.version.outputs.tag }}"
+          cargo fmt --all --check
+          cargo check --locked
+          maturin develop --release --locked
+          pytest -ra
+
+      - name: Push release commit and tag atomically
+        if: inputs.dry_run == false
+        run: |
+          git push --atomic origin HEAD:main "${{ steps.version.outputs.tag }}"

localqueue-1.1.1/.github/workflows/wheels.yml

@@ -0,0 +1,298 @@
+name: Wheels
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_ref:
+        description: Existing v* tag to publish; leave empty for a build-only run
+        required: false
+        type: string
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: read
+
+jobs:
+  prepare-release:
+    name: Prepare release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      release_mode: ${{ steps.release.outputs.release_mode }}
+      release_ref: ${{ steps.release.outputs.release_ref }}
+    steps:
+      - name: Resolve release mode
+        id: release
+        env:
+          INPUT_RELEASE_REF: ${{ inputs.release_ref }}
+          REF_NAME: ${{ github.ref_name }}
+          REF_TYPE: ${{ github.ref_type }}
+        shell: bash
+        run: |
+          if [[ -n "$INPUT_RELEASE_REF" ]]; then
+            release_ref="$INPUT_RELEASE_REF"
+            release_mode=true
+          elif [[ "$REF_TYPE" == "tag" && "$REF_NAME" == v* ]]; then
+            release_ref="$REF_NAME"
+            release_mode=true
+          else
+            release_ref="$REF_NAME"
+            release_mode=false
+          fi
+
+          if [[ "$release_mode" == true && "$release_ref" != v* ]]; then
+            echo "release_ref must start with v" >&2
+            exit 1
+          fi
+
+          echo "release_mode=$release_mode" >> "$GITHUB_OUTPUT"
+          echo "release_ref=$release_ref" >> "$GITHUB_OUTPUT"
+
+      - name: Create draft GitHub release
+        if: steps.release.outputs.release_mode == 'true'
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_REF: ${{ steps.release.outputs.release_ref }}
+        run: |
+          gh release view "$RELEASE_REF" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1 || \
+          gh release create "$RELEASE_REF" \
+              --repo "$GITHUB_REPOSITORY" \
+              --verify-tag \
+              --draft \
+              --generate-notes \
+              --title "$RELEASE_REF"
+
+      - name: Refuse to rebuild an already published release
+        if: steps.release.outputs.release_mode == 'true'
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_REF: ${{ steps.release.outputs.release_ref }}
+        run: |
+          if gh release view "$RELEASE_REF" --repo "$GITHUB_REPOSITORY" \
+            --json isDraft --jq '.isDraft == false' | grep -qx true; then
+            echo "release $RELEASE_REF is already published" >&2
+            exit 1
+          fi
+
+  validate-release:
+    name: Validate release version
+    needs: prepare-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out release source
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_ref }}
+
+      - name: Validate tag and package metadata
+        if: needs.prepare-release.outputs.release_mode == 'true'
+        run: python scripts/check_release_version.py --tag "${{ needs.prepare-release.outputs.release_ref }}"
+
+  build:
+    name: ${{ matrix.name }}
+    needs: [prepare-release, validate-release]
+    permissions:
+      contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: linux-x86_64
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            manylinux: '2_17'
+          - name: linux-aarch64
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            manylinux: '2_17'
+          - name: macos-x86_64
+            os: macos-15-intel
+            target: x86_64-apple-darwin
+            manylinux: off
+          - name: macos-arm64
+            os: macos-15
+            target: aarch64-apple-darwin
+            manylinux: off
+          - name: windows-x86_64
+            os: windows-latest
+            target: x86_64-pc-windows-msvc
+            manylinux: off
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_ref }}
+
+      - name: Set up QEMU for Linux ARM64
+        if: matrix.name == 'linux-aarch64'
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Python interpreters
+        uses: actions/setup-python@v6
+        with:
+          python-version: |
+            3.10
+            3.11
+            3.12
+            3.13
+            3.14
+
+      - name: Build wheels with maturin
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          target: ${{ matrix.target }}
+          manylinux: ${{ matrix.manylinux }}
+          args: --release --locked --find-interpreter --compatibility pypi
+          maturin-version: v1.14.1
+
+      - name: Set up smoke-test Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.13'
+
+      - name: Install one wheel for smoke testing
+        if: matrix.name != 'linux-aarch64'
+        shell: bash
+        run: |
+          python -m pip install --upgrade "pydantic>=2,<3"
+          python -m pip install --force-reinstall --no-index target/wheels/*cp313*.whl
+
+      - name: Smoke-test installed wheel outside the checkout
+        if: matrix.name != 'linux-aarch64'
+        shell: bash
+        run: |
+          cd "$RUNNER_TEMP"
+          python - <<'PY'
+          import tempfile
+
+          from localqueue import EnqueueItem, SimpleQueue
+          from localqueue.bus import BaseEvent, BusTopology, EventBus
+
+          class WheelEvent(BaseEvent):
+              value: int
+
+          with tempfile.TemporaryDirectory() as path:
+              queue = SimpleQueue(path)
+              queue.put_many([
+                  {"platform": "wheel"},
+                  EnqueueItem({"platform": "batch"}, job_id="batch-1"),
+              ])
+              job = queue.get(block=False)
+              queue.ack(job)
+              job = queue.get(block=False)
+              queue.ack(job)
+              assert queue.stats()["acked"] == 2
+              queue.close()
+
+              topology = BusTopology({"smoke": [WheelEvent]})
+              bus = EventBus(path, topology=topology)
+              smoke = bus.subscription("smoke")
+
+              @smoke.handler(WheelEvent)
+              def handle(event: WheelEvent) -> None:
+                  assert event.value == 1
+
+              receipt = bus.dispatch(WheelEvent(value=1))
+              assert receipt.subscriptions == ("smoke",)
+              bus.close()
+          PY
+
+      - name: Validate Linux ARM64 wheel artifact
+        if: matrix.name == 'linux-aarch64'
+        shell: bash
+        run: test -n "$(find target/wheels -name '*cp313*.whl' -print -quit)"
+
+      - name: Build source distribution
+        if: matrix.name == 'linux-x86_64'
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out target/dist
+          maturin-version: v1.14.1
+
+      - name: Upload wheels
+        if: needs.prepare-release.outputs.release_mode != 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.name }}
+          path: target/wheels/*.whl
+          if-no-files-found: error
+
+      - name: Upload source distribution
+        if: matrix.name == 'linux-x86_64' && needs.prepare-release.outputs.release_mode != 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: source-distribution
+          path: target/dist/*.tar.gz
+          if-no-files-found: error
+
+      - name: Upload distributions to draft GitHub release
+        if: needs.prepare-release.outputs.release_mode == 'true'
+        shell: bash
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_REF: ${{ needs.prepare-release.outputs.release_ref }}
+        run: |
+          gh release upload "$RELEASE_REF" target/wheels/*.whl \
+            --repo "$GITHUB_REPOSITORY" \
+            --clobber
+
+          if [[ "${{ matrix.name }}" == "linux-x86_64" ]]; then
+            gh release upload "$RELEASE_REF" target/dist/*.tar.gz \
+              --repo "$GITHUB_REPOSITORY" \
+              --clobber
+          fi
+
+  publish:
+    name: Publish complete release to PyPI
+    if: needs.prepare-release.outputs.release_mode == 'true'
+    needs: [prepare-release, build]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Download distributions from draft GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_REF: ${{ needs.prepare-release.outputs.release_ref }}
+        run: |
+          mkdir -p target/dist
+          gh release download "$RELEASE_REF" \
+            --repo "$GITHUB_REPOSITORY" \
+            --dir target/dist
+
+          for python_tag in cp310 cp311 cp312 cp313 cp314; do
+            wheel_count=$(find target/dist -name "*-${python_tag}-${python_tag}-*.whl" | wc -l)
+            if [[ "$wheel_count" -ne 5 ]]; then
+              echo "expected 5 wheels for $python_tag, found $wheel_count" >&2
+              exit 1
+            fi
+          done
+
+          test "$(find target/dist -name '*.tar.gz' | wc -l)" -eq 1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.3.2
+
+      - name: Publish all artifacts
+        run: |
+          uv publish \
+            --trusted-publishing always \
+            --check-url https://pypi.org/simple/ \
+            target/dist/*
+
+      - name: Publish GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_REF: ${{ needs.prepare-release.outputs.release_ref }}
+        run: |
+          gh release edit "$RELEASE_REF" \
+            --repo "$GITHUB_REPOSITORY" \
+            --draft=false \
+            --latest

{localqueue-1.1.0 → localqueue-1.1.1}/.gitignore

@@ -5,11 +5,16 @@ __pycache__/
 .pytest_cache/
 .mypy_cache/
 .ruff_cache/
+.pyrefly/
+.coverage
+coverage.xml
+htmlcov/
 *.db
 *.wal
 *.shm
 data/
 dist/
 build/
+site/
 target/
 *.so

localqueue-1.1.1/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+default_language_version:
+  python: python3.10
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.22
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.1
+    hooks:
+      - id: gitleaks
+
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: cargo fmt --all --check
+        language: system
+        pass_filenames: false

{localqueue-1.1.0 → localqueue-1.1.1}/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to `localqueue` are documented here.
 
+<!-- version list -->
+
+## [1.1.1] - 2026-07-21
+
+### Added
+
+- Zensical documentation site with a durable, two-process getting-started
+  guide and GitHub Pages deployment workflow.
+- Python branch-coverage reporting, Ruff, Pyrefly, pre-commit, Gitleaks, and
+  cargo-deny quality gates.
+- Manual Conventional Commits release workflow with Python, Cargo, lockfile,
+  tag, and wheel-release consistency checks.
+
+### Changed
+
+- The README quickstart now demonstrates a producer persisting a job before a
+  later worker process consumes it.
+- CI caches Rust build outputs and uses debug builds for test jobs while wheel
+  builds remain optimized release builds.
+
 ## [1.1.0] - 2026-07-21
 
 ### Added
@@ -80,6 +100,7 @@ storage migration:
   leases, bounded retries, dead-letter handling, receipt fencing, and
   multiprocess safety on one machine.
 
+[1.1.1]: https://github.com/brunoportis/localqueue/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/brunoportis/localqueue/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/brunoportis/localqueue/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/brunoportis/localqueue/releases/tag/v1.0.0

{localqueue-1.1.0 → localqueue-1.1.1}/Cargo.lock

@@ -97,7 +97,7 @@ dependencies = [
 
 [[package]]
 name = "localqueue"
-version = "1.1.0"
+version = "1.1.1"
 dependencies = [
  "pyo3",
  "rusqlite",

{localqueue-1.1.0 → localqueue-1.1.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "localqueue"
-version = "1.1.0"
+version = "1.1.1"
 edition = "2021"
 rust-version = "1.83"
 description = "A persistent, multiprocess-safe local queue for Python, backed by SQLite and Rust."