Move webapp and widget to the root of the package

.github/workflows/ci.yaml

@@ -92,7 +92,7 @@ jobs:
                 npm run build
 
         -   name: Install Dependencies, Start React Application
-            working-directory: aiida_workgraph/web/frontend
+            working-directory: aiida_workgraph_web/frontend
             run: |
                 npm install
                 npm run build

.github/workflows/python-publish.yml

@@ -31,12 +31,12 @@ jobs:
         python -m pip install --upgrade pip
         pip install build
     - name:  Build widget
-      working-directory: aiida_workgraph/widget/
+      working-directory: aiida_workgraph_widget/
       run: |
         npm install
         npm run build
     - name: Build web frontend package
-      working-directory: aiida_workgraph/web/frontend/
+      working-directory: aiida_workgraph_web/frontend/
       run: |
         npm install
         npm run build

CONTRIBUTING.md

@@ -53,12 +53,12 @@ which can automatically refresh on changes of the JS files. To start the backend
 server please run
 
 ```console
-python aiida_workgraph/web/backend/main.py
+python aiida_workgraph_web/backend/main.py
 ```
 
 then start the frontend server with
 ```console
-npm --prefix aiida_workgraph/web/frontend start
+npm --prefix aiida_workgraph_web/frontend start
 ```
 
 The frontend server will refresh
@@ -80,7 +80,7 @@ playwright codegen
 You might want to clean your cache
 
 ```console
-npm --prefix aiida_workgraph/web/frontend cache clean
+npm --prefix aiida_workgraph_web/frontend cache clean
 ```
 
 and also clear your browsers cache or try to start new private window.

README.md

@@ -27,11 +27,11 @@ To install the jupyter widget support you need to in addition build the JavaScri
 ```console
 pip install .[widget]
 # build widget
-cd aiida_workgraph/widget/
+cd aiida_workgraph_widget/
 npm install
 npm run build
 # build web frontend
-cd ../../aiida_workgraph/web/frontend/
+cd ../../aiida_workgraph_web/frontend/
 npm install
 npm run build
 ```
@@ -105,10 +105,10 @@ pre-commit install
 ```
 
 ### Widget
-See the [README.md](https://github.com/aiidateam/aiida-workgraph/blob/main/aiida_workgraph/widget/README.md)
+See the [README.md](https://github.com/aiidateam/aiida-workgraph/blob/main/aiida_workgraph_widget/README.md)
 
 ### Web app
-See the [README.md](https://github.com/aiidateam/aiida-workgraph/blob/main/aiida_workgraph/web/README.md)
+See the [README.md](https://github.com/aiidateam/aiida-workgraph/blob/main/aiida_workgraph_web/README.md)
 
 
 ## License

aiida_workgraph/cli/cmd_web.py

@@ -43,7 +43,7 @@ def start():
         backend_process = subprocess.Popen(
             [
                 "uvicorn",
-                "aiida_workgraph.web.backend.app.api:app",
+                "aiida_workgraph_web.backend.app.api:app",
                 "--reload",
                 "--port",
                 "8000",

aiida_workgraph/task.py

@@ -6,7 +6,7 @@
 from aiida_workgraph.sockets import socket_pool
 
 if USE_WIDGET:
-    from aiida_workgraph.widget import NodeGraphWidget
+    from aiida_workgraph_widget import NodeGraphWidget
 from aiida_workgraph.collection import (
     WorkGraphPropertyCollection,
     WorkGraphInputSocketCollection,

aiida_workgraph/workgraph.py

@@ -18,7 +18,7 @@
 from typing import Any, Dict, List, Optional, Union
 
 if USE_WIDGET:
-    from aiida_workgraph.widget import NodeGraphWidget
+    from aiida_workgraph_widget import NodeGraphWidget
 
 
 class WorkGraph(node_graph.NodeGraph):

aiida_workgraph/web/backend/app/api.py → aiida_workgraph_web/backend/app/api.py

@@ -1,9 +1,9 @@
 from fastapi import FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from aiida.manage import manager
-from aiida_workgraph.web.backend.app.daemon import router as daemon_router
-from aiida_workgraph.web.backend.app.workgraph import router as workgraph_router
-from aiida_workgraph.web.backend.app.datanode import router as datanode_router
+from aiida_workgraph_web.backend.app.daemon import router as daemon_router
+from aiida_workgraph_web.backend.app.workgraph import router as workgraph_router
+from aiida_workgraph_web.backend.app.datanode import router as datanode_router
 from fastapi.staticfiles import StaticFiles
 from pathlib import Path
 import os

aiida_workgraph/web/backend/app/datanode.py → aiida_workgraph_web/backend/app/datanode.py

@@ -11,7 +11,7 @@ async def read_datanode_data(
     labelSearch: str = Query(None),
 ) -> List[Dict[str, Any]]:
     from aiida.orm import QueryBuilder, Data
-    from aiida_workgraph.web.backend.app.utils import time_ago
+    from aiida_workgraph_web.backend.app.utils import time_ago
 
     try:
         builder = QueryBuilder()

docs/source/development/test.rst

@@ -11,8 +11,8 @@ To contribute to this repository, please enable pre-commit to ensure that the co
 
 Widget
 ----------------
-See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/widget/README.md>`_.
+See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph_widget/README.md>`_.
 
 Web app
 ----------------
-See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph/web/README.md>`_.
+See the `README.md <https://github.com/superstar54/aiida-workgraph/blob/main/aiida_workgraph_web/README.md>`_.

docs/source/installation.rst

@@ -46,11 +46,11 @@ To install the jupyter widget support you need to in addition build the JavaScri
     $ cd aiida-workgraph
     $ pip install -e .
     $ # build widget
-    $ cd aiida_workgraph/widget/
+    $ cd aiida_workgraph_widget/
     $ npm install
     $ npm run build
     $ # build web frontend
-    $ cd ../../aiida_workgraph/web/frontend/
+    $ cd ../../aiida_workgraph_web/frontend/
     $ npm install
     $ npm run build
 

pyproject.toml

@@ -148,8 +148,8 @@ workgraph = "aiida_workgraph.cli.cmd_workgraph:workgraph"
 exclude = [
     "docs/",
     "tests/",
-    "aiida_workgraph/web/frontend/node_modules/",
-    "aiida_workgraph/widget/node_modules/",
+    "aiida_workgraph_web/frontend/node_modules/",
+    "aiida_workgraph_widget/node_modules/",
 ]
 
 

tests/web/backend/conftest.py

@@ -17,6 +17,6 @@ def set_backend_server_settings(aiida_profile):
 
 @pytest.fixture(scope="module")
 def client(set_backend_server_settings):
-    from aiida_workgraph.web.backend.app.api import app
+    from aiida_workgraph_web.backend.app.api import app
 
     return TestClient(app)

tests/web/frontend/conftest.py

@@ -93,7 +93,7 @@ def ran_wg_calcfunction(
 @pytest.fixture(scope="module")
 def uvicorn_configuration():
     return {
-        "app": "aiida_workgraph.web.backend.app.api:app",
+        "app": "aiida_workgraph_web.backend.app.api:app",
         "host": "0.0.0.0",
         "port": 8000,
         "log_level": "info",