Add ruff github action (#3)

Author: SallySoul

.github/workflows/ruff.yml

@@ -0,0 +1,17 @@
+name: Ruff
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  lint_and_format:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: astral-sh/ruff-action@v3
+    - run: ruff check
+    - run: ruff format --check --diff

README.md

@@ -1,5 +1,7 @@
 # nhls_py
 
+![Rust workflow](https://github.com/TEALab-org/nhls_py/actions/workflows/ruff.yml/badge.svg?branch=main)
+
 A python module for utilizing [`nhls`](https://github.com/TEALab-org/nhls).
 `nhls_py` is not bindings to a rust library.
 Instead it generates rust code 

nhls_py/__init__.py

@@ -1,6 +1,5 @@
 from .session_init import session_init as session_init
 
-# Module level variable to store the location 
+# Module level variable to store the location
 # nhls checkout / build artifacts
 nhls_path = "~/.cache/nhls"
-

nhls_py/session_init.py

@@ -2,20 +2,19 @@
 from importlib.resources import files
 from pathlib import Path
 import subprocess
-from . import nhls_path 
+from . import nhls_path
 
+
+# Test if we can run rustup commands
 def check_rustup_present():
     try:
-        subprocess.run(
-            ["rustup"], 
-            stdout=subprocess.DEVNULL, 
-            stderr=subprocess.DEVNULL
-        )
+        subprocess.run(["rustup"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
         return True
     except FileNotFoundError:
-        return False    
+        return False
 
-def session_init(nhls_path_override = None):
+
+def session_init(nhls_path_override=None):
     # Load NHLS version information
     nhls_version_path = files("nhls_py") / "nhls_version.json"
     print(f"nhls_version_path: {nhls_version_path}")
@@ -27,8 +26,8 @@ def session_init(nhls_path_override = None):
     nhls_url = nhls_version["url"]
     print(f"nhls branch: {nhls_branch}, url: {nhls_url}")
 
-    # Figure out where checkout should be 
-    global nhls_path 
+    # Figure out where checkout should be
+    global nhls_path
     if nhls_path_override is None:
         nhls_path = Path(nhls_path).expanduser()
     else:
@@ -52,11 +51,11 @@ def session_init(nhls_path_override = None):
             nhls_path,
         ]
         subprocess.run(
-            clone_args, 
-            cwd=nhls_path.parent, 
-            capture_output=False, 
-            text=True, 
-            check=True
+            clone_args,
+            cwd=nhls_path.parent,
+            capture_output=False,
+            text=True,
+            check=True,
         )
 
     # Check that rustup is present
@@ -66,7 +65,7 @@ def session_init(nhls_path_override = None):
         print("please install rustup!")
         print("https://rustup.rs")
         raise ValueError("Rustup not installed")
-        
+
     # Ensure correct toolchain is present
     print("checking toolchain...")
     tool_args = [
@@ -75,11 +74,7 @@ def session_init(nhls_path_override = None):
         "install",
     ]
     subprocess.run(
-        tool_args, 
-        cwd=nhls_path,
-        capture_output=False, 
-        text=True, 
-        check=True
+        tool_args, cwd=nhls_path, capture_output=False, text=True, check=True
     )
 
     # Run cargo build now
@@ -89,13 +84,9 @@ def session_init(nhls_path_override = None):
         "cargo",
         "build",
         "--release",
-    ] 
+    ]
     subprocess.run(
-        build_args, 
-        cwd=nhls_path,
-        capture_output=False, 
-        text=True, 
-        check=True
+        build_args, cwd=nhls_path, capture_output=False, text=True, check=True
     )
 
     # Done

notebooks/draft.ipynb

@@ -14,7 +14,7 @@
     "import sys\n",
     "\n",
     "# Build an absolute path from this notebook's parent directory\n",
-    "module_path = os.path.abspath(os.path.join('..', 'nhls_py'))\n",
+    "module_path = os.path.abspath(os.path.join(\"..\", \"nhls_py\"))\n",
     "\n",
     "# Add to sys.path if not already present\n",
     "if module_path not in sys.path:\n",