Merge pull request #45 from biggraph/darabos-shattering

.gitignore

@@ -1,4 +1,3 @@
-# Editor directories and files
 .vscode/*
 !.vscode/extensions.json
 .idea
@@ -9,3 +8,7 @@
 *.sln
 *.sw?
 __pycache__
+node_modules
+dist
+build
+*.egg-info

LICENSE.txt

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

README.md

@@ -7,25 +7,34 @@ original LynxKite. The primary goals of this rewrite are:
 - More extensible backend. Make it easy to add new LynxKite boxes. Make it easy to use our frontend for other purposes,
   configuring and executing other pipelines.
 
-## Installation
+## Structure
 
-To run the backend:
+- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
+- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
+- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
+- `lynxkite-pillow`: A simple example plugin.
+- `lynxkite-lynxscribe`: A plugin for building and running LynxScribe applications.
+
+## Development
+
+Install everything like this:
 
 ```bash
-PYTHONPATH=. uv run pydantic2ts --module server.workspace --output ./web/src/apiTypes.ts --json2ts-cmd "npm exec --prefix web json2ts"
-uv run fastapi run server/main.py --reload
+uv venv
+source .venv/bin/activate
+uv pip install -e lynxkite-core/ lynxkite-app/ lynxkite-graph-analytics/ lynxkite-lynxscribe/ lynxkite-pillow-example/
 ```
 
-To run the frontend:
+This also builds the frontend, hopefully very quickly. To run it:
 
 ```bash
-cd web
-npm i
-npm run dev
+cd lynxkite-app # just because the "data" directory with the examples is here
+LYNXKITE_RELOAD=1 lynxkite
 ```
 
-To run a chat UI for LynxScribe workspaces:
+If you also want to make changes to the frontend with hot reloading:
 
 ```bash
-WEBUI_AUTH=false OPENAI_API_BASE_URL=http://localhost:8000/api/service/server.lynxscribe_ops uvx open-webui serve
+cd lynxkite-app/web
+npm run dev
 ```

lynxkite-app/.gitignore

@@ -0,0 +1,3 @@
+/src/lynxkite/app/web_assets
+!/src/lynxkite/app/web_assets/__init__.py
+!/src/lynxkite/app/web_assets/assets/__init__.py

lynxkite-app/MANIFEST.in

@@ -0,0 +1,2 @@
+graft web
+prune web/node_modules

lynxkite-app/README.md

@@ -0,0 +1,25 @@
+# LynxKite MM
+
+This is an experimental rewrite of [LynxKite](https://github.com/lynxkite/lynxkite). It is not compatible with the
+original LynxKite. The primary goals of this rewrite are:
+
+- Target GPU clusters instead of Hadoop clusters. We use Python instead of Scala, RAPIDS instead of Apache Spark.
+- More extensible backend. Make it easy to add new LynxKite boxes. Make it easy to use our frontend for other purposes,
+  configuring and executing other pipelines.
+
+## Development
+
+To run the backend:
+
+```bash
+PYTHONPATH=. uv run pydantic2ts --module server.workspace --output ./web/src/apiTypes.ts --json2ts-cmd "npm exec --prefix web json2ts"
+uv run fastapi run server/main.py --reload
+```
+
+To run the frontend:
+
+```bash
+cd web
+npm i
+npm run dev
+```

lynxkite-app/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "lynxkite"
+version = "0.1.0"
+description = "The LynxKite application, with web server and UI"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "fastapi[standard]>=0.115.6",
+    "lynxkite-core",
+    "orjson>=3.10.13",
+    "pycrdt-websocket>=0.15.3",
+    "pydantic-to-typescript>=2.0.0",
+    "sse-starlette>=2.2.1",
+]
+
+[tool.uv.sources]
+lynxkite-core = { path = "../lynxkite-core" }
+
+[build-system]
+requires = ["setuptools", "wheel", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+namespaces = true
+where = ["src"]
+
+[tool.setuptools.package-data]
+"lynxkite.app.web_assets" = ["*"]
+"lynxkite.app.web_assets.assets" = ["*"]
+
+[tool.setuptools]
+py-modules = ["build_frontend"]
+include-package-data = true
+
+[tool.setuptools.cmdclass]
+build_py = "build_frontend.build_py"
+
+[project.scripts]
+lynxkite = "lynxkite.app.__main__:main"

lynxkite-app/src/build_frontend.py

@@ -0,0 +1,26 @@
+"""Customized build process for setuptools."""
+
+import subprocess
+from setuptools.command.build_py import build_py as _build_py
+from pathlib import Path
+import shutil
+
+
+class build_py(_build_py):
+    def run(self):
+        print("\n\nBuilding frontend...", __file__)
+        here = Path(__file__).parent.parent
+        frontend_dir = here / "web"
+        package_dir = here / "src" / "lynxkite" / "app" / "web_assets"
+        subprocess.check_call(["npm", "install"], cwd=frontend_dir)
+        subprocess.check_call(["npm", "run", "build"], cwd=frontend_dir)
+        print("files in", frontend_dir / "dist")
+        for file in (frontend_dir / "dist").iterdir():
+            print(file)
+        # shutil.rmtree(package_dir)
+        shutil.copytree(frontend_dir / "dist", package_dir, dirs_exist_ok=True)
+        # (frontend_dir / "dist").rename(package_dir)
+        print("files in", package_dir)
+        for file in package_dir.iterdir():
+            print(file)
+        super().run()

lynxkite-app/src/lynxkite/app/__main__.py

@@ -0,0 +1,13 @@
+import uvicorn
+from .main import app  # noqa: F401
+import os
+
+
+def main():
+    port = int(os.environ.get("PORT", "8000"))
+    reload = bool(os.environ.get("LYNXKITE_RELOAD", ""))
+    uvicorn.run("lynxkite.app.main:app", host="0.0.0.0", port=port, reload=reload)
+
+
+if __name__ == "__main__":
+    main()

{server → lynxkite-app/src/lynxkite/app}/crdt.py

@@ -11,6 +11,7 @@ import pycrdt_websocket
 import pycrdt_websocket.ystore
 import uvicorn
 import builtins
+from lynxkite.core import workspace
 
 router = fastapi.APIRouter()
 DATA_PATH = pathlib.Path.cwd() / "data"
@@ -119,8 +120,6 @@ def crdt_update(crdt_obj, python_obj, boxes=set()):
 
 
 def try_to_load_workspace(ws, name):
-    from . import workspace
-
     json_path = f"data/{name}"
     if os.path.exists(json_path):
         ws_pyd = workspace.load(json_path)
@@ -132,15 +131,14 @@ delayed_executions = {}
 
 
 async def workspace_changed(name, changes, ws_crdt):
-    from . import workspace
-
     ws_pyd = workspace.Workspace.model_validate(ws_crdt.to_py())
     # Do not trigger execution for superficial changes.
     # This is a quick solution until we build proper caching.
-    clean_input(ws_pyd)
-    if ws_pyd == last_known_versions.get(name):
+    ws_simple = ws_pyd.model_copy(deep=True)
+    clean_input(ws_simple)
+    if ws_simple == last_known_versions.get(name):
         return
-    last_known_versions[name] = ws_pyd.model_copy(deep=True)
+    last_known_versions[name] = ws_simple
     # Frontend changes that result from typing are delayed to avoid
     # rerunning the workspace for every keystroke.
     if name in delayed_executions:
@@ -157,8 +155,6 @@ async def workspace_changed(name, changes, ws_crdt):
 
 
 async def execute(name, ws_crdt, ws_pyd, delay=0):
-    from . import workspace
-
     if delay:
         try:
             await asyncio.sleep(delay)

{server → lynxkite-app/src/lynxkite/app}/main.py

@@ -6,17 +6,31 @@ import fastapi
 import importlib
 import pathlib
 import pkgutil
+from fastapi.staticfiles import StaticFiles
+import starlette
+from lynxkite.core import ops
+from lynxkite.core import workspace
 from . import crdt
-from . import ops
-from . import workspace
 
-here = pathlib.Path(__file__).parent
-lynxkite_modules = {}
-for _, name, _ in pkgutil.iter_modules([str(here)]):
-    if name.endswith("_ops") and not name.startswith("test_"):
+
+def detect_plugins():
+    try:
+        import lynxkite_plugins
+    except ImportError:
+        print("No modules found in lynxkite_plugins. Be sure to install some plugins.")
+        return {}
+
+    plugins = {}
+    for _, name, _ in pkgutil.iter_modules(lynxkite_plugins.__path__):
+        name = f"lynxkite_plugins.{name}"
         print(f"Importing {name}")
-        name = f"server.{name}"
-        lynxkite_modules[name] = importlib.import_module(name)
+        plugins[name] = importlib.import_module(name)
+    if not plugins:
+        print("No modules found in lynxkite_plugins. Be sure to install some plugins.")
+    return plugins
+
+
+lynxkite_plugins = detect_plugins()
 
 app = fastapi.FastAPI(lifespan=crdt.lifespan)
 app.include_router(crdt.router)
@@ -93,12 +107,32 @@ def make_dir(req: dict):
 @app.get("/api/service/{module_path:path}")
 async def service_get(req: fastapi.Request, module_path: str):
     """Executors can provide extra HTTP APIs through the /api/service endpoint."""
-    module = lynxkite_modules[module_path.split("/")[0]]
+    module = lynxkite_plugins[module_path.split("/")[0]]
     return await module.api_service_get(req)
 
 
 @app.post("/api/service/{module_path:path}")
 async def service_post(req: fastapi.Request, module_path: str):
     """Executors can provide extra HTTP APIs through the /api/service endpoint."""
-    module = lynxkite_modules[module_path.split("/")[0]]
+    module = lynxkite_plugins[module_path.split("/")[0]]
     return await module.api_service_post(req)
+
+
+class SPAStaticFiles(StaticFiles):
+    """Route everything to index.html. https://stackoverflow.com/a/73552966/3318517"""
+
+    async def get_response(self, path: str, scope):
+        try:
+            return await super().get_response(path, scope)
+        except (
+            fastapi.HTTPException,
+            starlette.exceptions.HTTPException,
+        ) as ex:
+            if ex.status_code == 404:
+                return await super().get_response(".", scope)
+            else:
+                raise ex
+
+
+static_dir = SPAStaticFiles(packages=[("lynxkite.app", "web_assets")], html=True)
+app.mount("/", static_dir, name="web_assets")

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."""

{web → lynxkite-app/web}/package.json

@@ -4,10 +4,10 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
-    "dev": "vite",
-    "build": "tsc -b && vite build",
-    "lint": "eslint .",
-    "preview": "vite preview"
+    "dev": "npx vite",
+    "build": "npx tsc -b && npx vite build",
+    "lint": "npx eslint .",
+    "preview": "npx vite preview"
   },
   "dependencies": {
     "@esbuild/linux-x64": "^0.24.0",

{web → lynxkite-app/web}/src/workspace/Workspace.tsx

@@ -57,7 +57,7 @@ function LynxKiteFlow() {
     const state = syncedStore({ workspace: {} as Workspace });
     setState(state);
     const doc = getYjsDoc(state);
-    const wsProvider = new WebsocketProvider("ws://localhost:5173/ws/crdt", path!, doc);
+    const wsProvider = new WebsocketProvider(`ws://${location.host}/ws/crdt`, path!, doc);
     const onChange = (_update: any, origin: any, _doc: any, _tr: any) => {
       if (origin === wsProvider) {
         // An update from the CRDT. Apply it to the local state.

{web → lynxkite-app/web}/src/workspace/nodes/NodeParameter.tsx

@@ -1,10 +1,17 @@
 const BOOLEAN = "<class 'bool'>";
 
-function ParamName({ name }) {
+function ParamName({ name }: { name: string }) {
   return <span className="param-name bg-base-200">{name.replace(/_/g, ' ')}</span>;
 }
 
-export default function NodeParameter({ name, value, meta, onChange }) {
+interface NodeParameterProps {
+  name: string;
+  value: any;
+  meta: any;
+  onChange: (value: any, options?: { delay: number }) => void;
+}
+
+export default function NodeParameter({ name, value, meta, onChange }: NodeParameterProps) {
   return (
     <label className="param">
       {meta?.type?.format === 'collapsed' ? <>
@@ -25,7 +32,7 @@ export default function NodeParameter({ name, value, meta, onChange }) {
           value={value || meta.type.enum[0]}
           onChange={(evt) => onChange(evt.currentTarget.value)}
         >
-          {meta.type.enum.map(option =>
+          {meta.type.enum.map((option: string) =>
             <option key={option} value={option}>{option}</option>
           )}
         </select>

{web → lynxkite-app/web}/src/workspace/nodes/NodeWithVisualization.tsx

@@ -1,6 +1,6 @@
 import React, { useEffect } from 'react';
 import NodeWithParams from './NodeWithParams';
-import * as echarts from 'echarts';
+const echarts = await import('echarts');
 
 const NodeWithVisualization = (props: any) => {
   const chartsRef = React.useRef<HTMLDivElement>(null);

{web → lynxkite-app/web}/tailwind.config.js

@@ -7,6 +7,7 @@ export default {
   },
   plugins: [require('daisyui')],
   daisyui: {
+    logs: false,
     themes: [
       {
         lynxkite: {

{web → lynxkite-app/web}/vite.config.ts

@@ -4,6 +4,15 @@ import Icons from 'unplugin-icons/vite'
 
 // https://vite.dev/config/
 export default defineConfig({
+  build: {
+    chunkSizeWarningLimit: 2048,
+  },
+  esbuild: {
+    supported: {
+      // For dynamic imports.
+      'top-level-await': true,
+    },
+  },
   plugins: [
     react(),
     Icons({ compiler: 'jsx', jsx: 'react' }),

lynxkite-core/README.md

@@ -0,0 +1,4 @@
+# LynxKite Core
+
+This is a lightweight Python package for defining LynxKite operations and executors.
+If you want to write LynxKite operations or executors, this is what you need!