Revive: Enable Python API in the JupyterLite deployment + jupytercad-lite metapackage (#687)

* Enable Python API in the JupyterLite deployment (#680)

* Config docs

* Revert changes

* Update lite env

* update lite config

* Bump yjs-widgets and make changes wrt

* Update lite/environment.yml

Co-authored-by: martinRenou <[email protected]>

* bump yjs-widgets on jupytercad_app too

* use updated version of actions/cache

* try building jcad in lite

* try installing whl instead from src

* try giving a random name to the wheels to be used for lite

* correct path

* not needed

* move collaboration to jupytercad

* do same for lab

* No need to install

* install jupyter-server in CI

* typo

* lazily import `setup_handlers`

* install jupytercad metapackage for ui tests

* install metapackage in correct job

* build jupytercad metapackage too

* try adding docprovider to sharedPackages

* not needed

* try bundled true

---------

Co-authored-by: martinRenou <[email protected]>

* Add `jupytercad_lite` metapackage (#681)

* Add `jupytercad_lite` metapackage

* update bump-version

* port remaining changes

* install jupytercad_lite on build-lite job

* install jupytercad_lite on build-lite job

* try building jupytercad_lite in build packages

* continue installing the labextension in the dev install script

* continue installing the package too

* install metapackage outside the for loop

* condition not needed

* Fix: Collaborative model (#682)

Fic: Collaborative model

---------

Co-authored-by: Arjun Verma <[email protected]>

Author: martinRenou

.github/workflows/build.yml

@@ -25,7 +25,7 @@ jobs:
             yarn=3
 
       - name: Setup pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: pip-3.9-${{ hashFiles('package.json') }}
@@ -38,7 +38,7 @@ jobs:
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
       - name: Setup yarn cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -47,7 +47,7 @@ jobs:
             yarn-
 
       - name: Setup OpenCascade build cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             packages/opencascade/lib/jupytercad.opencascade.js
@@ -84,6 +84,8 @@ jobs:
             python/jupytercad_core/dist/jupytercad*
             python/jupytercad_lab/dist/jupytercad*
             python/jupytercad_app/dist/jupytercad*
+            python/jupytercad/dist/jupytercad*
+            python/jupytercad_lite/dist/jupytercad*
           if-no-files-found: error
 
   test_isolated:
@@ -148,7 +150,7 @@ jobs:
         shell: bash -l {0}
         run: |
           set -eux
-          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl .
+          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl ./jupytercad/dist/jupytercad*.whl .
           python -m pip install jupytercad*.whl
 
       - name: Install dependencies
@@ -159,7 +161,7 @@ jobs:
         run: jlpm install
 
       - name: Set up browser cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ${{ github.workspace }}/pw-browsers
@@ -221,6 +223,7 @@ jobs:
             pip
             jupyterlite-core
             jupyterlite-xeus
+            jupyter_server
 
       - name: Download extension package
         uses: actions/download-artifact@v4
@@ -231,15 +234,17 @@ jobs:
         shell: bash -l {0}
         run: |
           set -eux
-          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl .
-          python -m pip install jupytercad*.whl
+          cp ./jupytercad_core/dist/jupytercad*.whl jupytercad_core-0.0.1-py3-none-any.whl
+          cp ./jupytercad_lab/dist/jupytercad*.whl jupytercad_lab-0.0.1-py3-none-any.whl
+          cp ./jupytercad_app/dist/jupytercad*.whl jupytercad_app-0.0.1-py3-none-any.whl
+          cp ./jupytercad_lite/dist/jupytercad*.whl jupytercad_lite-0.0.1-py3-none-any.whl
 
       - name: Build the lite site
         shell: bash -l {0}
         working-directory: lite
         run: |
           set -eux
-          mkdir -p content && cp ../examples/*.jcad ../examples/*.STEP ../examples/*.stl ./content
+          mkdir -p content && cp ../examples/*.jcad ../examples/*.STEP ../examples/*.stl ../examples/*.ipynb ./content
           jupyter lite build --contents content --output-dir dist
 
       - name: Upload github-pages artifact

examples/Notebook.ipynb

@@ -18,17 +18,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 4,
    "id": "050e5936-f9e1-44ff-8bc9-a8556d7643ee",
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "ename": "ModuleNotFoundError",
+     "evalue": "No module named 'jupytercad'",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m                       Traceback (most recent call last)",
+      "Cell \u001b[0;32mIn[4], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01mfrom\u001b[39;00m \u001b[38;5;21;01mjupytercad\u001b[39;00m \u001b[38;5;28;01mimport\u001b[39;00m CadDocument\n",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m: No module named 'jupytercad'"
+     ]
+    }
+   ],
    "source": [
-    "from jupytercad_lab import CadDocument"
+    "from jupytercad import CadDocument"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 5,
    "id": "9821d466-6ae7-418f-aea7-9d67153da7d6",
    "metadata": {},
    "outputs": [],
@@ -38,22 +50,22 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 6,
    "id": "e30499f0-6732-4611-a25e-46b27e606b08",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.ywidget-view+json": {
-       "model_id": "c586b4fc0d474786bd7fbf9635e15421",
+       "model_id": "c0c9e05d08ec4e71bebc1877eec30531",
        "version_major": 2,
        "version_minor": 0
       },
       "text/plain": [
-       "<jupytercad_lab.notebook.cad_document.CadDocument object at 0x110fc7410>"
+       "<jupytercad_lab.notebook.cad_document.CadDocument object at 0x108aa4800>"
       ]
      },
-     "execution_count": 12,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }

lite/environment.yml

@@ -1,6 +1,19 @@
 name: xeus-python-kernel
 channels:
-  - https://repo.mamba.pm/emscripten-forge
-  - conda-forge
+  - https://prefix.dev/emscripten-forge-dev
+  - https://prefix.dev/conda-forge
 dependencies:
+  - python=3.13
+  - pip
   - xeus-python
+  - requests
+  - jupyter_ydoc=2.1.5
+  - ypywidgets>=0.9.6,<0.10.0
+  - comm>=0.1.2,<0.2.0
+  - pydantic>=2,<3
+  - pip:
+      - yjs-widgets>=0.4,<0.5
+      - my-jupyter-shared-drive
+      - ../jupytercad_core-0.0.1-py3-none-any.whl
+      - ../jupytercad_lab-0.0.1-py3-none-any.whl
+      - ../jupytercad_lite-0.0.1-py3-none-any.whl

lite/jupyter-lite.json

@@ -1,10 +1,4 @@
 {
   "jupyter-lite-schema-version": 0,
-  "jupyter-config-data": {
-    "appName": "My JupyterCAD App",
-    "disabledExtensions": [
-      "@jupyter/collaboration-extension",
-      "@jupyter/docprovider-extension"
-    ]
-  }
+  "jupyter-config-data": {}
 }

packages/base/src/widget.ts

@@ -268,12 +268,12 @@ export class JupyterCadPanel extends SplitPanel {
 
         (this._consoleTracker.widgetAdded as any).emit(consolePanel);
         await consolePanel.sessionContext.ready;
-        await consolePanel.console.inject(
-          `from jupytercad_lab import CadDocument\ndoc = CadDocument("${jcadPath}")`
-        );
         this.addWidget(this._consoleView);
         this.setRelativeSizes([2, 1]);
         this._consoleOpened = true;
+        await consolePanel.console.inject(
+          `from jupytercad import CadDocument\ndoc = CadDocument("${jcadPath}")`
+        );
         consolePanel.console.sessionContext.kernelChanged.connect((_, arg) => {
           if (!arg.newValue) {
             this.removeConsole();

packages/schema/src/model.ts

@@ -35,8 +35,7 @@ export class JupyterCadModel implements IJupyterCadModel {
     this._pathChanged = new Signal<JupyterCadModel, string>(this);
   }
 
-  readonly collaborative =
-    document.querySelectorAll('[data-jupyter-lite-root]')[0] === undefined;
+  readonly collaborative = true;
 
   get sharedModel(): IJupyterCadDoc {
     return this._sharedModel;

pyproject.toml

@@ -23,6 +23,7 @@ python_packages = [
     "python/jupytercad_app:jupytercad_app",
     "python/jupytercad_core:jupytercad_core",
     "python/jupytercad_lab:jupytercad_lab",
+    "python/jupytercad_lite:jupytercad",
 ]
 
 [tool.jupyter-releaser.hooks]

python/jupytercad/pyproject.toml

@@ -22,6 +22,8 @@ dependencies = [
   "jupytercad_core==3.0.1",
   "jupytercad_lab==3.0.1",
   "jupytercad_app==3.0.1",
+  "jupyter-collaboration>=3,<4",
+  "jupyterlab>=4.3,<5",
 ]
 dynamic = ["version"]
 license = {file = "LICENSE"}

python/jupytercad_app/package.json

@@ -108,7 +108,7 @@
     "@lumino/widgets": "^2.0.0",
     "react": "^18.0.1",
     "yjs": "^13.5.40",
-    "yjs-widgets": "^0.3.7"
+    "yjs-widgets": "^0.4"
   },
   "devDependencies": {
     "@jupyterlab/builder": "^4.0.0",

python/jupytercad_core/jupytercad_core/__init__.py

@@ -9,8 +9,6 @@
     warnings.warn("Importing 'jupytercad_core' outside a proper installation.")
     __version__ = "dev"
 
-from .handlers import setup_handlers
-
 
 def _jupyter_labextension_paths():
     return [{"src": "labextension", "dest": "@jupytercad/jupytercad-core"}]
@@ -24,5 +22,7 @@ def _load_jupyter_server_extension(server_app):
     server_app: jupyterlab.labapp.LabApp
         JupyterLab application instance
     """
+    from .handlers import setup_handlers
+
     setup_handlers(server_app.web_app)
     server_app.log.info("Registered jupytercad server extension")