Add Colab support (#27)

* Add Colab support
* Set default iframe width (for Colab and regular Jupyter) to 100%
* Update to version 0.3.0rc1

Author: jonmmease

.gitignore

@@ -5,7 +5,5 @@
 /dist
 /build/
 /extensions/jupyterlab/dist/
-/jupyter_dash/labextension/dist/
-/jupyter_dash/labextension/package.json
 .ipynb_checkpoints
 /extensions/jupyterlab/README.md

CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to `jupyter-dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.0 - ???
+### Added
+ - Added suport for using JupyterDash in Google Colab ([#27](https://github.com/plotly/jupyter-dash/pull/27))
+ - Added support for installing JupyterDash from git using pip: (e.g. `pip install git+https://github.com/plotly/jupyter-dash.git@master`)
+
+### Changed
+ - The default display width in `mode='inline'` is now `100%` to fill the screen width. 
+
 ## 0.2.1 - 2020-05-19
 ### Added
  - Remove f-strings to support Python 3.5

jupyter_dash/jupyter_app.py

@@ -9,6 +9,7 @@
 import re
 import sys
 import inspect
+import warnings
 
 from IPython import get_ipython
 from IPython.display import IFrame, display
@@ -37,6 +38,7 @@ class JupyterDash(dash.Dash):
     )
     default_server_url = None
     _in_ipython = get_ipython() is not None
+    _in_colab = "google.colab" in sys.modules
     _token = str(uuid.uuid4())
 
     @classmethod
@@ -63,14 +65,31 @@ def infer_jupyter_proxy_config(cls):
         see what JupyterLab extensions are installed by running the following command:
             $ jupyter labextension list
         """
-        if not JupyterDash._in_ipython:
-            # No op when not running in a Jupyter context
+        if not JupyterDash._in_ipython or JupyterDash._in_colab:
+            # No op when not running in a Jupyter context or when in Colab
             return
-
-        _request_jupyter_config()
+        else:
+            # Assume classic notebook or JupyterLab
+            _request_jupyter_config()
 
     def __init__(self, name=None, server_url=None, **kwargs):
         """"""
+        # Strip unsupported properties and warn
+        if JupyterDash._in_colab:
+            unsupported_colab_props = [
+                'requests_pathname_prefix',
+                'routes_pathname_prefix',
+                'url_base_pathname'
+            ]
+            for prop in unsupported_colab_props:
+                if prop in kwargs:
+                    kwargs.pop(prop)
+                    warnings.warn(
+                        "The {prop} argument is ignored when running in Colab".format(
+                            prop=prop
+                        )
+                    )
+
         # Call superclass constructor
         super(JupyterDash, self).__init__(name=name, **kwargs)
 
@@ -105,6 +124,9 @@ def __init__(self, name=None, server_url=None, **kwargs):
             if domain_base:
                 # Dash Enterprise set PLOTLY_DASH_DOMAIN_BASE environment variable
                 server_url = 'https://' + domain_base
+        elif JupyterDash._in_colab:
+            warnings.warn("The server_url argument is ignored when running in Colab")
+            server_url = None
 
         self.server_url = server_url
 
@@ -126,7 +148,7 @@ def alive():
 
     def run_server(
             self,
-            mode=None, width=800, height=650, inline_exceptions=None,
+            mode=None, width="100%", height=650, inline_exceptions=None,
             **kwargs
     ):
         """
@@ -166,7 +188,10 @@ def run_server(
         kwargs['port'] = port
 
         # Validate / infer display mode
-        valid_display_values = ["jupyterlab", "inline", "external"]
+        if JupyterDash._in_colab:
+            valid_display_values = ["inline", "external"]
+        else:
+            valid_display_values = ["jupyterlab", "inline", "external"]
 
         if mode is None:
             mode = JupyterDash.default_mode
@@ -293,6 +318,21 @@ def wait_for_app():
 
         wait_for_app()
 
+        if JupyterDash._in_colab:
+            self._display_in_colab(dashboard_url, port, mode, width, height)
+        else:
+            self._display_in_jupyter(dashboard_url, port, mode, width, height)
+
+    def _display_in_colab(self, dashboard_url, port, mode, width, height):
+        from google.colab import output
+        if mode == 'inline':
+            output.serve_kernel_port_as_iframe(port, width=width, height=height)
+        elif mode == 'external':
+            # Display a hyperlink that can be clicked to open Dashboard
+            print("Dash app running on:")
+            output.serve_kernel_port_as_window(port, anchor_text=dashboard_url)
+
+    def _display_in_jupyter(self, dashboard_url, port, mode, width, height):
         if mode == 'inline':
             display(IFrame(dashboard_url, width, height))
         elif mode == 'external':

jupyter_dash/labextension/dist/jupyterlab-dash-v0.2.0.tgz

@@ -0,0 +1,46 @@
+{
+  "name": "jupyterlab-dash",
+  "version": "0.2.0",
+  "description": "A JupyterLab extensions for rendering Plotly Dash apps",
+  "keywords": [
+    "jupyter",
+    "jupyterlab",
+    "jupyterlab-extension"
+  ],
+  "homepage": "https://github.com/plotly/jupyter-dash",
+  "bugs": {
+    "url": "https://github.com/plotly/jupyter-dash/issues"
+  },
+  "license": "MIT",
+  "author": "Plotly",
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/plotly/jupyter-dash.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "prepare": "npm run clean && npm run build",
+    "prettier": "prettier --write '{!(package),src/**,!(lib)/**}{.js,.jsx,.ts,.tsx,.css,.json,.md}'",
+    "watch": "tsc -w"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "^2.0.0",
+    "@jupyterlab/notebook": "^2.0.0",
+    "@jupyterlab/console": "^2.0.0"
+  },
+  "devDependencies": {
+    "prettier": "2.0.5",
+    "rimraf": "3.0.2",
+    "typescript": "3.9.3"
+  },
+  "jupyterlab": {
+    "extension": true
+  }
+}

jupyter_dash/labextension/package.json

@@ -1 +1 @@
-__version__ = "0.2.1.post1"
+__version__ = "0.3.0rc1"

jupyter_dash/version.py

@@ -153,8 +153,5 @@ def readme():
     ],
     cmdclass=dict(
         build_js=BuildLabextension,
-        build_py=js_prerelease(build_py),
-        egg_info=js_prerelease(egg_info),
-        sdist=js_prerelease(sdist),
     )
 )