switch to using uv for project management (#127)

Author: joshuadavidthomas

.envrc

@@ -7,29 +7,30 @@ on:
       - "examples/**.yml"
       - "src/**"
       - "copier.yml"
+  workflow_call:
   workflow_dispatch:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref }}
+  group: examples-${{ github.head_ref }}
   cancel-in-progress: true
 
 env:
   PYTHONUNBUFFERED: "1"
   FORCE_COLOR: "1"
 
 jobs:
-  examples:
+  generate:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
       - uses: extractions/setup-just@v2
 
-      - uses: westerveltco/setup-ci-action@v0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: "3.8"
-          python-requirements: requirements-dev.lock
-          use-uv: true
+          enable-cache: true
+          version: "0.4.x"
 
       - name: Setup Git
         run: |
@@ -40,6 +41,31 @@ jobs:
         run: |
           just generate-examples
 
+      - name: Upload examples artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: generated-examples
+          path: examples/
+
+  update-repo:
+    needs: generate
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download examples artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: generated-examples
+          path: examples/
+
+      - name: Setup Git
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "[email protected]"
+
       - name: Get SHA of push commit
         id: shortsha
         run: echo "shortsha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT

.github/workflows/examples.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref }}
+  group: test-${{ github.head_ref }}
   cancel-in-progress: true
 
 env:
@@ -19,34 +19,15 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: westerveltco/setup-ci-action@v0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: "3.8"
-          python-requirements: requirements-dev.lock
-          use-uv: true
+          enable-cache: true
+          version: "0.4.x"
 
       - name: Run tests
         run: |
-          python -m pytest
+          uv run pytest
 
   examples:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: extractions/setup-just@v2
-
-      - uses: westerveltco/setup-ci-action@v0
-        with:
-          python-version: "3.8"
-          python-requirements: requirements-dev.lock
-          use-uv: true
-
-      - name: Setup Git
-        run: |
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "[email protected]"
-
-      - name: Generate examples
-        run: |
-          just generate-examples
+    uses: ./.github/workflows/examples.yml

.github/workflows/test.yml

@@ -1,47 +1,36 @@
 set dotenv-load := true
+set unstable := true
 
-@_default:
-    just --list
+[private]
+default:
+    @just --list
 
-bootstrap *ARGS:
-    rye sync {{ ARGS }}
-
-lock *ARGS:
-    rye lock {{ ARGS }}
-
-# ----------------------------------------------------------------------
-# EXAMPLES
-# ----------------------------------------------------------------------
-
-# generate all examples from examples/*.yml copier answer files
-@generate-examples:
-    for file in `ls examples/*.yml`; do \
-        just _generate-example $file; \
-    done
+[private]
+fmt:
+    @just --fmt
 
-_generate-example DATA_FILE:
+[private]
+@generate-example DATA_FILE:
     #!/usr/bin/env bash
 
     set -euo pipefail
 
     DIRECTORY="{{ trim_end_match(DATA_FILE, '.yml') }}"
     rm -rf $DIRECTORY
 
-    COMMAND="copier copy -r HEAD . $DIRECTORY --force --trust --data-file {{ DATA_FILE }}"
-    if [ -z "$(command -v rye)" ]; then
-        eval $COMMAND
-    else
-        rye run $COMMAND
-    fi
+    uv run copier copy -r HEAD . $DIRECTORY --force --trust --data-file {{ DATA_FILE }}
 
-# ----------------------------------------------------------------------
-# UTILS
-# ----------------------------------------------------------------------
+bootstrap:
+    uv python install
+    uv sync --frozen
 
-# format justfile
-fmt:
-    just --fmt --unstable
+generate-examples:
+    for file in `ls examples/*.yml`; do \
+        just generate-example $file; \
+    done
 
-# run pre-commit on all files
 lint:
-    rye run pre-commit run --all-files
+    uv run --with pre-commit-uv pre-commit run --all-files
+
+lock *ARGS:
+    uv lock {{ ARGS }}

Justfile

@@ -1,6 +1,5 @@
 # django-twc-package
 
-[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/mitsuhiko/rye/main/artwork/badge.json)](https://rye-up.com)
 [![Copier](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joshuadavidthomas/7c88611504b557ff7aa2a7524ad996e2/raw/4ba6834953dd8a14afc3dbb7bb41f49f181a59bf/badge.json)](https://copier.readthedocs.io)
 
 `django-twc-package` is the template for a Django package at The Westervelt Company. This template is a starting point for creating a new Django package that can be installed and used in other projects.

README.md

@@ -1,10 +1,9 @@
-[build-system]
-build-backend = "hatchling.build"
-requires = ["hatchling"]
-
 [project]
 authors = [{name = "Josh", email = "[email protected]"}]
-dependencies = ["copier>=9.1.1", "copier-templates-extensions>=0.3.0"]
+dependencies = [
+  "copier>=9.1.1",
+  "copier-templates-extensions>=0.3.0"
+]
 description = "A Django package template for The Westervelt Company."
 dynamic = ["version"]
 license = {file = "LICENSE"}
@@ -25,13 +24,6 @@ version_pattern = "YYYY.INC1"
 "copier.yml" = ['default: "{version}"']
 "tests/test_version.py" = ['assert version == "{version}"']
 
-[tool.hatch.metadata]
-allow-direct-references = true
-
-[tool.hatch.version]
-path = "VERSION"
-pattern = "^(?P<version>[0-9]+(?:\\.[0-9]+)*)$"
-
 [tool.pytest.ini_options]
 addopts = "-n auto --dist loadfile --doctest-modules"
 norecursedirs = ".* bin build dist *.egg examples htmlcov logs node_modules src templates venv"
@@ -103,7 +95,7 @@ required-imports = ["from __future__ import annotations"]
 # Preserve types, even if a file imports `from __future__ import annotations`.
 keep-runtime-typing = true
 
-[tool.rye]
+[tool.uv]
 dev-dependencies = [
   "bumpver>=2023.1129",
   "djlint>=1.34.1",
@@ -115,5 +107,3 @@ dev-dependencies = [
   "jinja2>=3.1.3",
   "pre-commit>=3.5.0"
 ]
-managed = true
-virtual = true