rhiza 0.8.8__tar.gz → 0.9.1__tar.gz

{rhiza-0.8.8 → rhiza-0.9.1}/.editorconfig

@@ -24,6 +24,11 @@ indent_size = 2
 # [*.{md,markdown}]
 # trim_trailing_whitespace = false
 
+# Makefiles require tabs
+[{Makefile,*.mk,*.make}]
+indent_style = tab
+indent_size = 4
+
 # Don't apply editorconfig rules to vendor/ resources
 # This is a "defensive" rule for the day we may have
 # the vendor folder

rhiza-0.8.8/.rhiza/agentic/Makefile.agentic → rhiza-0.9.1/.github/agents/agentic.mk

@@ -1,8 +1,8 @@
-## Makefile.customisations - User-defined scripts and overrides
+## customisations.mk - User-defined scripts and overrides
 # This file is included by the main Makefile
 
 # Declare phony targets
-.PHONY: install-copilot analyse-repo summarize-changes
+.PHONY: install-copilot analyse-repo summarise-changes
 
 COPILOT_BIN ?= $(shell command -v copilot 2>/dev/null || echo "$(INSTALL_DIR)/copilot")
 ##@ Agentic Workflows
@@ -17,8 +17,8 @@ analyse-repo: install-copilot ## run the analyser agent to update REPOSITORY_ANA
 		--allow-tool 'write' --deny-tool 'remove' \
 		--allow-all-paths
 
-summarize-changes: install-copilot ## summarize changes since the most recent release/tag
-	@"$(COPILOT_BIN)" -p "Show me the commits since the last release/tag and summarize them" --allow-tool 'shell(git)' --model "$(DEFAULT_AI_MODEL)" --agent summarise
+summarise-changes: install-copilot ## summarise changes since the most recent release/tag
+	@"$(COPILOT_BIN)" -p "Show me the commits since the last release/tag and summarise them" --allow-tool 'shell(git)' --model "$(DEFAULT_AI_MODEL)" --agent summarise
 
 install-copilot:  ## checks for copilot and prompts to install
 	@if command -v copilot >/dev/null 2>&1; then \

{rhiza-0.8.8 → rhiza-0.9.1}/.github/copilot-instructions.md

@@ -1,7 +1,7 @@
 # Rhiza Copilot Instructions
 
-You are working in a project that utilizes the `rhiza` framework. Rhiza is a collection of reusable
-configuration templates and tooling designed to standardize and streamline modern Python development.
+You are working in a project that utilises the `rhiza` framework. Rhiza is a collection of reusable
+configuration templates and tooling designed to standardise and streamline modern Python development.
 
 As a Rhiza-based project, this workspace adheres to specific conventions for structure, dependency management, and automation.
 

rhiza-0.8.8/.github/Makefile.gh → rhiza-0.9.1/.github/github.mk

@@ -1,4 +1,4 @@
-## Makefile.gh - github repo maintenance and helpers
+## github.mk - github repo maintenance and helpers
 # This file is included by the main Makefile
 
 # Declare phony targets

rhiza-0.9.1/.github/workflows/rhiza_benchmarks.yml

@@ -0,0 +1,83 @@
+# This file is part of the jebel-quant/rhiza repository
+# (https://github.com/jebel-quant/rhiza).
+#
+# Workflow: Performance Benchmarks
+#
+# Purpose: Run performance benchmarks and detect regressions.
+#
+# Trigger: On push to main/master branches, PRs, and manual trigger.
+#
+# Regression Detection:
+#   - Compares against previous benchmark results stored in gh-pages branch
+#   - Alerts if performance degrades by more than 150% (configurable)
+#   - PRs will show a warning comment but not fail
+#   - Main branch updates the baseline for future comparisons
+
+name: "(RHIZA) BENCHMARKS"
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6.0.2
+        with:
+          lfs: true
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7.2.1
+        with:
+          version: "0.9.28"
+          python-version: "3.12"
+
+      - name: Run benchmarks
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
+        run: |
+          make benchmark
+
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v6.0.0
+        if: always()
+        with:
+          name: benchmark-results
+          path: |
+            _benchmarks/benchmarks.json
+            _benchmarks/benchmarks.svg
+            _benchmarks/benchmarks.html
+
+      # Regression detection using github-action-benchmark
+      # Stores benchmark history in gh-pages branch under /benchmarks
+      # Alerts if performance degrades by more than 150% of baseline
+      - name: Store benchmark result and check for regression
+        uses: benchmark-action/github-action-benchmark@v1
+        # run this only if _benchmarks/benchmarks.json exists
+        if: hashFiles('_benchmarks/benchmarks.json') != ''
+        with:
+          tool: 'pytest'
+          output-file-path: _benchmarks/benchmarks.json
+          # Store benchmark data in gh-pages branch
+          gh-pages-branch: gh-pages
+          benchmark-data-dir-path: benchmarks
+          # Only update baseline on main branch push (not PRs)
+          auto-push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+          # Alert if performance degrades by more than 150%
+          alert-threshold: '150%'
+          # Post comment on PR if regression detected
+          comment-on-alert: ${{ github.event_name == 'pull_request' }}
+          # Fail workflow if regression detected (disabled for PRs to allow investigation)
+          fail-on-alert: ${{ github.event_name == 'push' }}
+          # GitHub token for pushing to gh-pages and commenting
+          github-token: ${{ secrets.GITHUB_TOKEN }}

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_book.yml

@@ -14,7 +14,7 @@
 #   - 🧪 Run tests and generate coverage reports
 #   - 🚀 Deploy combined documentation to GitHub Pages
 
-name: "BOOK"
+name: "(RHIZA) BOOK"
 
 on:
   push:
@@ -36,39 +36,42 @@ jobs:
 
     steps:
       # Check out the repository code
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
         with:
           lfs: true
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v7.2.1
         with:
-          version: "0.9.24"
+          version: "0.9.28"
 
       - name: "Sync the virtual environment for ${{ github.repository }}"
         shell: bash
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
         run: |
-          export UV_EXTRA_INDEX_URL="${{ secrets.uv-extra-index-url }}"
           # will just use .python-version?
           uv sync --all-extras --all-groups --frozen
 
       - name: "Make the book"
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
         run: |
           make book
 
       # Step 5: Package all artifacts for GitHub Pages deployment
       # This prepares the combined outputs for deployment by creating a single artifact
       - name: Upload static files as artifact
-        uses: actions/upload-pages-artifact@v4  # Official GitHub Pages artifact upload action
+        uses: actions/upload-pages-artifact@v4.0.0  # Official GitHub Pages artifact upload action
         with:
           path: _book/  # Path to the directory containing all artifacts to deploy
 
       # Step 6: Deploy the packaged artifacts to GitHub Pages
       # This step publishes the content to GitHub Pages
       # The deployment is conditional based on whether the repository is a fork and the PUBLISH_COMPANION_BOOK variable is set
-      # If the repository is a fork, deployment is skipped to avoid unauthorized publishing
+      # If the repository is a fork, deployment is skipped to avoid unauthorised publishing
       # If PUBLISH_COMPANION_BOOK is not set, it defaults to allowing deployment
       - name: Deploy to GitHub Pages
         if: ${{ !github.event.repository.fork && (vars.PUBLISH_COMPANION_BOOK == 'true' || vars.PUBLISH_COMPANION_BOOK == '') }}
-        uses: actions/deploy-pages@v4  # Official GitHub Pages deployment action
+        uses: actions/deploy-pages@v4.0.5  # Official GitHub Pages deployment action
         continue-on-error: true

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_ci.yml

@@ -7,7 +7,7 @@
 #
 # Trigger: On push and pull requests to main/master branches.
 
-name: CI
+name: (RHIZA) CI
 
 permissions:
   contents: read
@@ -24,17 +24,21 @@ jobs:
     outputs:
       matrix: ${{ steps.versions.outputs.list }}
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
+        with:
+          lfs: true
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v7.2.1
         with:
-          version: "0.9.24"
+          version: "0.9.28"
 
       - id: versions
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
         run: |
           # Generate Python versions JSON from the script
-          JSON=$(make -s version-matrix)
+          JSON=$(make -f .rhiza/rhiza.mk -s version-matrix)
           echo "list=$JSON" >> "$GITHUB_OUTPUT"
 
       - name: Debug matrix
@@ -51,16 +55,36 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v6.0.2
         with:
           lfs: true
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v7.2.1
         with:
-          version: "0.9.24"
+          version: "0.9.28"
           python-version: ${{ matrix.python-version }}
 
       - name: Run tests
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
         run: |
           make test
+
+
+  docs-coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6.0.2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7.2.1
+        with:
+          version: "0.9.28"
+
+      - name: Check docs coverage
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
+        run: |
+          make docs-coverage

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_codeql.yml

@@ -9,7 +9,22 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL Advanced"
+# ******** IMPORTANT: GitHub Advanced Security Required ********
+# CodeQL is FREE for public repositories, but requires GitHub Advanced Security
+# (part of GitHub Enterprise) for private repositories.
+#
+# This workflow automatically:
+# - Runs on public repositories
+# - Skips on private repositories (unless Advanced Security is available)
+#
+# To control this behavior, set the CODEQL_ENABLED repository variable:
+# - Set to 'true' to force enable (if you have Advanced Security on private repos)
+# - Set to 'false' to disable entirely
+# - Leave unset for automatic behavior (recommended)
+#
+# For more information, see docs/CUSTOMIZATION.md
+#
+name: "(RHIZA) CODEQL"
 
 on:
   push:
@@ -28,7 +43,15 @@ jobs:
     #   - https://gh.io/using-larger-runners (GitHub.com only)
     # Consider using larger runners or machines with greater resources for possible analysis time improvements.
     runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
-    if: ${{ !github.event.repository.private }}
+    # CodeQL requires GitHub Advanced Security (part of GitHub Enterprise).
+    # For users without Enterprise license:
+    # - Public repositories: CodeQL is available for free
+    # - Private repositories: Requires GitHub Advanced Security
+    # To disable this workflow, set CODEQL_ENABLED repository variable to 'false'
+    # To enable this workflow for private repos with Advanced Security, set CODEQL_ENABLED to 'true'
+    if: |
+      vars.CODEQL_ENABLED == 'true' ||
+      (vars.CODEQL_ENABLED != 'false' && github.event.repository.visibility == 'public')
     permissions:
       # required for all workflows
       security-events: write
@@ -58,7 +81,7 @@ jobs:
         # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v6
+      uses: actions/checkout@v6.0.2
 
     # Add any setup steps before running the `github/codeql-action/init` action.
     # This includes steps like installing compilers or runtimes (`actions/setup-node`
@@ -68,7 +91,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v4
+      uses: github/codeql-action/init@v4.32.0
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
@@ -97,6 +120,6 @@ jobs:
         exit 1
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v4
+      uses: github/codeql-action/analyze@v4.32.0
       with:
         category: "/language:${{matrix.language}}"

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_deptry.yml

@@ -10,7 +10,7 @@
 # Trigger: This workflow runs on every push and on pull requests to main/master
 #          branches (including from forks)
 
-name: "DEPTRY"
+name: "(RHIZA) DEPTRY"
 
 # Permissions: Only read access to repository contents is needed
 permissions:
@@ -27,14 +27,14 @@ jobs:
     name: Check dependencies with deptry
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/astral-sh/uv:0.9.24-python3.12-trixie
+      image: ghcr.io/astral-sh/uv:0.9.28-bookworm
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
 
       - name: Run deptry
         run: make deptry
         # NOTE: make deptry is good style because it encapsulates the folders to check
         # (e.g. src and book/marimo) and keeps CI in sync with local development.
-        # Since we use a 'uv' container, the Makefile is optimized to use the
+        # Since we use a 'uv' container, the Makefile is optimised to use the
         # pre-installed 'uv' and 'uvx' from the system PATH.

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_marimo.yml

@@ -15,7 +15,7 @@
 #   - 🧪 Run each notebook in parallel using a matrix strategy
 #   - ✅ Fail-fast disabled to report all failing notebooks
 
-name: "MARIMO"
+name: "(RHIZA) MARIMO"
 
 permissions:
   contents: read
@@ -34,13 +34,16 @@ jobs:
       notebook-list: ${{ steps.notebooks.outputs.matrix }}
     steps:
       # Check out the repository code
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
 
       # Find all Python files in the marimo folder and create a matrix for parallel execution
       - name: Find notebooks and build matrix
         id: notebooks
         run: |
-          NOTEBOOK_DIR="book/marimo"
+          # Extract MARIMO_FOLDER from the project configuration (via Makefile)
+          # shellcheck disable=SC2016 # Single quotes intentional - Make syntax, not shell expansion
+          NOTEBOOK_DIR=$(make -s -f Makefile -f - <<< 'print: ; @echo $(or $(MARIMO_FOLDER),marimo)' print)
+
           echo "Searching notebooks in: $NOTEBOOK_DIR"
           # Check if directory exists
           if [ ! -d "$NOTEBOOK_DIR" ]; then
@@ -72,18 +75,20 @@ jobs:
     name: Run notebook ${{ matrix.notebook }}
     steps:
       # Check out the repository code
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
         with:
           lfs: true
 
       # Install uv/uvx
       - name: Install uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v7.2.1
         with:
-          version: "0.9.24"
+          version: "0.9.28"
 
       # Execute the notebook with the appropriate runner based on its content
       - name: Run notebook
+        env:
+          UV_EXTRA_INDEX_URL: ${{ secrets.UV_EXTRA_INDEX_URL }}
         run: |
           uvx uv run "${{ matrix.notebook }}"
           # uvx → creates a fresh ephemeral environment

rhiza-0.9.1/.github/workflows/rhiza_mypy.yml

@@ -0,0 +1,34 @@
+# This file is part of the jebel-quant/rhiza repository
+# (https://github.com/jebel-quant/rhiza).
+#
+# Workflow: Mypy
+#
+# Purpose: Run static type checking with mypy in strict mode to ensure
+#          type safety across the codebase.
+#
+# Trigger: On push and pull requests to main/master branches.
+
+name: "(RHIZA) MYPY"
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  mypy:
+    name: Static type checking with mypy
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/astral-sh/uv:0.9.28-bookworm
+
+    steps:
+      - uses: actions/checkout@v6
+
+      # to brutal for now
+      # - name: Run mypy
+      #   run: make -f .rhiza/rhiza.mk mypy

{rhiza-0.8.8 → rhiza-0.9.1}/.github/workflows/rhiza_pre-commit.yml

@@ -14,7 +14,7 @@
 # Components:
 #   - 🔍 Run pre-commit checks using reusable action
 
-name: "PRE-COMMIT"
+name: "(RHIZA) PRE-COMMIT"
 permissions:
   contents: read
 
@@ -29,7 +29,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v6.0.2
 
       # Run pre-commit
       - name: Run pre-commit