fitscube-rs 1.0.1__tar.gz

fitscube_rs-1.0.1/.cargo/config.toml

@@ -0,0 +1,4 @@
+# Allow Python symbols to be resolved at runtime (required for pyo3 extension modules
+# and for the stub_gen binary, which uses pyo3 type info without calling Python).
+[target.aarch64-apple-darwin]
+rustflags = ["-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"]

fitscube_rs-1.0.1/.github/workflows/cd.yml

@@ -0,0 +1,146 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: 3
+
+jobs:
+  sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install cargo-edit
+        if: github.event_name == 'release'
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-edit
+
+      - name: Pin version from release tag
+        if: github.event_name == 'release'
+        shell: bash
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: cargo set-version "${RELEASE_TAG#v}"
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-sdist
+          path: dist/*.tar.gz
+
+  wheels:
+    name: Wheels (${{ matrix.platform }}, ${{ matrix.target }})
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { platform: linux, runner: ubuntu-latest, target: x86_64 }
+          - { platform: linux, runner: ubuntu-latest, target: aarch64 }
+          - { platform: macos, runner: macos-14, target: aarch64 }
+          # No Windows wheel: cfitsio can't be built from source under MSVC.
+          # Windows users can build from the sdist or use conda/WSL.
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install cargo-edit
+        if: github.event_name == 'release'
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-edit
+
+      - name: Pin version from release tag
+        if: github.event_name == 'release'
+        shell: bash
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: cargo set-version "${RELEASE_TAG#v}"
+
+      # cfitsio is compiled from source via the crate's `fitsio-src` feature,
+      # so the only build requirement is a C compiler, which every runner (and
+      # the manylinux container) already provides.
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          # `auto` selects an appropriate manylinux image; maturin-action's
+          # cross images carry the aarch64 C toolchain needed to build cfitsio.
+          manylinux: auto
+          # `abi3` builds one stable-ABI wheel per platform (Python >=3.10) and
+          # lets maturin build without a (target) interpreter, needed for aarch64.
+          args: --release --out dist --features abi3
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.platform }}-${{ matrix.target }}
+          path: dist/*.whl
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [sdist, wheels]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write       # trusted publishing
+      attestations: write
+      contents: read
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist
+          merge-multiple: true
+
+      - name: Generate artifact attestations
+        uses: actions/attest-build-provenance@v4
+        with:
+          subject-path: "dist/*"
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-crates:
+    name: Publish to crates.io
+    needs: [sdist, wheels]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install cargo-edit
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-edit
+
+      - name: Pin version from release tag
+        shell: bash
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: cargo set-version "${RELEASE_TAG#v}"
+
+      # --allow-dirty: `cargo set-version` leaves the manifest modified vs HEAD.
+      - name: Publish crate
+        run: cargo publish --allow-dirty --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

fitscube_rs-1.0.1/.github/workflows/ci.yml

@@ -0,0 +1,116 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Many color libraries just need this variable to be set to any value.
+  FORCE_COLOR: 3
+  CARGO_TERM_COLOR: always
+
+jobs:
+  lint:
+    name: Lint & format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+
+      - uses: Swatinem/rust-cache@v2
+
+      - uses: astral-sh/setup-uv@v7
+
+      # ty type-checks against installed deps (numpy, astropy, ...), so build
+      # the extension and populate .venv first; ty auto-discovers ./.venv.
+      - name: Build extension and install deps
+        run: uv sync --extra test --extra dev
+
+      # Single source of truth: the same hooks developers run locally
+      # (.pre-commit-config.yaml) — ruff, ty, cargo fmt, clippy. prek exits
+      # nonzero if any autofix hook had to change a file, so this fails CI
+      # exactly like the `--check` variants did.
+      - name: prek (lint, format, type check)
+        run: uvx prek run --all-files --show-diff-on-failure
+
+  docs:
+    name: Docs build
+    runs-on: ubuntu-latest
+    needs: [lint]
+    steps:
+      - uses: actions/checkout@v6
+
+      # Rust is needed twice: maturin builds the extension during `uv sync`,
+      # and sphinxcontrib-programoutput runs `cargo run -- --help` to embed
+      # the CLI help text.
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Build extension and install docs dependencies
+        run: uv sync --group docs
+
+      # -W makes warnings fatal. The quickstart notebook is re-executed and
+      # the CLI help regenerated on every build, so stale or broken examples
+      # fail here.
+      - name: Build docs
+        run: uv run --no-sync sphinx-build -W -b html docs docs/_build/html
+
+  rust-test:
+    name: Rust tests
+    runs-on: ubuntu-latest
+    needs: [lint]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Run Rust tests
+        # The integration tests exercise the pure-Rust API; no Python features.
+        run: cargo test
+
+  python-test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    needs: [lint]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Builds the maturin extension module and installs the `test` extra
+      # (pytest, radio-beam, astropy). cfitsio is compiled from source via the
+      # crate's `fitsio-src` feature, so no system library is needed.
+      - name: Build extension and install test dependencies
+        run: uv sync --extra test
+
+      - name: Run pytest
+        run: uv run --no-sync pytest -ra --durations=20

fitscube_rs-1.0.1/.gitignore

@@ -0,0 +1,137 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug
+target
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Generated by cargo mutants
+# Contains mutation testing data
+**/mutants.out*/
+
+# rustc will dump stack traces when hitting an internal compiler error to PWD
+rustc-ice-*.txt
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pdm
+.pdm-python
+.pdm-build/
+
+# pixi
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Benchmark outputs
+scripts/bench_out/
+bench_out/

fitscube_rs-1.0.1/.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+# Mirrors the CI "Lint & format" job (.github/workflows/ci.yml).
+# Run with prek (a fast, drop-in pre-commit reimplementation):
+#   uvx prek install      # install the git hook
+#   uvx prek run --all-files
+# `uv sync --extra dev` installs prek + ty into the project venv.
+
+# Generated by pyo3-stub-gen; never hand-edit (regenerated by the build).
+exclude: '^fitscube_rs/_fitscube_rs/__init__\.pyi$'
+
+# pre-commit.ci has no Rust toolchain, and ty needs the project venv (numpy,
+# astropy) which the bot doesn't build. Skip those there; the GitHub Actions
+# lint job runs the full suite (cargo present + `uv sync`), so coverage holds.
+ci:
+  skip: [cargo-fmt, cargo-clippy, ty]
+
+repos:
+  # Generic hygiene
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files
+
+  # Python: ruff lint + format (same tool/config as CI's `uvx ruff`)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.2
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  # Python type checking with ty (config in [tool.ty] of pyproject.toml).
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check
+        entry: uvx ty check
+        language: system
+        types_or: [python, pyi]
+        pass_filenames: false
+
+  # Rust: run the installed toolchain (no version pinning by the hook manager).
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: cargo fmt --all --
+        language: system
+        types: [rust]
+        pass_filenames: false
+
+      - id: cargo-clippy
+        # Not --all-features: `abi3` and `stubgen` are mutually exclusive.
+        name: cargo clippy
+        entry: cargo clippy --all-targets --features stubgen -- -D warnings
+        language: system
+        types: [rust]
+        pass_filenames: false

fitscube_rs-1.0.1/.readthedocs.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+    # maturin compiles the extension during `uv sync`, and
+    # sphinxcontrib-programoutput runs `cargo run -- --help` at build time.
+    # edition 2024 needs Rust >= 1.85.
+    rust: "latest"
+  commands:
+    - asdf plugin add uv
+    - asdf install uv latest
+    - asdf global uv latest
+    - uv sync --group docs
+    - uv run --no-sync python -m sphinx -T -W -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html