Set up pixi for development

.github/workflows/code-quality.yaml

@@ -20,6 +20,7 @@ env:
   RUSTFLAGS: "-D warnings -W unreachable-pub -W bare-trait-objects"
   RUSTUP_MAX_RETRIES: 10
   RUST_CHANNEL: '1.91.0'
+  PIXI_VERSION: "v0.63.2"
 
 jobs:
   code-quality:
@@ -33,20 +34,18 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
-      - name: Install Just
-        run: sudo snap install --edge --classic just
-
-      - name: Install Rust toolchain
-        run: |
-          rustup update --no-self-update ${{ env.RUST_CHANNEL }}
-          rustup component add --toolchain ${{ env.RUST_CHANNEL }} rustfmt rust-src clippy
-          rustup default ${{ env.RUST_CHANNEL }}
-
       - name: Cache Dependencies
         uses: Swatinem/rust-cache@v2
         with:
           key: ${{ env.RUST_CHANNEL }}
 
+      - uses: prefix-dev/setup-pixi@v0.9.4
+        with:
+          pixi-version: ${{ env.PIXI_VERSION }}
+          cache: true
+          activate-environment: true
+          manifest-path: icechunk-python/pyproject.toml
+
       - name: Run formatting checks
         run: |
           just format --check
@@ -59,20 +58,10 @@ jobs:
         run: |
           just profile=ci doctest
 
-      - name: Install uv
-        uses: astral-sh/setup-uv@v7
-        with:
-          enable-cache: true
-
       - name: Python mypy type checking
-        shell: bash
-        working-directory: icechunk-python
         run: |
-          uv run --all-groups mypy python tests
+          just mypy
 
       - name: Run pre-commit checks (skip Rust)
-        uses: pre-commit/action@v3.0.1
-        with:
-          extra_args: --all-files
-        env:
-          SKIP: rust-pre-commit-fast,rust-pre-commit,rust-pre-commit-ci
+        run: |
+          just py-pre-commit

.gitignore

@@ -23,3 +23,6 @@ icechunk-python/uv.lock
 
 # Jetbrains IDE
 .idea/
+# pixi environments
+.pixi/*
+!.pixi/config.toml

.readthedocs.yaml

@@ -3,16 +3,12 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "mambaforge-latest"
-
+    python: "3.12"
   jobs:
-    install:
-      - which mamba
-      - cd icechunk-python && maturin build && pip install "$(ls ../target/wheels/*.whl | head -n 1)" && pip install --group docs && cd docs
-      - mamba list
-      # - cd icechunk-python && maturin develop && cd ../docs
-
-conda:
-  environment: icechunk-python/docs/doc-env.yml
-mkdocs:
-  configuration: icechunk-python/docs/mkdocs.yml
+    create_environment:
+      - asdf plugin add pixi
+      - asdf install pixi latest
+      - asdf global pixi latest
+    build:
+      html:
+        - pixi run -m icechunk-python/pyproject.toml just docs-build --site-dir $READTHEDOCS_OUTPUT/html

Justfile

@@ -4,62 +4,64 @@ profile := "dev"
 alias fmt := format
 alias pre := pre-commit
 
-# run all tests
+[doc("Run all Rust tests via cargo-nextest")]
 test *args='':
-  cargo nextest run --no-fail-fast --cargo-profile {{profile}} --workspace --all-targets {{args}}
+  export DYLD_LIBRARY_PATH="${CONDA_PREFIX:-}/lib" && cargo nextest run --no-fail-fast --cargo-profile {{profile}} --workspace --all-targets {{args}}
 
+[doc("Run Rust doc tests only")]
 doctest *args='':
   cargo test --workspace --profile {{profile}} --doc {{args}}
 
-# run all tests with logs enabled
+[doc("Run all Rust tests with RUST_LOG enabled (e.g. `just test-logs debug`)")]
 test-logs level *args='':
-  RUST_LOG=icechunk={{level}} cargo nextest run --no-fail-fast --cargo-profile {{profile}} --workspace --all-targets {{args}} -- --nocapture
+  export DYLD_LIBRARY_PATH="${CONDA_PREFIX:-}/lib" && RUST_LOG=icechunk={{level}} cargo nextest run --no-fail-fast --cargo-profile {{profile}} --workspace --all-targets {{args}} -- --nocapture
 
-# compile but don't run all tests
+[doc("Compile tests without running them")]
 compile-tests *args='':
-  cargo nextest run --no-run --cargo-profile {{profile}} --workspace --all-targets {{args}}
+  export DYLD_LIBRARY_PATH="${CONDA_PREFIX:-}/lib" && cargo nextest run --no-run --cargo-profile {{profile}} --workspace --all-targets {{args}}
 
-# build debug version
+[doc("Build the Rust workspace (debug by default, override with `just profile=ci build`)")]
 build *args='':
   cargo build --profile {{profile}} {{args}}
 
-# build release version
+[doc("Build the Rust workspace in release mode")]
 build-release *args='':
   cargo build --release {{args}}
 
-# run clippy
+[doc("Run clippy lints on all features")]
 lint *args='':
   cargo clippy --profile {{profile}} --all-features {{args}}
 
-# reformat all rust files
+[doc("Format all Rust files (pass `--check` to verify only)")]
 format *args='':
   cargo fmt --all {{args}}
 
-# reformat all nix files
+[doc("Format all Nix files with alejandra")]
 format-nix *args='':
   alejandra .
 
-# run cargo deny to check dependencies
+[doc("Check dependencies for security/license issues via cargo-deny")]
 check-deps *args='':
   cargo deny --all-features check {{args}}
 
+[doc("Run all Rust examples (skips limits_chunk_refs)")]
 run-all-examples:
   for example in icechunk/examples/*.rs; do if [[ ${example} =~ "limits_chunk_refs" ]]; then continue; fi; cargo run --profile {{profile}} --example "$(basename "${example%.rs}")"; done
 
-# fast pre-commit - format and lint only
+[doc("Fast Rust pre-commit: format + lint (~3s)")]
 pre-commit-fast:
   just format
   just lint "--workspace"
 
-# medium pre-commit - includes compilation checks (~2-3 minutes)
+[doc("Medium Rust pre-commit: compile, build, format, lint, deps (~2-3min)")]
 pre-commit $RUSTFLAGS="-D warnings -W unreachable-pub -W bare-trait-objects":
   just compile-tests "--locked"
   just build
   just format
   just lint "--workspace"
   just check-deps
 
-# full pre-commit for CI - runs all checks including tests
+[doc("Full Rust CI pre-commit: all checks including tests and examples (~5+min)")]
 pre-commit-ci $RUSTFLAGS="-D warnings -W unreachable-pub -W bare-trait-objects":
   just profile=ci compile-tests "--locked"
   just profile=ci build
@@ -70,17 +72,49 @@ pre-commit-ci $RUSTFLAGS="-D warnings -W unreachable-pub -W bare-trait-objects":
   just profile=ci run-all-examples
   just check-deps
 
+[doc("Rust format + lint for the icechunk-python crate only")]
 pre-commit-python:
   just format "-p icechunk-python"
   just lint "-p icechunk-python"
 
+[doc("Compare pytest-benchmark results")]
 bench-compare *args:
   pytest-benchmark compare --group=group,func,param --sort=fullname --columns=median --name=short {{args}}
 
-create-deepak-env name:
-  mamba create -y -n icechunk-{{name}} python=3.12 ipykernel ipdb
-  mamba activate icechunk-{{name}}
-  just coiled-ice-create {{name}}
-
-coiled-ice-create version:
-  pip install coiled arraylake icechunk=='{{version}}' watermark xarray bokeh
+[doc("Run ruff formatter on Python code")]
+ruff-format *args:
+  ruff format
+
+[doc("Run ruff linter on Python code (pass `--fix` for auto-fix)")]
+ruff *args:
+  ruff check --show-fixes icechunk-python/ {{args}}
+
+[doc("Run mypy type checking on Python code")]
+mypy *args:
+  cd icechunk-python && mypy python tests {{args}}
+
+[doc("Run all Python pre-commit hooks (ruff, formatting, codespell, etc.)")]
+py-pre-commit $SKIP="rust-pre-commit-fast,rust-pre-commit,rust-pre-commit-ci" *args:
+  prek run --all-files
+
+[doc("Run Python tests via pytest")]
+pytest *args:
+  cd icechunk-python && pytest {{args}}
+
+[doc("Start MkDocs dev server with live reload")]
+docs-serve *args:
+  mkdocs serve -f icechunk-python/docs/mkdocs.yml --livereload {{args}}
+
+[doc("Build MkDocs static site")]
+docs-build *args:
+  mkdocs build -f icechunk-python/docs/mkdocs.yml {{args}}
+
+[doc("Run all Python and Rust checks")]
+all-checks:
+  just pytest
+  just py-pre-commit
+  just mypy
+  just ruff
+  just ruff-format
+  just pre-commit-python
+  just pre-commit-ci

icechunk-python/docs/README.md

@@ -21,23 +21,17 @@ This repository uses [uv](https://docs.astral.sh/uv/) to manage dependencies.
 From the `icechunk-python` directory:
 
 ```bash
-# Install icechunk with docs dependencies
-uv sync --group docs
 
-# Start the MkDocs development server
-cd ../docs
-uv run mkdocs serve
+pixi run docs-serve
 ```
 
 > [!TIP]
 > You can use the optional `--dirty` flag to only rebuild changed files, although you may need to restart if you make changes to `mkdocs.yaml`.
 
 ### Building
 
-From the `docs` directory:
-
 ```bash
-uv run mkdocs build
+pixi run docs-build
 ```
 
 Builds output to: `docs/.site` directory.