update 2026

Author: bitplane

.github/workflows/release.yml

@@ -10,11 +10,11 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python 3.10
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
       - name: Build dev environment
@@ -27,7 +27,3 @@ jobs:
         env:
           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
         run: make release
-      - name: Update docs
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: make docs

.github/workflows/unit-tests.yml

@@ -13,9 +13,9 @@ jobs:
         python-version: ["3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Build dev environment

scripts/clean.sh

@@ -1,12 +1,13 @@
 #!/usr/bin/env bash
-
-rm -r .venv                                         2>/dev/null
-rm .coverage                                        2>/dev/null
-rm -r htmlcov                                       2>/dev/null
-rm .git/hooks/pre-commit                            2>/dev/null
-find . -name '__pycache__' -exec rm -rv {} \;       2>/dev/null
-find . -name '*.egg-info' -exec rm -rv {} \;        2>/dev/null
-find . -name '.pytest_cache' -exec rm -rv {} \;     2>/dev/null
-rm ./dist -r                                        2>/dev/null
+(
+  rm -r .venv
+  rm .coverage
+  rm -r htmlcov
+  rm .git/hooks/pre-commit
+  find . -name '__pycache__' -exec rm -rv {} \;
+  find . -name '*.egg-info' -exec rm -rv {} \;
+  find . -name '.pytest_cache' -exec rm -rv {} \;
+  rm ./dist -r
+) 2>/dev/null
 
 echo Cleaned project

scripts/coverage.sh

@@ -4,9 +4,12 @@ source .venv/bin/activate
 
 package_name=$(echo "$1" | tr '-' '_')
 
-# Run pytest with coverage reports and tee output
+# Run pytest with coverage reports, teeing text output for LLMs to read
 mkdir -p htmlcov
-pytest --cov="src/$package_name" --cov-report=html --cov-report=term-missing . 2>&1 | tee htmlcov/coverage_report.txt
+pytest --cov="src/$package_name"    \
+       --cov-report=html            \
+       --cov-report=term-missing    \
+       --cov-context=test . 2>&1    | tee htmlcov/coverage_report.txt
 
 # Extract just the missing coverage summary
 grep -A 20 "Missing" htmlcov/coverage_report.txt > htmlcov/missing_coverage.txt || true

scripts/docs.sh

@@ -4,6 +4,7 @@ set -e
 
 # Variables
 PROJECT_NAME=$(basename "$(pwd)")
+MODULE_NAME=$(echo "$PROJECT_NAME" | tr '-' '_')
 REPO_URL="ssh://git@github.com/bitplane/bitplane.net.git"
 SRC_PATH="docs"
 DEST_PATH="dev/python/$PROJECT_NAME"
@@ -14,7 +15,7 @@ COMMIT_MSG="Update $PROJECT_NAME docs"
 
 mkdir -p docs/pydoc
 cd src
-pydoc-markdown -p "$PROJECT_NAME" > ../docs/pydoc/index.md
+pydoc-markdown -p "$MODULE_NAME" > ../docs/pydoc/index.md
 cd ..
 
 # Check out the main website repo

scripts/venv.sh

@@ -1,4 +1,13 @@
 #!/usr/bin/env bash
 
-python3 -m venv .venv
+# create the python virtual environment
+if [[ ! -d .venv ]]; then
+    if command -v uv >/dev/null 2>&1; then
+        uv venv
+    else
+        python3 -m venv .venv
+    fi
+fi
+
+# activate it
 source .venv/bin/activate