zarrs 0.1.0__tar.gz

zarrs-0.1.0/.github/workflows/cd.yml

@@ -0,0 +1,143 @@
+name: cd
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '**'
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: build on ${{ matrix.os }} (${{ matrix.target }}${{ matrix.os == 'linux' && format(' - {0}', matrix.manylinux == 'auto' && 'manylinux' || matrix.manylinux) || '' }})
+    # only run on push to tags, main branch, or explicit full build
+    # keep condition in sync with `build-sdist` job
+    if: github.ref_type == 'tag' || github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Full Build')
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [linux, macos, windows]
+        target: [x86_64, aarch64]
+        manylinux: ['2_28']
+        include:
+          # manylinux for various platforms
+          #- { os: linux, manylinux: '2_28', target: i686 }
+          - { os: linux, manylinux: '2_28', target: armv7 }
+          - { os: linux, manylinux: '2_28', target: ppc64le }
+          #- { os: linux, manylinux: '2_28', target: s390x }
+          # musl
+          - { os: linux, manylinux: musllinux_1_2, target: x86_64 }
+          - { os: linux, manylinux: musllinux_1_2, target: aarch64 }
+          - { os: linux, manylinux: musllinux_1_2, target: armv7 }
+          # windows
+          - { os: windows, target: i686, python-architecture: x86 }
+    runs-on: ${{ (matrix.os == 'linux' && 'ubuntu') || matrix.os }}-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          architecture: ${{ matrix.python-architecture || 'x64' }}
+      - run: pip install twine
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          manylinux: ${{ matrix.manylinux }}
+          args: --release --out dist --interpreter '3.11 3.12 3.13'
+          rust-toolchain: stable
+          docker-options: -e CI
+          before-script-linux: |
+            # If we're running on rhel centos, install needed packages.
+            if command -v yum &> /dev/null; then
+                yum update -y && yum install -y perl-core
+            fi
+      - run: ${{ (matrix.os == 'windows' && 'dir') || 'ls -lh' }} dist/
+      - run: twine check --strict dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pypi-files-${{ matrix.os }}-${{ matrix.target }}-${{ matrix.manylinux }}
+          path: dist
+
+  build-sdist:
+    name: build sdist
+    # keep condition in sync with `build` job
+    if: github.ref_type == 'tag' || github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Full Build')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+          rust-toolchain: stable
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pypi-files-sdist
+          path: dist
+
+  inspect:
+    needs: [build, build-sdist]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: pypi-files-*
+          merge-multiple: true
+          path: dist/
+      - run: ls -lh dist/
+      # TODO: some more checks? `twine` is already run above
+
+  # If git tag is a version, verify that it matches the package metadata version (or fail job and skip `publish`)
+  # If git tag is not a version, set output `version` to "" (also skipping `publish`)
+  version:
+    if: github.ref_type == 'tag' && startsWith(github.ref_name, 'v')
+    needs: build
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      is_prerelease: ${{ steps.version.outputs.is_prerelease }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - uses: actions/download-artifact@v4
+        with:
+          name: pypi-files-linux-x86_64-2_28
+          path: dist/
+      - name: Install zarrs-python
+        run: pip install packaging dist/*manylinux_2_28_x86_64.whl
+      - name: Get zarrs-python version and tag
+        id: version
+        run: python .github/workflows/version-cmp.py
+
+  publish:
+    if: needs.version.outputs.version != ''
+    runs-on: ubuntu-latest
+    needs: [inspect, version]
+    environment: pypi
+    permissions:
+      contents: write # to create a github release
+      id-token: write # to authenticate as Trusted Publisher to pypi.org
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: pypi-files-*
+          merge-multiple: true
+          path: dist/
+      - name: "Publishing version ${{ needs.version.outputs.version }}"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          verbose: true
+      - uses: ncipollo/release-action@v1
+        with:
+          name: ${{ needs.version.outputs.version }}
+          prerelease: ${{ needs.version.outputs.is_prerelease }}

zarrs-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: ci
+
+on:
+  push:
+      branches:
+        - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+  PYTEST_ADDOPTS: '--color=yes'
+
+jobs:
+  build_and_test:
+    name: build and test
+    strategy:
+      fail-fast: false
+      matrix:
+        rust_toolchain: ["stable"]  # "nightly"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # Rust in GH runner images can lag behind stable releases + act does not include Rust
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust_toolchain }}
+          components: rustfmt
+
+      - name: Install rust-cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.5.0"
+          enable-cache: true
+          cache-dependency-glob:  |
+            pyproject.toml
+            Cargo.toml
+
+      - name: Install python deps + Build
+        run: |
+          uv pip install --system -e ".[test,dev]" --verbose
+
+      - name: Python Tests
+        run: pytest -n auto
+
+      - name: Rust Tests
+        run: cargo test
+
+      - name: Check formatting
+        # see “Type hints” section in contributing.md
+        run: |
+          cargo run --bin stub_gen
+          pre-commit run --all-files --show-diff-on-failure || true
+          git diff --exit-code HEAD

zarrs-0.1.0/.github/workflows/version-cmp.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+# Can’t be an isolated script since we want to access zarrs’ metadata
+
+import importlib.metadata as im
+import os
+import sys
+from pathlib import Path
+
+from packaging.version import InvalidVersion, Version
+
+
+def set_outputs(version: Version | str) -> None:
+    is_prerelease = version.is_prerelease if isinstance(version, Version) else False
+    is_prerelease_json = "true" if is_prerelease else "false"
+    print(f"{version=!s} {is_prerelease=}")
+    with Path(os.environ["GITHUB_OUTPUT"]).open("a") as f:
+        print(f"version={version}", file=f)
+        print(f"is_prerelease={is_prerelease_json}", file=f)
+
+
+version_tag_str = os.environ["GITHUB_REF_NAME"]
+assert version_tag_str.startswith("v"), "should be enforced in `if:` condition"
+try:
+    version_tag = Version(version_tag_str[1:])
+except InvalidVersion:
+    set_outputs("")
+    sys.exit(0)
+
+if version_tag_str[1:] != str(version_tag):
+    sys.exit(f"Tag version not normalized: {version_tag_str} should be v{version_tag}")
+
+if version_tag != (version_meta := Version(im.version("zarrs"))):
+    sys.exit(f"Version mismatch: {version_tag} (tag) != {version_meta} (metadata)")
+
+set_outputs(version_meta)

zarrs-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+# IDEs
+/.idea/
+/.vscode/
+
+# Caches
+.DS_Store
+__pycache__/
+/.*cache/
+/.hypothesis/
+
+# Build
+*.so
+/target/
+/dist/
+/docs/_build/
+
+# Coverage
+/.coverage
+/coverage.xml
+
+# Docs
+docs/generated/

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

@@ -0,0 +1,32 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: no-commit-to-branch
+        args: ["--branch=main"]
+  - repo: local
+    hooks:
+      - id: rustfmt
+        name: rustfmt
+        description: Check if all files follow the rustfmt style
+        entry: cargo fmt --all -- --color always
+        language: system
+        pass_filenames: false
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.2
+    hooks:
+    -   id: ruff
+        args: ["--fix"]
+    -   id: ruff-format
+    # The following can be removed once PLR0917 is out of preview
+    -   name: ruff preview rules
+        id: ruff
+        args: ["--preview", "--select=PLR0917"]

zarrs-0.1.0/.readthedocs.yml

@@ -0,0 +1,19 @@
+version: 2
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.12"
+    rust: "latest"
+  jobs:
+    post_checkout:
+      # unshallow so version can be derived from tag
+      - git fetch --unshallow || true
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc