belt and suspenders serverextension for notebook classic

Author: bollwyvl

.github/workflows/ci.yml

@@ -170,13 +170,20 @@ jobs:
         cd dist
         ${{ matrix.python-cmd }} -c "import jupyter_videochat; print(jupyter_videochat.__version__)"
 
-    - name: Validate Server Extension
+    - name: Validate Server Extension (server)
       run: |
         set -eux
-        jupyter serverextension list --debug 1>serverextensions 2>&1
+        jupyter server extension list --debug 1>serverextensions 2>&1
         cat serverextensions
         cat serverextensions | grep -i "jupyter_videochat.*OK"
 
+    - name: Validate Server Extension (notebook)
+      run: |
+        set -eux
+        jupyter serverextension list --debug 1>server_extensions 2>&1
+        cat server_extensions
+        cat server_extensions | grep -i "jupyter_videochat.*OK"
+
     - name: Validate Lab Extension
       run: |
         set -eux

MANIFEST.in

@@ -1,9 +1,6 @@
-include LICENSE
-include README.md
-
-include jupyter-config/jupyter_videochat.json
-include install.json
+include LICENSE README.md install.json
 
+recursive-include jupyter-config *.json
 recursive-include jupyter_videochat/labextension *.*
 
 # Javascript files

binder/postBuild

@@ -5,11 +5,16 @@ jlpm bootstrap
 
 python -m pip install -e . --ignore-installed --no-deps -vv
 
+# squash build warning
 jupyter labextension disable jupyter-offlinenotebook || echo "not enabled"
 jupyter labextension uninstall --no-build jupyter-offlinenotebook || echo "not installed"
 
+# install our extensions
 jupyter labextension develop --overwrite .
 jupyter serverextension enable --sys-prefix --py jupyter_videochat
+jupyter server extension enable --sys-prefix --py jupyter_videochat
 
+# list all extensions
+jupyter server extension list
 jupyter serverextension list
 jupyter labextension list

install.json

@@ -1,5 +1,5 @@
 {
   "packageManager": "python",
-  "packageName": "jupyter_videochat",
-  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package `jupyter_videochat`"
+  "packageName": "jupyter-videochat",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyter-videochat"
 }

jupyter-config/jupyter_notebook_config.d/jupyter_videochat.json

@@ -0,0 +1,7 @@
+{
+  "NotebookApp": {
+    "nbserver_extensions": {
+      "jupyter_videochat": true
+    }
+  }
+}

jupyter-config/jupyter_videochat.json renamed to jupyter-config/jupyter_server_config.d/jupyter_videochat.json

@@ -78,3 +78,7 @@ def load_jupyter_server_extension(lab_app):
     videochat = VideoChat(parent=lab_app)
     lab_app.web_app.settings['videochat'] = videochat
     setup_handlers(lab_app.web_app)
+
+
+# For backward compatibility
+_load_jupyter_server_extension = load_jupyter_server_extension

jupyter_videochat/__init__.py

@@ -3,7 +3,7 @@
 
 from setuptools import setup
 
-CONF_D = "etc/jupyter/jupyter_server_config.d"
+ETC = "etc/jupyter"
 
 HERE = Path(__file__).parent
 EXT_SRC = HERE / "jupyter_videochat" / "labextension"
@@ -54,11 +54,16 @@
 DATA_FILES += [
     # percolates up to the UI about the installed labextension
     (EXT_DEST, ["install.json"]),
-    # enables the serverextension
-    (CONF_D, ["jupyter-config/jupyter_videochat.json"]),
+    # enables the serverextension under various apps
+    *[
+        (
+            f"{ETC}/jupyter_{app}_config.d",
+            [f"jupyter-config/jupyter_{app}_config.d/jupyter_videochat.json"]
+        )
+        for app in ["notebook", "server"]
+    ]
 ]
 
-
 if __name__ == "__main__":
     setup(
         version=__jspackage__["version"],