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 lint` to run `ruff`,
`make nbclean` to run `nbstripout` or `make test`
to run both.

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

Author: alimaredia

.github/workflows/ci-quality.yml renamed to .github/workflows/formatting-tests.yml

@@ -1,4 +1,4 @@
-name: Pre-commit checks
+name: Formatting Tests
 
 on:
   pull_request:
@@ -7,21 +7,19 @@ on:
       - "**/*.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 +36,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
+        run: pip install ruff nbstripout
 
-      - name: Run pre-commit
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: --all-files --show-diff-on-failure
+      - name: Run Formatting Tests
+        run: make test

.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,16 @@
+.PHONY: lint nbcleanup test
+
+USE_CASES := $(wildcard notebooks/use-cases/*.ipynb)
+TUTORIALS := $(wildcard notebooks/tutorials/*.ipynb)
+ALL_NOTEBOOKS := $(USE_CASES) $(TUTORIALS)
+
+lint:
+	@echo "Running ruff format..."
+	ruff format
+
+nbcleanup:
+	@echo "Running nbstripout..."
+	nbstripout $(ALL_NOTEBOOKS)
+
+test: lint nbcleanup
+	@echo "All test completed successfully :)"

requirements-dev.txt

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