Removing auto-running of pre-commit, move tests to Makefile

This commit changes the harness running ruff
and nbstripout from pre-commit to a Makefile.

Developers can run `make format-python` to run `ruff format`
and format python files.

Developers can also run `make format-notebooks` to
run `nbstripout` and format notebooks.

`make format-{notebook,python}-check`
checks that files have been appropriately formatted.

These checks are run as workflows when python or
notebooks files are changed.

Signed-off-by: Ali Maredia <[email protected]>

Author: alimaredia

.github/workflows/validate-and-execute-notebooks.yml

@@ -1,4 +1,4 @@
-name: Smoke Tests for Notebooks
+name: Validation & Smoke Tests for Notebooks
 
 on:
   pull_request:
@@ -105,9 +105,12 @@ jobs:
 
       - name: Install Testing Tools
         run: |
-          pip install papermill ipykernel
+          pip install papermill ipykernel nbstripout
           ipython kernel install --name "python3" --user
 
+      - name: Run Formatting Tests
+        run: make format-notebooks-check
+
       - name: Execute Notebooks
         run: |
           set -ux

.github/workflows/ci-quality.yml renamed to .github/workflows/validate-python.yml

@@ -1,27 +1,24 @@
-name: Pre-commit checks
+name: Python Formatting Validation
 
 on:
+  workflow_dispatch:
   pull_request:
     types: [opened, synchronize, reopened]
     paths:
       - "**/*.py"
-      - "**/*.ipynb"
       - ".pre-commit-config.yaml"
+      - "Makefile"
       - "pyproject.toml"
   pull_request_target:
     types: [closed]
     paths:
       - "**/*.py"
-      - "**/*.ipynb"
       - ".pre-commit-config.yaml"
+      - "Makefile"
       - "pyproject.toml"
 
-concurrency:
-  group: pre-commit-${{ github.ref }}z
-  cancel-in-progress: true
-
 jobs:
-  pre-commit:
+  formatting-test:
     if: github.event_name != 'pull_request_target' || github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     permissions:
@@ -38,16 +35,8 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Cache pre-commit envs
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/pre-commit
-          key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }}
-
-      - name: Install pre-commit
-        run: pip install pre-commit
+      - name: Install python formatting test dependencies
+        run: pip install ruff
 
-      - name: Run pre-commit
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: --all-files --show-diff-on-failure
+      - name: Run Formatting Tests
+        run: make format-python-check

.pre-commit-config.yaml

@@ -4,28 +4,9 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.13.0
     hooks:
-      - id: ruff
-        name: ruff-check
-        args: [--fix, --show-fixes]
-        types_or: [python]
       - id: ruff-format
         name: ruff-format
         types_or: [python]
-
-  # Import ordering (aligned with Black)
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
-    hooks:
-      - id: isort
-        types_or: [python]
-
-  # Canonical Python formatter
-  - repo: https://github.com/psf/black
-    rev: 24.8.0
-    hooks:
-      - id: black
-        types_or: [python]
-
   # Strip notebook outputs anywhere in repo
   - repo: https://github.com/kynan/nbstripout
     rev: 0.8.1
@@ -39,4 +20,4 @@ exclude: |
     ^\.venv/|^venv/|
     ^\.pytest_cache/|^\.mypy_cache/|
     ^\.ipynb_checkpoints/
-  )
+  )

Makefile

@@ -0,0 +1,21 @@
+.PHONY: format-python format-notebook format-python-check format-notebooks-check
+
+USE_CASES := $(wildcard notebooks/use-cases/*.ipynb)
+TUTORIALS := $(wildcard notebooks/tutorials/*.ipynb)
+ALL_NOTEBOOKS := $(USE_CASES) $(TUTORIALS)
+
+format-python:
+	@echo "Running ruff format..."
+	ruff format
+
+format-notebooks:
+	@echo "Running nbstripout..."
+	nbstripout $(ALL_NOTEBOOKS)
+
+format-notebooks-check: lint nbcleanup
+	nbstripout --verify $(ALL_NOTEBOOKS)
+	@echo "nbstripout check passed :)"
+
+format-python-check: lint nbcleanup
+	ruff format --check
+	@echo "ruff format check passed :)"

requirements-dev.txt

@@ -0,0 +1,2 @@
+ruff
+nbstripout