Merge branch 'main' into darabos-lint

.github/workflows/test.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Install uv
         uses: astral-sh/setup-uv@v5
         with:
@@ -37,8 +37,8 @@ jobs:
         run: |
           cd lynxkite-app
           pytest
-    
-      - name: Run graph analytics tests  
+
+      - name: Run graph analytics tests
         run: |
           cd lynxkite-graph-analytics
           pytest
@@ -51,17 +51,17 @@ jobs:
         run: |
           cd lynxkite-app/web
           npm i
-          npx playwright install --with-deps 
+          npx playwright install --with-deps
 
       - name: Run Playwright tests
         run: |
           cd lynxkite-app/web
           npm run test
-      
+
       - uses: actions/upload-artifact@v4
         name: Upload playwright report
         if: ${{ !cancelled() }}
         with:
           name: playwright-report
           path: lynxkite-app/web/playwright-report/
-          retention-days: 30
+          retention-days: 30

examples/Graph RAG

@@ -7,7 +7,7 @@
       "data": {
         "title": "Input document",
         "params": {
-          "filename": "data/example-pizza.md"
+          "filename": "examples/example-pizza.md"
         },
         "display": null,
         "error": null,

lynxkite-app/src/lynxkite_app/config.py

@@ -0,0 +1,8 @@
+"""Some common configuration."""
+
+import os
+import pathlib
+
+
+DATA_PATH = pathlib.Path(os.environ.get("LYNXKITE_DATA", "lynxkite_data"))
+CRDT_PATH = pathlib.Path(os.environ.get("LYNXKITE_CRDT_DATA", "lynxkite_crdt_data"))

lynxkite-app/src/lynxkite_app/crdt.py

@@ -12,10 +12,9 @@ import pycrdt_websocket.ystore
 import uvicorn
 import builtins
 from lynxkite.core import workspace, ops
+from . import config
 
 router = fastapi.APIRouter()
-DATA_PATH = pathlib.Path.cwd() / "data"
-CRDT_PATH = pathlib.Path.cwd() / "crdt_data"
 
 
 def ws_exception_handler(exception, log):
@@ -34,8 +33,8 @@ class WebsocketServer(pycrdt_websocket.WebsocketServer):
 
         The workspace is loaded from "crdt_data" if it exists there, or from "data", or a new workspace is created.
         """
-        path = CRDT_PATH / f"{name}.crdt"
-        assert path.is_relative_to(CRDT_PATH)
+        path = config.CRDT_PATH / f"{name}.crdt"
+        assert path.is_relative_to(config.CRDT_PATH)
         ystore = pycrdt_websocket.ystore.FileYStore(path)
         ydoc = pycrdt.Doc()
         ydoc["workspace"] = ws = pycrdt.Map()
@@ -52,7 +51,7 @@ class WebsocketServer(pycrdt_websocket.WebsocketServer):
         if "edges" not in ws:
             ws["edges"] = pycrdt.Array()
         if "env" not in ws:
-            ws["env"] = next(iter(ops.CATALOGS), 'unset') 
+            ws["env"] = next(iter(ops.CATALOGS), "unset")
             # We have two possible sources of truth for the workspaces, the YStore and the JSON files.
             # In case we didn't find the workspace in the YStore, we try to load it from the JSON files.
             try_to_load_workspace(ws, name)
@@ -162,7 +161,7 @@ def try_to_load_workspace(ws: pycrdt.Map, name: str):
         ws: CRDT object to udpate with the workspace contents.
         name: Name of the workspace to load.
     """
-    json_path = f"data/{name}"
+    json_path = f"{config.DATA_PATH}/{name}"
     if os.path.exists(json_path):
         ws_pyd = workspace.load(json_path)
         # We treat the display field as a black box, since it is a large
@@ -222,8 +221,8 @@ async def execute(
             await asyncio.sleep(delay)
         except asyncio.CancelledError:
             return
-    path = DATA_PATH / name
-    assert path.is_relative_to(DATA_PATH),"Provided workspace path is invalid"
+    path = config.DATA_PATH / name
+    assert path.is_relative_to(config.DATA_PATH), "Provided workspace path is invalid"
     # Save user changes before executing, in case the execution fails.
     workspace.save(ws_pyd, path)
     await workspace.execute(ws_pyd)

lynxkite-app/src/lynxkite_app/main.py

@@ -11,7 +11,7 @@ from fastapi.staticfiles import StaticFiles
 import starlette
 from lynxkite.core import ops
 from lynxkite.core import workspace
-from . import crdt
+from . import crdt, config
 
 if os.environ.get("NX_CUGRAPH_AUTOCONFIG", "").strip().lower() == "true":
     import cudf.pandas
@@ -50,8 +50,8 @@ class SaveRequest(workspace.BaseConfig):
 
 
 def save(req: SaveRequest):
-    path = DATA_PATH / req.path
-    assert path.is_relative_to(DATA_PATH)
+    path = config.DATA_PATH / req.path
+    assert path.is_relative_to(config.DATA_PATH)
     workspace.save(req.ws, path)
 
 
@@ -65,27 +65,23 @@ async def save_and_execute(req: SaveRequest):
 
 @app.post("/api/delete")
 async def delete_workspace(req: dict):
-    json_path: pathlib.Path = DATA_PATH / req["path"]
-    crdt_path: pathlib.Path = CRDT_PATH / f"{req['path']}.crdt"
-    assert json_path.is_relative_to(DATA_PATH)
-    assert crdt_path.is_relative_to(CRDT_PATH)
+    json_path: pathlib.Path = config.DATA_PATH / req["path"]
+    crdt_path: pathlib.Path = config.CRDT_PATH / f"{req['path']}.crdt"
+    assert json_path.is_relative_to(config.DATA_PATH)
+    assert crdt_path.is_relative_to(config.CRDT_PATH)
     json_path.unlink()
     crdt_path.unlink()
 
 
 @app.get("/api/load")
 def load(path: str):
-    path = DATA_PATH / path
-    assert path.is_relative_to(DATA_PATH)
+    path = config.DATA_PATH / path
+    assert path.is_relative_to(config.DATA_PATH)
     if not path.exists():
         return workspace.Workspace()
     return workspace.load(path)
 
 
-DATA_PATH = pathlib.Path(os.environ.get("LYNXKITE_DATA", "lynxkite_data"))
-CRDT_PATH = pathlib.Path(os.environ.get("LYNXKITE_CRDT_DATA", "lynxkite_crdt_data"))
-
-
 class DirectoryEntry(pydantic.BaseModel):
     name: str
     type: str
@@ -93,12 +89,13 @@ class DirectoryEntry(pydantic.BaseModel):
 
 @app.get("/api/dir/list")
 def list_dir(path: str):
-    path = DATA_PATH / path
-    assert path.is_relative_to(DATA_PATH)
+    path = config.DATA_PATH / path
+    assert path.is_relative_to(config.DATA_PATH)
     return sorted(
         [
             DirectoryEntry(
-                p.relative_to(DATA_PATH), "directory" if p.is_dir() else "workspace"
+                p.relative_to(config.DATA_PATH),
+                "directory" if p.is_dir() else "workspace",
             )
             for p in path.iterdir()
         ]
@@ -107,19 +104,17 @@ def list_dir(path: str):
 
 @app.post("/api/dir/mkdir")
 def make_dir(req: dict):
-    path = DATA_PATH / req["path"]
-    assert path.is_relative_to(DATA_PATH)
-    assert not path.exists()
+    path = config.DATA_PATH / req["path"]
+    assert path.is_relative_to(config.DATA_PATH)
+    assert not path.exists(), f"{path} already exists"
     path.mkdir()
-    return list_dir(path.parent)
 
 
 @app.post("/api/dir/delete")
 def delete_dir(req: dict):
-    path: pathlib.Path = DATA_PATH / req["path"]
-    assert all([path.is_relative_to(DATA_PATH), path.exists(), path.is_dir()])
+    path: pathlib.Path = config.DATA_PATH / req["path"]
+    assert all([path.is_relative_to(config.DATA_PATH), path.exists(), path.is_dir()])
     shutil.rmtree(path)
-    return list_dir(path.parent)
 
 
 @app.get("/api/service/{module_path:path}")

lynxkite-app/src/lynxkite_app/web_assets/__init__.py

@@ -0,0 +1 @@
+"""The build process (uv build) puts the frontend build artifacts here."""

lynxkite-app/src/lynxkite_app/web_assets/assets/__init__.py

@@ -0,0 +1 @@
+"""More frontend build artifacts."""

lynxkite-app/tests/test_main.py

@@ -1,6 +1,7 @@
 import uuid
 from fastapi.testclient import TestClient
-from lynxkite_app.main import app, detect_plugins, DATA_PATH
+from lynxkite_app.main import app, detect_plugins
+from lynxkite_app.config import DATA_PATH
 import os
 
 
@@ -13,9 +14,9 @@ def test_detect_plugins_with_plugins():
     assert all(
         plugin in plugins.keys()
         for plugin in [
-            "lynxkite_plugins.graph_analytics",
-            "lynxkite_plugins.lynxscribe",
-            "lynxkite_plugins.pillow_example",
+            "lynxkite_graph_analytics",
+            "lynxkite_lynxscribe",
+            "lynxkite_pillow_example",
         ]
     )
 
@@ -57,7 +58,7 @@ def test_save_and_load():
 def test_list_dir():
     test_dir = str(uuid.uuid4())
     test_dir_full_path = DATA_PATH / test_dir
-    test_dir_full_path.mkdir(exist_ok=True)
+    test_dir_full_path.mkdir(parents=True, exist_ok=True)
     test_file = test_dir_full_path / "test_file.txt"
     test_file.touch()
     response = client.get(f"/api/dir/list?path={str(test_dir)}")

lynxkite-app/web/playwright.config.ts

@@ -23,7 +23,7 @@ export default defineConfig({
     },
   ],
   webServer: {
-    command: "cd .. && lynxkite",
+    command: "cd ../.. && LYNXKITE_DATA=examples lynxkite",
     url: "http://127.0.0.1:8000",
     reuseExistingServer: false,
   },

lynxkite-core/src/lynxkite/core/workspace.py

@@ -67,6 +67,7 @@ def save(ws: Workspace, path: str):
     """Persist a workspace to a local file in JSON format."""
     j = ws.model_dump_json(indent=2)
     dirname, basename = os.path.split(path)
+    os.makedirs(dirname, exist_ok=True)
     # Create temp file in the same directory to make sure it's on the same filesystem.
     with tempfile.NamedTemporaryFile(
         "w", prefix=f".{basename}.", dir=dirname, delete=False