move device sorting into python script

Author: EVWorth

.github/scripts/library_doc/update_library_files.py

@@ -7,7 +7,31 @@
 from pytablewriter import MarkdownTableWriter
 
 
-def generate_device_list():
+def get_device_list() -> None:
+    """Sort the device library JSON file."""
+    # Load the existing JSON library file
+    with open(
+        file="library/library.json",
+        encoding="UTF-8",
+    ) as f:
+        devices_json = json.loads(f.read())
+        devices = devices_json.get("devices")
+
+    # Sort the devices by manufacturer and model
+    devices.sort(
+        key=lambda k: (
+            k["manufacturer"].lower(),
+            k.get("model_match_method", "").lower(),
+            k["model"].lower(),
+            k.get("model_id", "").lower(),
+            k.get("hw_version", "").lower(),
+        )
+    )
+    with open("library/library.json", "w", encoding="UTF-8") as f:
+        f.write(json.dumps(devices_json, indent=4))
+
+
+def regenerate_device_list() -> None:
     """Generate static file containing the device library."""
 
     # Load the existing JSON library file
@@ -67,4 +91,6 @@ def generate_device_list():
         md_file.close()
 
 
-generate_device_list()
+if __name__ == "__main__":
+    get_device_list()
+    regenerate_device_list()

.github/workflows/json_librarian.yaml

@@ -19,28 +19,11 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
-
-      - name: Clean up JSON library file
-        id: update-json
-        uses: jannekem/run-python-script-action@v1
-        with:
-          script: |
-            import json
-
-            # Load the existing JSON library file
-            with open("library/library.json", "r", encoding="UTF-8") as f:
-                devices_json = json.loads(f.read())
-                devices = devices_json.get("devices")
-
-            # Sort the devices by manufacturer and model
-            devices.sort(key=lambda k: (k["manufacturer"].lower(), k.get("model_match_method", "").lower(), k["model"].lower(), k.get("model_id", "").lower(), k.get("hw_version", "").lower()))
-            with open("library/library.json", "w", encoding="UTF-8") as f:
-                f.write(json.dumps(devices_json, indent=4))
 
       - name: Install uv
         uses: astral-sh/setup-uv@v7
 
-      - name: Update Library Files
+      - name: Sort and Update Library Files
         run: |
           uv run --only-group library .github/scripts/library_doc/update_library_files.py