build(python)!: migrate to uv (#71)

- Uses [uv] to manage python dependencies and tools.
- Added mypy to pre-commit hooks (and updated/ran them)
- Created CONTRIBUTING.md doc and revise some README docs
- Reviewed nurfile
- update RTD and dependabot config

[uv]: https://docs.astral.sh/uv/

Author: 2bndy5

.config/.readthedocs.yaml

@@ -14,6 +14,11 @@ build:
     rust: latest
     python: latest
   jobs:
+    pre_create_environment:
+      - >-
+        UV_INSTALL_DIR="${HOME}/.local/bin" &&
+        curl -LsSf https://astral.sh/uv/install.sh | sh
+      - ${HOME}/.local/bin/uv sync --group docs
     post_create_environment:
       - corepack enable
       - corepack prepare --activate yarn@4.9.2
@@ -22,15 +27,14 @@ build:
       - yarn install
       - yarn build:debug
       - yarn docs
+    build:
+      html:
+        - >-
+          ${HOME}/.local/bin/uv run
+          mkdocs build --config-file docs/mkdocs.yml
+    post_build:
+      - mkdir -p ${READTHEDOCS_OUTPUT}/html/
+      - mv docs/site/* ${READTHEDOCS_OUTPUT}/html
 
 mkdocs:
   configuration: docs/mkdocs.yml
-
-
-# Optionally declare the Python requirements required to build your docs
-
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: '.'

.github/dependabot.yml

@@ -35,11 +35,11 @@ updates:
       npm:
         patterns:
           - "*"
-  - package-ecosystem: pip
+  - package-ecosystem: uv
     directory: /
     schedule:
       interval: "weekly"
     groups:
-      pip:
+      uv-pip:
         patterns:
           - "*"

.github/workflows/bump-n-release.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Setup nushell
         uses: hustcer/setup-nu@v3
         with:
-          version: '0.106.0'
+          version: ${{ vars.NU_SHELL_VERSION || '*' }}
 
       - name: Install cargo-binstall
         uses: cargo-bins/cargo-binstall@main

.github/workflows/docs.yml

@@ -21,20 +21,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         with:
-          python-version: 3.x
+          enable-cache: true
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
       - run: yarn install
-      - name: Build Node.js type definitions
-        run: yarn build:debug
-      - name: Generate Node.js API docs
-        run: yarn docs
-      - run: pip install -r docs/requirements.txt
-      - run: pip install .
-      - run: mkdocs build --config-file docs/mkdocs.yml --strict
+      - name: Setup nushell
+        uses: hustcer/setup-nu@v3
+        with:
+          version: ${{ vars.NU_SHELL_VERSION || '*' }}
+      - run: nu -c "use nurfile *; nur docs build"
       - name: Save docs build as artifact
         uses: actions/upload-artifact@v4
         with:
@@ -47,7 +45,11 @@ jobs:
       - uses: actions/checkout@v4
       - name: Setup Rust
         run: rustup update --no-self-update
-      - run: cargo doc --no-deps --lib -p rf24-rs -p rf24ble-rs
+      - name: Setup nushell
+        uses: hustcer/setup-nu@v3
+        with:
+          version: ${{ vars.NU_SHELL_VERSION || '*' }}
+      - run: nu -c "use nurfile *; nur docs rs"
       - name: save docs as artifact
         uses: actions/upload-artifact@v4
         with:

.github/workflows/pre-commit.yml

@@ -12,25 +12,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v6
         id: python-setup
         with:
-          python-version: 3.x
-          cache: "pip"
-          cache-dependency-path: examples/python/requirements*.txt
-      - name: Install workflow tools
-        run: >-
-          python -m pip install
-          -r examples/python/requirements.txt
-          -r examples/python/requirements-dev.txt
-      - run: mypy
+          enable-cache: true
       - name: Cache pre-commit environments
         uses: actions/cache@v4
         with:
           path: '~/.cache/pre-commit'
-          key: pre-commit-${{ steps.python-setup.outputs.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}
-      - run: pip install pre-commit
-      - run: pre-commit run --show-diff-on-failure --color=always --all-files
+          key: pre-commit-${{ steps.python-setup.outputs.uv-version }}-${{ hashFiles('.pre-commit-config.yaml') }}
+      - run: uvx pre-commit run --show-diff-on-failure --color=always --all-files
 
   lint-rust:
     runs-on: ubuntu-latest

.github/workflows/rust.yml

@@ -41,6 +41,10 @@ jobs:
         uses: cargo-bins/cargo-binstall@main
       - name: Install cargo-llvm-cov and cargo-nextest
         run: cargo binstall -y cargo-nextest cargo-llvm-cov
+      - name: Setup nushell
+        uses: hustcer/setup-nu@v3
+        with:
+          version: ${{ vars.NU_SHELL_VERSION || '*' }}
       - name: Cache deps
         uses: actions/cache@v4
         with:
@@ -49,17 +53,11 @@ jobs:
       - run: rustup component add llvm-tools-preview
         # this enables a tool (for default toolchain) needed to measure code coverage.
       - name: Run tests
-        run: >-
-          cargo llvm-cov --no-report nextest
-          -p rf24-rs
-          -p rf24ble-rs
-          --lib
-          --tests
-          --color always
-          --profile ci
+        run: nu -c "use nurfile *; nur test --profile ci"
       - name: Generate coverage reports
-        run: cargo llvm-cov report --lcov --output-path lcov.info
+        run: nu -c "use nurfile *; nur test lcov"
       - uses: codecov/codecov-action@v5
+        if: github.repository == 'nRF24/rf24-rs'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: lcov.info
@@ -68,20 +66,24 @@ jobs:
   publish:
     name: Publish
     runs-on: ubuntu-latest
-    if: startswith(github.ref, 'refs/tags')
+    if: startswith(github.ref, 'refs/tags/')
     permissions:
       contents: write
     steps:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
+      - name: Setup nushell
+        uses: hustcer/setup-nu@v3
+        with:
+          version: ${{ vars.NU_SHELL_VERSION || '*' }}
       - name: Get pkg from tag
         id: pkg
-        shell: bash
-        run: |
-          tag=${{ github.ref_name }}
-          pkg=$(echo "$tag" | sed -E 's;([^/]+)/.*;\1;')
-          echo "name=$pkg" >> "$GITHUB_OUTPUT"
+        shell: nu {0}
+        run: |-
+          let tag = ${{ github.ref_name }}
+          let pkg = $tag | parse "{name}/{version}" | first
+          $"name=($pkg | get name)\n" | save --append $env.GITHUB_OUTPUT
       - name: Install Rust
         run: rustup update stable --no-self-update
       - run: cargo publish -p ${{ steps.pkg.outputs.name }}

.pre-commit-config.yaml

@@ -14,16 +14,19 @@ repos:
       exclude: .yarn/releases/yarn.*js
     - id: mixed-line-ending
       args: ['--fix=lf']
-    - id: requirements-txt-fixer
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.9.10
+  rev: v0.12.7
   hooks:
     # Run the linter.
-    - id: ruff
+    - id: ruff-check
     # Run the formatter.
     - id: ruff-format
 - repo: https://github.com/streetsidesoftware/cspell-cli
-  rev: v9.0.1
+  rev: v9.2.0
   hooks:
     - id: cspell # Spell check changed files
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: 'v1.17.0'
+  hooks:
+    - id: mypy