migrate to pixi (#167)

* move the build system config below project config

* replace setuptools with hatchling

* initial pixi setup

* configure the nightly env

* configure the CI envs

* configure the docs env

* tasks for the docs env

* configure a dev env

* new syntax for ignoring in automatic release notes

* use `pixi` in CI

* use `pixi` on RTD

* remove the old ci files

* ignore pixi.lock

* enable macos and windows for CI

* add `pixi.lock` to accelerate CI

* update `pixi.lock`

* ignore the automatically created version file

* ignore any `jupyter_execute` dirs

* add `.gitattributes`

Author: keewis

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.github/release.yml

@@ -1,5 +1,5 @@
 changelog:
   exclude:
     authors:
-      - dependabot
-      - pre-commit-ci
+      - dependabot[bot]
+      - pre-commit-ci[bot]

.github/workflows/ci.yml

@@ -33,50 +33,43 @@ jobs:
           keyword: "[skip-ci]"
 
   tests:
-    name: ${{ matrix.os }} py${{ matrix.python-version }}
+    name: ${{ matrix.os }} ${{ matrix.env }}
     runs-on: ${{ matrix.os }}
     needs: detect-ci-trigger
     if: needs.detect-ci-trigger.outputs.triggered == 'false'
     defaults:
       run:
-        shell: bash -leo pipefail {0} {0}
+        shell: bash -l {0}
 
     strategy:
       fail-fast: false
 
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
-        python-version: ["3.11", "3.12", "3.13"]
+        env: ["ci-py311", "ci-py312", "ci-py313"]
 
     steps:
       - name: Clone repository
         uses: actions/checkout@v5
         with:
           fetch-depth: 0 # Fetch all history for all branches and tags
 
-      - name: Setup environment
-        run: >-
-          echo "CONDA_ENV_FILE=ci/environment.yml" >> $GITHUB_ENV
-
-      - name: Setup micromamba
-        uses: mamba-org/setup-micromamba@v2
+      - name: setup environment
+        uses: prefix-dev/setup-pixi@fef5c9568ca6c4ff7707bf840ab0692ba3f08293 # 0.9.0
         with:
-          micromamba-version: "1.5.10-0"
-          environment-file: ${{ env.CONDA_ENV_FILE }}
-          environment-name: xdggs-tests
-          cache-environment: true
-          cache-environment-key: "${{runner.os}}-${{runner.arch}}-py${{matrix.python-version}}-${{env.TODAY}}-${{hashFiles(env.CONDA_ENV_FILE)}}"
-          create-args: >-
-            python=${{matrix.python-version}}
+          environments: "${{ matrix.env }}"
 
-      - name: Install xdggs
+      - name: investigate env variables
         run: |
-          python -m pip install --no-deps -e .
+          echo PYTHON_VERSION=$(pixi run -e ${{ matrix.env }} python -c 'import sys; print(".".join(map(str, sys.version_info[:2])))') >> $GITHUB_ENV
+          echo RUNNER_OS="${{ matrix.os }}"
 
       - name: Import xdggs
         run: |
-          python -c "import xdggs"
+          pixi run -e ${{ matrix.env }} python -c "import xdggs"
 
-      - name: Run tests
+      - name: run tests
+        if: success()
+        id: status
         run: |
-          python -m pytest
+          pixi run -e ${{ matrix.env }} tests --cov=xdggs

.github/workflows/nightly.yml

@@ -45,13 +45,7 @@ jobs:
 
     defaults:
       run:
-        shell: bash -leo pipefail {0} {0}
-
-    strategy:
-      fail-fast: false
-
-      matrix:
-        python-version: ["3.12"]
+        shell: bash -l {0}
 
     permissions:
       issues: write
@@ -62,34 +56,24 @@ jobs:
         with:
           fetch-depth: 0 # Fetch all history for all branches and tags
 
-      - name: Setup micromamba
-        uses: mamba-org/setup-micromamba@v2
-        with:
-          environment-file: ci/environment.yml
-          environment-name: xdggs-tests
-          cache-environment: false
-          create-args: >-
-            python=${{matrix.python-version}}
-            pytest-reportlog
-            conda
-
-      - name: Install upstream versions
+      - name: remove lockfile
         run: |
-          bash ci/install-upstream-wheels.sh
+          rm pixi.lock
 
-      - name: Install xdggs
-        run: |
-          python -m pip install --no-deps -e .
+      - name: setup environment
+        uses: prefix-dev/setup-pixi@fef5c9568ca6c4ff7707bf840ab0692ba3f08293 # 0.9.0
+        with:
+          environments: "nightly"
 
       - name: Import xdggs
         run: |
-          python -c "import xdggs"
+          pixi run -e nightly python -c "import xdggs"
 
-      - name: Run tests
+      - name: run tests
         if: success()
-        id: run-tests
+        id: status
         run: |
-          python -m pytest --report-log output-${{ matrix.python-version }}-log.jsonl
+          pixi run -e nightly tests -rf --report-log=pytest-log.jsonl
 
       - name: Generate and publish a failure report
         if: |
@@ -99,4 +83,4 @@ jobs:
           && github.repository_owner == 'xarray-contrib'
         uses: xarray-contrib/issue-from-pytest-log@v1
         with:
-          log-path: output-${{ matrix.python-version }}-log.jsonl
+          log-path: pytest-log.jsonl

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+/xdggs/_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -71,6 +72,7 @@ instance/
 # Sphinx documentation
 docs/_build/
 docs/**/generated/
+jupyter_execute/
 
 # PyBuilder
 .pybuilder/
@@ -167,3 +169,7 @@ cython_debug/
 # bibtex
 .auctex-auto
 *.bib.untidy
+
+# pixi environments
+.pixi/*
+!.pixi/config.toml

.readthedocs.yaml

@@ -3,19 +3,23 @@ version: 2
 build:
   os: ubuntu-lts-latest
   tools:
-    python: mambaforge-latest
+    # just so RTD stops complaining
+    python: "latest"
   jobs:
     post_checkout:
       - (git --no-pager log --pretty="tformat:%s" -1 | grep -vqF "[skip-rtd]") || exit 183
       - git fetch --unshallow || true
+    create_environment:
+      - asdf plugin add pixi
+      - asdf install pixi latest
+      - asdf global pixi latest
     pre_install:
-      - git update-index --assume-unchanged docs/conf.py ci/docs.yml
-
-conda:
-  environment: ci/docs.yml
+      - git update-index --assume-unchanged docs/conf.py
+    install:
+      - pixi install -e docs
+    build:
+      html:
+        - pixi run -e docs build-docs-rtd
 
 sphinx:
-  fail_on_warning: true
   configuration: docs/conf.py
-
-formats: []