Merge pull request #79 from jtpio/lab-based-apps

Support other lab-based applications

Author: jtpio

.binder/environment.yml

@@ -5,5 +5,6 @@ dependencies:
 - bqplot=0.12
 - ipytree=0.2
 - jupyterlab=3
+- retrolab=0.3
 - nodejs
 - numpy

docs/environment.yml

@@ -3,7 +3,7 @@ name: ipylab_docs
 channels:
   - conda-forge
 dependencies:
-- python=3.5
+- python=3.9
 - nodejs
 - numpy
 - sphinx

docs/source/conf.py

@@ -29,11 +29,10 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
     "nbsphinx",
-    "jupyter_sphinx.embed_widgets",
-    "nbsphinx_link",
 ]
 
 # Ensure our extension is available:
+import json
 import sys
 from os.path import dirname, join as pjoin
 
@@ -71,15 +70,16 @@
 
 here = os.path.dirname(__file__)
 repo = os.path.join(here, "..", "..")
-_version_py = os.path.join(repo, "ipylab", "_version.py")
-version_ns = {}
-with open(_version_py) as f:
-    exec(f.read(), version_ns)
+with open(os.path.join(repo, "package.json")) as f:
+    package = json.load(f)
+    _version_js = package["version"]
 
 # The short X.Y version.
-version = "%i.%i" % version_ns["version_info"][:2]
+version = "%i.%i" % tuple(int(part) for part in _version_js.split("."))[:2]
 # The full version, including alpha/beta/rc tags.
-release = version_ns["__version__"]
+release = (
+    _version_js.replace("-alpha.", "a").replace("-beta.", "b").replace("-rc.", "rc")
+)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -192,15 +192,3 @@
 # that nbsphinx complains about:
 #
 nbsphinx_allow_errors = True  # exception ipstruct.py ipython_genutils
-
-
-def setup(app):
-    app.setup_extension("jupyter_sphinx.embed_widgets")
-
-    def add_scripts(app):
-        for fname in ["helper.js", "embed-bundle.js"]:
-            if not os.path.exists(os.path.join(here, "_static", fname)):
-                app.warn("missing javascript file: %s" % fname)
-            app.add_javascript(fname)
-
-    app.connect("builder-inited", add_scripts)

package.json

@@ -72,17 +72,17 @@
   "dependencies": {
     "@jupyter-widgets/base": "^1 || ^2 || ^3 || ^4",
     "@jupyter-widgets/controls": "^3.0.0",
-    "@jupyterlab/builder": "^3.0.0",
-    "@jupyterlab/application": "^3.0.0",
-    "@jupyterlab/apputils": "^3.0.0",
-    "@jupyterlab/observables": "^4.0.0",
-    "@lumino/algorithm": "^1.3.3",
+    "@jupyterlab/application": "^3.2.3",
+    "@jupyterlab/apputils": "^3.2.3",
+    "@jupyterlab/observables": "^4.2.3",
+    "@lumino/algorithm": "^1.9.1",
     "@lumino/commands": "^1.12.0",
-    "@lumino/disposable": "^1.4.3",
-    "@lumino/messaging": "^1.4.3",
-    "@lumino/widgets": "^1.17.0"
+    "@lumino/disposable": "^1.10.1",
+    "@lumino/messaging": "^1.10.1",
+    "@lumino/widgets": "^1.30.0"
   },
   "devDependencies": {
+    "@jupyterlab/builder": "^3.2.3",
     "@types/expect.js": "^0.3.29",
     "@types/node": "^10.11.6",
     "@typescript-eslint/eslint-plugin": "^2.26.0",
@@ -100,7 +100,7 @@
     "npm-run-all": "^4.1.3",
     "prettier": "^2.0.2",
     "rimraf": "^2.6.2",
-    "typescript": "~4.1.3"
+    "typescript": "~4.4.4"
   },
   "jupyterlab": {
     "extension": "lib/plugin",

readthedocs.yml

@@ -1,9 +1,8 @@
-type: sphinx
+version: 2
 python:
-  version: 3.5
-  pip_install: true
-  extra_requirements:
-    - examples
-    - docs
+  version: "3.7"
+  install:
+      - method: pip
+        path: .
 conda:
-  file: docs/environment.yml
+  environment: docs/environment.yml

src/plugin.ts

@@ -23,21 +23,23 @@ const EXTENSION_ID = 'ipylab:plugin';
 const extension: JupyterFrontEndPlugin<void> = {
   id: EXTENSION_ID,
   autoStart: true,
-  requires: [IJupyterWidgetRegistry, ILabShell],
-  optional: [ICommandPalette],
+  requires: [IJupyterWidgetRegistry],
+  optional: [ICommandPalette, ILabShell],
   activate: (
     app: JupyterFrontEnd,
     registry: IJupyterWidgetRegistry,
-    shell: ILabShell,
-    palette: ICommandPalette
+    palette: ICommandPalette,
+    labShell: ILabShell | null
   ): void => {
     // add globals
     widgetExports.JupyterFrontEndModel.app = app;
-    widgetExports.ShellModel.shell = shell;
+    widgetExports.ShellModel.shell = app.shell;
+    widgetExports.ShellModel.labShell = labShell;
     widgetExports.CommandRegistryModel.commands = app.commands;
     widgetExports.CommandPaletteModel.palette = palette;
     widgetExports.SessionManagerModel.sessions = app.serviceManager.sessions;
-    widgetExports.SessionManagerModel.shell = shell;
+    widgetExports.SessionManagerModel.shell = app.shell;
+    widgetExports.SessionManagerModel.labShell = labShell;
 
     registry.registerWidget({
       name: MODULE_NAME,

src/widgets/sessions.ts

@@ -8,7 +8,7 @@ import { ISerializers, WidgetModel } from '@jupyter-widgets/base';
 import { toArray } from '@lumino/algorithm';
 import { MODULE_NAME, MODULE_VERSION } from '../version';
 import { Session } from '@jupyterlab/services';
-import { ILabShell } from '@jupyterlab/application';
+import { ILabShell, JupyterFrontEnd } from '@jupyterlab/application';
 
 /**
  * The model for a Session Manager
@@ -35,15 +35,23 @@ export class SessionManagerModel extends WidgetModel {
    * @param options The initialization options.
    */
   initialize(attributes: any, options: any): void {
-    const { sessions, shell } = SessionManagerModel;
+    const { labShell, sessions, shell } = SessionManagerModel;
     this._sessions = sessions;
     this._shell = shell;
+    this._labShell = labShell;
+
     sessions.runningChanged.connect(this._sendSessions, this);
-    shell.currentChanged.connect(this._currentChanged, this);
 
     super.initialize(attributes, options);
     this.on('msg:custom', this._onMessage.bind(this));
-    this._shell.activeChanged.connect(this._currentChanged, this);
+
+    if (this._labShell) {
+      this._labShell.currentChanged.connect(this._currentChanged, this);
+      this._labShell.activeChanged.connect(this._currentChanged, this);
+    } else {
+      this._currentChanged();
+    }
+
     this._sendSessions();
     this._sendCurrent();
     this.send({ event: 'sessions_initialized' }, {});
@@ -124,6 +132,8 @@ export class SessionManagerModel extends WidgetModel {
   private _current_session: Session.IModel | {};
   private _sessions: SessionManager;
   static sessions: SessionManager;
-  private _shell: ILabShell;
-  static shell: ILabShell;
+  private _shell: JupyterFrontEnd.IShell;
+  private _labShell: ILabShell | null;
+  static shell: JupyterFrontEnd.IShell;
+  static labShell: ILabShell | null;
 }

src/widgets/shell.ts

@@ -1,7 +1,7 @@
 // Copyright (c) ipylab contributors
 // Distributed under the terms of the Modified BSD License.
 
-import { ILabShell } from '@jupyterlab/application';
+import { JupyterFrontEnd, ILabShell } from '@jupyterlab/application';
 
 import { DOMUtils } from '@jupyterlab/apputils';
 
@@ -42,6 +42,8 @@ export class ShellModel extends WidgetModel {
    */
   initialize(attributes: any, options: any): void {
     this._shell = ShellModel.shell;
+    this._labShell = ShellModel.labShell;
+
     super.initialize(attributes, options);
     this.on('msg:custom', this._onMessage.bind(this));
 
@@ -86,12 +88,12 @@ export class ShellModel extends WidgetModel {
     title.on('change', updateTitle);
     updateTitle();
 
-    if (area === 'left' || area === 'right') {
+    if ((area === 'left' || area === 'right') && this._labShell) {
       let handler;
       if (area === 'left') {
-        handler = this._shell['_leftHandler'];
+        handler = this._labShell['_leftHandler'];
       } else {
-        handler = this._shell['_rightHandler'];
+        handler = this._labShell['_rightHandler'];
       }
 
       // handle tab closed event
@@ -128,11 +130,15 @@ export class ShellModel extends WidgetModel {
         break;
       }
       case 'expandLeft': {
-        this._shell.expandLeft();
+        if (this._labShell) {
+          this._labShell.expandLeft();
+        }
         break;
       }
       case 'expandRight': {
-        this._shell.expandRight();
+        if (this._labShell) {
+          this._labShell.expandRight();
+        }
         break;
       }
       default:
@@ -151,7 +157,9 @@ export class ShellModel extends WidgetModel {
   static view_module: string = null;
   static view_module_version = MODULE_VERSION;
 
-  private _shell: ILabShell;
+  private _shell: JupyterFrontEnd.IShell;
+  private _labShell: ILabShell;
 
-  static shell: ILabShell;
+  static shell: JupyterFrontEnd.IShell;
+  static labShell: ILabShell;
 }