rustfits 0.1.2__tar.gz

rustfits-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,244 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+# Cancel superseded in-progress runs for the same branch / PR — keeps
+# the queue from piling up when you push twice in quick succession.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # ----- Lint -------------------------------------------------------
+  # Runs ruff format-check and ruff check on the Python sources.  No
+  # Rust toolchain or build needed — fast feedback on style.
+  lint:
+    name: Lint (ruff)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-name: rustfits-lint
+          create-args: >-
+            python=3.12
+            ruff
+          cache-environment: true
+          init-shell: bash
+      - name: ruff format --check
+        shell: bash -el {0}
+        run: ruff format --check
+      - name: ruff check
+        shell: bash -el {0}
+        run: ruff check
+
+  # ----- Rust unit tests --------------------------------------------
+  # cargo test runs `#[cfg(test)] mod tests` blocks throughout the
+  # crate — pure-Rust logic (PRNG, byte conversions, parsers).  The
+  # test binary links libpython via PyO3 even though the test
+  # functions themselves don't call Python, so we need Python on
+  # PATH so tools/cargo-test.sh can find libpython's directory via
+  # sysconfig.LIBDIR and prepend it to LD_LIBRARY_PATH.
+  rust-test:
+    name: cargo test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python (so libpython is resolvable)
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Set up Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache cargo build
+        uses: Swatinem/rust-cache@v2
+      - name: cargo test (via libpython-aware wrapper)
+        run: tools/cargo-test.sh
+
+  # ----- Test matrix ------------------------------------------------
+  # ubuntu-latest + macos-latest x {python 3.12, 3.14}.  On macOS we
+  # source-build fitsio via pip after the conda install — conda-forge's
+  # macOS fitsio/cfitsio binary has a libmalloc bad-free in cfitsio's
+  # ffbinit that crashes every test writing a compressed-image fixture.
+  # fitsio's own CI (https://github.com/esheldon/fitsio) source-builds
+  # the package on every leg for the same reason; we follow that
+  # pattern only on macOS to keep the linux install fast.
+  test:
+    name: Test (${{ matrix.os }}, py${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python: ['3.12', '3.14']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      # Caches target/ and ~/.cargo across runs — first build is full,
+      # subsequent builds are incremental.
+      - name: Cache cargo build
+        uses: Swatinem/rust-cache@v2
+
+      # `python-gil` pins the stock GIL Python build (vs the optional
+      # `python-freethreading` no-GIL build conda-forge ships from 3.13
+      # onward).  rustfits has not been audited for free-threading
+      # safety; without the pin micromamba could pick the no-GIL
+      # variant on py3.14 and surface latent races as heap corruption
+      # (which is exactly what macOS py3.14 hit on the first run).
+      - name: Set up conda env (python ${{ matrix.python }})
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-name: rustfits-test
+          create-args: >-
+            python=${{ matrix.python }}
+            python-gil
+          cache-environment: true
+          init-shell: bash
+
+      - name: Install conda deps
+        shell: bash -el {0}
+        run: |
+          micromamba install -y -c conda-forge \
+            --file conda-requirements.txt \
+            --file conda-test-requirements.txt
+
+      # Replace the broken conda-forge fitsio macOS build with a fresh
+      # source build (cfitsio bundled in the fitsio sdist).  --no-deps
+      # so we don't churn numpy/setuptools that conda already provided;
+      # --no-binary=fitsio forces pip to build from sdist instead of
+      # using a PyPI wheel (which may have been built by the same
+      # toolchain that produces the buggy conda-forge binary).
+      - name: Replace conda-forge fitsio with source build (macOS)
+        if: matrix.os == 'macos-latest'
+        shell: bash -el {0}
+        run: |
+          pip install --force-reinstall --no-deps --no-binary=fitsio fitsio
+
+      - name: maturin develop
+        shell: bash -el {0}
+        run: maturin develop
+
+      - name: pytest
+        shell: bash -el {0}
+        run: pytest
+
+  # ----- Sphinx docs build -----------------------------------------
+  # Mirrors what readthedocs.io does on every push: install rustfits
+  # (autodoc imports the module), install docs/requirements.txt, run
+  # sphinx-build with -W so any new warning is a hard failure.  Catches
+  # broken cross-refs, missing autodoc targets, rst syntax errors, and
+  # bad intersphinx links before they reach RTD.
+  docs:
+    name: Sphinx build (-W)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache cargo build
+        uses: Swatinem/rust-cache@v2
+
+      - name: Set up conda env (python 3.12)
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-name: rustfits-docs
+          create-args: >-
+            python=3.12
+          # cache-environment intentionally off: this env is small
+          # (sphinx + furo + maturin) and we hit recurring stale-cache
+          # corruption ("Cannot find a valid extracted directory cache
+          # for ...") on cached runs.  Fresh resolve each time costs a
+          # few seconds and avoids the failure mode entirely.
+          cache-environment: false
+          init-shell: bash
+
+      - name: Install conda deps + sphinx
+        shell: bash -el {0}
+        run: |
+          micromamba install -y -c conda-forge \
+            --file conda-requirements.txt
+          pip install -r docs/requirements.txt
+
+      - name: maturin develop (so autodoc can import rustfits)
+        shell: bash -el {0}
+        run: maturin develop
+
+      - name: sphinx-build -W
+        shell: bash -el {0}
+        run: sphinx-build -W -b html docs docs/_build/html
+
+  # ----- Coverage (single config) ----------------------------------
+  # Python coverage via pytest-cov + Rust coverage via cargo-llvm-cov.
+  # Only runs on one OS / Python combo — coverage instrumentation
+  # roughly doubles compile time and the report doesn't change across
+  # platforms.  Both reports get uploaded to codecov in one action.
+  coverage:
+    name: Coverage (linux, py3.12 → codecov)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Rust toolchain (with llvm-tools)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: llvm-tools-preview
+
+      - name: Cache cargo build
+        uses: Swatinem/rust-cache@v2
+
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-llvm-cov
+
+      - name: Set up conda env (python 3.12)
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-name: rustfits-cov
+          create-args: >-
+            python=3.12
+          cache-environment: true
+          init-shell: bash
+
+      - name: Install conda deps + pytest-cov
+        shell: bash -el {0}
+        run: |
+          micromamba install -y -c conda-forge \
+            --file conda-requirements.txt \
+            --file conda-test-requirements.txt \
+            pytest-cov
+
+      # cargo-llvm-cov show-env emits the RUSTFLAGS / LLVM_PROFILE_FILE
+      # / CARGO_LLVM_COV_TARGET_DIR that the instrumented build needs.
+      # Source it once so the cdylib built by maturin AND the .profraw
+      # files written by pytest land where `cargo llvm-cov report`
+      # expects them.  The whole pipeline runs in one shell because
+      # `source <(...)` only affects the current shell — splitting it
+      # across CI steps would lose the env.
+      - name: Build + test with coverage, emit lcov
+        shell: bash -el {0}
+        run: |
+          source <(cargo llvm-cov show-env --export-prefix)
+          maturin develop
+          pytest --cov=rustfits --cov-report=xml
+          cargo llvm-cov report --lcov --output-path rust-coverage.lcov
+
+      - name: Upload coverage to codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: rust-coverage.lcov,coverage.xml
+          flags: rust,python
+          fail_ci_if_error: false
+          # CODECOV_TOKEN is optional for public repos but recommended
+          # by codecov to avoid rate-limiting.  Add it under
+          # Settings → Secrets → Actions once you've connected the
+          # repo at codecov.io.
+          token: ${{ secrets.CODECOV_TOKEN }}

rustfits-0.1.2/.gitignore

@@ -0,0 +1,62 @@
+# Rust build output
+/target/
+
+# Override the global `*.lock` rule for this project: maturin/PyO3 packages
+# pin transitive dependency versions for reproducible CI and source builds.
+!Cargo.lock
+
+# Compiled extension modules (maturin develop writes them next to the package)
+*.so
+*.dylib
+*.pyd
+
+# Python bytecode / caches
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Test / type-check caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Packaging artifacts
+*.egg-info/
+build/
+dist/
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Editor / IDE artifacts
+*~
+*.swp
+*.swo
+.*.swp
+.*.swo
+.idea/
+.vscode/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Sphinx build output
+docs/_build/
+
+# cfitsio reproducer binaries + their generated FITS artifacts
+/tools/cfitsio-repro/pa_vla_funpack_crash
+/tools/cfitsio-repro/gzip2_complex_funpack
+/tools/cfitsio-repro/setitem_sweep_corruption
+/tools/cfitsio-repro/*.fits
+/tools/cfitsio-repro/*.fits.fz
+/tools/cfitsio-repro/core
+/tools/cfitsio-repro/core.*
+
+# Local stray files
+/log

rustfits-0.1.2/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs build configuration.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+    rust: "latest"
+  jobs:
+    # Build + install the maturin-backed extension into the build
+    # venv before Sphinx starts, so autodoc can `import rustfits`.
+    # `pip install .` honors pyproject.toml's [build-system] block
+    # (maturin), so this builds and installs the wheel in one step.
+    post_install:
+      - pip install .
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: docs/requirements.txt

rustfits-0.1.2/.ruff.toml

@@ -0,0 +1,14 @@
+exclude = [
+    ".git",
+    "build",
+    "dist",
+    ".github",
+]
+line-length = 79
+
+[lint]
+select = ["E", "F", "W"]
+preview = true
+
+[format]
+quote-style = "preserve"