batchcorder 0.1.0__tar.gz

batchcorder-0.1.0/.github/workflows/build-wheels.yaml

@@ -0,0 +1,91 @@
+name: build-wheels
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+          manylinux: ${{ matrix.target == 'aarch64' && '2_28' || 'auto' }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel-ubuntu-${{ matrix.target }}
+          path: dist
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        target: [x64, x86]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          architecture: ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel-windows-${{ matrix.target }}
+          path: dist
+
+  macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel-macos-${{ matrix.target }}
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist

batchcorder-0.1.0/.github/workflows/ci-lint.yaml

@@ -0,0 +1,79 @@
+name: ci-lint
+
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "*.md"
+      - ".envrc"
+    branches:
+      - main
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    # sccache-action sets RUSTC_WRAPPER=sccache; all cargo sub-processes
+    # (maturin develop, cargo clippy, cargo doc in pre-commit) pick it up.
+    env:
+      SCCACHE_GHA_ENABLED: "true"
+      RUSTC_WRAPPER: "sccache"
+      UV_NO_SYNC: "1"
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      # Nightly is required by the `cargo +nightly fmt` pre-commit hook.
+      - name: Install Rust nightly
+        run: rustup toolchain install nightly --profile minimal --component rustfmt --no-self-update
+
+      - name: Set up sccache
+        uses: mozilla-actions/sccache-action@v0.0.9
+
+      - name: Cargo cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            ./target/
+          key: cargo-lint-${{ hashFiles('**/Cargo.toml', '**/Cargo.lock') }}
+          restore-keys: cargo-lint-
+
+      - name: Install Python dependencies
+        run: uv sync --locked --group dev --no-install-project
+
+      # The pyright, griffe, and mypy-stubtest pre-commit hooks import the
+      # compiled extension at runtime, so we must build it first.
+      - name: Build extension
+        uses: PyO3/maturin-action@v1
+        with:
+          command: develop
+          args: --uv
+          sccache: 'true'
+          manylinux: 'off'
+
+      - name: Cache pre-commit environments
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: pre-commit-
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files

batchcorder-0.1.0/.github/workflows/ci-pre-release.yaml

@@ -0,0 +1,36 @@
+name: ci-pre-release
+
+on:
+  workflow_dispatch:
+
+# we do not want more than one release workflow executing at the same time, ever
+concurrency:
+  group: release
+  # cancelling in the middle of a release would create incomplete releases
+  # so cancel-in-progress is false
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    uses: ./.github/workflows/build-wheels.yaml
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - name: Publish to TestPyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          MATURIN_REPOSITORY: "testpypi"
+        with:
+          command: upload
+          args: --non-interactive --skip-existing ./dist/*

batchcorder-0.1.0/.github/workflows/ci-release.yaml

@@ -0,0 +1,37 @@
+name: ci-release
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+# we do not want more than one release workflow executing at the same time, ever
+concurrency:
+  group: release
+  # cancelling in the middle of a release would create incomplete releases
+  # so cancel-in-progress is false
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    uses: ./.github/workflows/build-wheels.yaml
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - name: Publish to PyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        with:
+          command: upload
+          args: --non-interactive --skip-existing ./dist/*

batchcorder-0.1.0/.github/workflows/ci-test.yaml

@@ -0,0 +1,74 @@
+name: ci-test
+
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "*.md"
+      - ".envrc"
+    branches:
+      - main
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    env:
+      UV_NO_SYNC: "1"
+    strategy:
+      matrix:
+        # requires-python = ">=3.11"; test the floor and the latest stable.
+        python-version: ["3.11", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update Rust stable
+        run: rustup update stable
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Cargo cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            ./target/
+          # abi3-py311 produces a single binary regardless of Python version,
+          # so the cache key does not include python-version.
+          key: cargo-test-${{ hashFiles('**/Cargo.toml', '**/Cargo.lock') }}
+          restore-keys: cargo-test-
+
+      # --no-install-project: maturin develop handles the batchcorder install.
+      - name: Install Python dependencies
+        run: uv sync --locked --group dev --no-install-project
+
+      - name: Build extension
+        uses: PyO3/maturin-action@v1
+        with:
+          command: develop
+          args: --release --strip --uv
+          sccache: 'true'
+          manylinux: 'off'
+
+      - name: Run tests
+        run: uv run pytest --import-mode=importlib --cov --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5.4.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

batchcorder-0.1.0/.gitignore

@@ -0,0 +1,90 @@
+/target
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.pytest_cache/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+include/
+man/
+venv/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+pip-selfcheck.json
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot
+
+.DS_Store
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+
+# Quarto-generated Markdown files (build artifacts — source is in docs/quarto/)
+docs/source/**/*.md
+
+# Quarto project cache
+docs/quarto/.quarto/
+
+# sphinx-autoapi generated RST files
+docs/source/_autoapi/
+
+# PyCharm
+.idea/
+
+# VSCode
+.vscode/
+
+# Pyenv
+.python-version
+
+.direnv/
+
+.envrc
+
+!src/bin
+
+site

batchcorder-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,116 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+        args: ["--maxkb=500"]
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.25
+    hooks:
+      - id: validate-pyproject
+
+  # typos: fast, code-aware typo checker (understands identifiers/tokens)
+  - repo: https://github.com/adhtruong/mirrors-typos
+    rev: v1.44.0
+    hooks:
+      - id: typos
+        args: ["--config", "pyproject.toml"]
+
+  # codespell: natural-language spell checker for comments and docs
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+      - id: codespell
+        args: [--toml, "pyproject.toml"]
+        additional_dependencies:
+          - tomli
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.6
+    hooks:
+      - id: ruff-check
+        args: ["--output-format=full", "--fix"]
+      - id: ruff-format
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.11
+    hooks:
+      - id: actionlint
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        args: [--config-file, .yamllint.yaml]
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.10.10
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.11.0.1
+    hooks:
+      - id: shellcheck
+        args: ["scripts/build-docs.sh"]
+
+  - repo: local
+    hooks:
+      - id: rust-fmt
+        name: Rust fmt
+        description: Run cargo fmt on files included in the commit.
+        entry: cargo +nightly fmt --all --
+        language: system
+        pass_filenames: true
+        types: [file, rust]
+
+      - id: rust-clippy
+        name: Rust clippy
+        description: Run cargo clippy — deny all warnings.
+        entry: cargo clippy --all-targets --all-features -- -Dclippy::all -D warnings -Aclippy::redundant_closure
+        language: system
+        pass_filenames: false
+        types: [file, rust]
+
+      - id: pyright
+        name: pyright
+        description: Static type-checking for Python code and stubs.
+        entry: .venv/bin/pyright
+        language: system
+        pass_filenames: false
+        types_or: [python, pyi]
+
+      # griffe validates that NumPy-style docstrings match function signatures.
+      # Dynamically imports the installed batchcorder extension.
+      - id: griffe
+        name: griffe (docstring validation)
+        description: Validate NumPy-style docstrings are complete and consistent.
+        entry: .venv/bin/griffe dump -d numpy -LWARNING -o /dev/null batchcorder
+        language: system
+        pass_filenames: false
+        types_or: [python, pyi]
+
+      # mypy.stubtest imports the compiled extension and checks that every
+      # name, arity, and type annotation in batchcorder.pyi matches runtime.
+      # Requires: maturin develop --uv  (compiled .so must be present)
+      - id: mypy-stubtest
+        name: mypy stubtest
+        description: Validate _batchcorder.pyi matches the compiled extension at runtime.
+        entry: .venv/bin/python -m mypy.stubtest batchcorder._batchcorder
+        language: system
+        pass_filenames: false
+        types_or: [python, pyi]

batchcorder-0.1.0/.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+    rust: "1.91"
+  commands:
+    # Run the build script with error handling and security checks
+    - ./scripts/build-docs.sh
+python:
+  install:
+    - method: pip
+      path: .

batchcorder-0.1.0/.yamllint.yaml

@@ -0,0 +1,8 @@
+extends: default
+
+rules:
+  line-length:
+    max: 120
+    level: warning
+  document-start: disable
+  truthy: disable