Add ruff lint and format check to CI

.github/workflows/ci.yml

@@ -6,6 +6,25 @@ on:
   pull_request:
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # ruff version is read from the `lint` extra in pyproject.toml
+      - name: ruff check
+        uses: astral-sh/ruff-action@v3
+        with:
+          version-file: pyproject.toml
+          args: check
+
+      - name: ruff format
+        uses: astral-sh/ruff-action@v3
+        with:
+          version-file: pyproject.toml
+          args: format --check
+
   test:
     runs-on: ubuntu-latest
     strategy:

README.md

@@ -60,7 +60,9 @@ sco.plot()
 ## Development
 
 ```bash
-pip install -e ".[test]" mypy
+pip install -e ".[test,lint]" mypy
+ruff check .                # lint
+ruff format .               # format
 mypy src/pathsim_fusion    # type check
 pytest tests/ -v            # run tests
 ```

docs/source/examples/linear_feedback.ipynb

@@ -41,8 +41,8 @@
     "# Apply PathSim docs matplotlib style for consistent, theme-friendly figures\n",
     "plt.style.use(\"../pathsim_docs.mplstyle\")\n",
     "\n",
-    "from pathsim import Simulation, Connection\n",
-    "from pathsim.blocks import Source, Integrator, Amplifier, Adder, Scope"
+    "from pathsim import Connection, Simulation\n",
+    "from pathsim.blocks import Adder, Amplifier, Integrator, Scope, Source"
    ]
   },
   {

environment.yml

@@ -24,4 +24,4 @@ dependencies:
   - ipykernel
   - mypy
   - pip:
-      - -e .[test]
+      - -e .[test,lint]

pyproject.toml

@@ -48,6 +48,10 @@ test = [
     "pytest>=7.0",
     "pytest-cov>=4.0",
 ]
+# Pinned so local runs and CI apply the same default rule set
+lint = [
+    "ruff==0.17.3",
+]
 
 [project.urls]
 Homepage = "https://pathsim.org"
@@ -69,3 +73,6 @@ files = ["src/pathsim_fusion"]
 python_version = "3.10"
 ignore_missing_imports = true
 warn_unused_ignores = true
+
+[tool.ruff]
+src = ["src", "tests"]