feat: add jupyterlab 2 backwards compatibility

Author: reevejd

Dockerfile

@@ -1,5 +1,16 @@
 FROM python
+
+
 RUN pip install jupyterlab~=3.0
-# COPY dist/jupyterlab_s3_browser-0.8.0.dev9-py3-none-any.whl .
-# RUN pip install jupyterlab_s3_browser-0.8.0.dev9-py3-none-any.whl
-RUN pip install jupyterlab-s3-browser==0.8.0
+# RUN pip install jupyterlab==2.2.9
+
+
+# COPY dist/jupyterlab_s3_browser-0.9.0.dev1-py3-none-any.whl .
+# RUN pip install jupyterlab_s3_browser-0.9.0.dev1-py3-none-any.whl
+RUN pip install jupyterlab-s3-browser==0.9.0.dev1
+
+
+# RUN curl -sL https://deb.nodesource.com/setup_12.x  | bash -
+# RUN apt-get -y install nodejs
+# RUN jupyter labextension install jupyterlab-s3-browser@0.9.0-dev.0
+RUN jupyter serverextension enable --py jupyterlab_s3_browser

README.md

@@ -12,6 +12,14 @@ A JupyterLab extension for browsing S3-compatible object storage.
 pip install jupyterlab-s3-browser
 ```
 
+You may also need to run:
+
+```
+jupyter serverextension enable --py jupyterlab_s3_browser
+```
+
+to make sure the serverextension is enabled and then restart (stop and start) JupyterLab.
+
 ### JupyterLab 2
 
 ```bash

jupyterlab_s3_browser/__init__.py

@@ -54,4 +54,6 @@ def _load_jupyter_server_extension(server_app):
     setup_handlers(server_app.web_app)
 
 
+# backwards compatibility with jupyterlab 2.0
 load_jupyter_server_extension = _load_jupyter_server_extension
+_jupyter_server_extension_paths = _jupyter_server_extension_points

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-s3-browser",
-  "version": "0.8.0",
+  "version": "0.9.0-dev.1",
   "description": "JupyterLab extension for browsing S3-compatible object storage",
   "keywords": [
     "s3",
@@ -54,29 +54,28 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyterlab/application": "^3.0.0",
-    "@jupyterlab/apputils": "^3.0.0",
-    "@jupyterlab/coreutils": "^5.0.0",
-    "@jupyterlab/docmanager": "^3.0.0",
-    "@jupyterlab/docregistry": "^3.0.0",
-    "@jupyterlab/filebrowser": "^3.0.0",
-    "@jupyterlab/services": "^6.0.0",
-    "@jupyterlab/settingregistry": "^3.0.0",
+    "@jupyterlab/application": "^2.0.0 || ^3.0.0",
+    "@jupyterlab/apputils": "^2.0.0 || ^3.0.0",
+    "@jupyterlab/coreutils": "^4.0.0 || ^5.0.0",
+    "@jupyterlab/docmanager": "^2.0.0 || ^3.0.0",
+    "@jupyterlab/docregistry": "^2.0.0 || ^3.0.0",
+    "@jupyterlab/filebrowser": "^2.0.0 || ^3.0.0",
+    "@jupyterlab/services": "^5.0.0 || ^6.0.0",
+    "@jupyterlab/settingregistry": "^2.0.0 || ^3.0.0",
     "@lumino/algorithm": "^1.2.3",
     "@lumino/messaging": "^1.3.3",
     "@lumino/signaling": "^1.3.5",
-    "@lumino/widgets": "^1.17.0",
     "@typescript-eslint/eslint-plugin": "^4.14.1",
     "@typescript-eslint/parser": "^4.14.1",
     "base64-js": "^1.2.3",
     "eslint": "^7.18.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
     "eslint-plugin-react": "^7.22.0",
-    "react": "^17.0.0"
+    "react": "^16.0.0 || ^17.0.0"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^3.0.1",
+    "@jupyterlab/builder": "^2.0.0 || ^3.0.1",
     "@types/base64-js": "^1.2.5",
     "@types/text-encoding": "^0.0.32",
     "husky": "^0.14.3",

setup.py

@@ -40,7 +40,12 @@
     ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
     (
         "etc/jupyter/jupyter_server_config.d",
-        "jupyter-config",
+        "jupyter-config/jupyter_server_config.d",
+        "jupyterlab_s3_browser.json",
+    ),
+    (
+        "etc/jupyter/jupyter_notebook_config.d",
+        "jupyter-config/jupyter_notebook_config.d",
         "jupyterlab_s3_browser.json",
     ),
 ]
@@ -85,7 +90,13 @@
         "Programming Language :: Python :: 3",
         "Framework :: Jupyter",
     ],
-    install_requires=["notebook", "boto3", "singleton-decorator", "jupyterlab>=3.0.0"],
+    install_requires=[
+        "notebook",
+        "boto3",
+        "jupyter_server",
+        "singleton-decorator",
+        "jupyterlab>=2.0.0",
+    ],
     extras_require={"dev": ["jupyter_packaging~=0.7.9", "pytest", "moto", "coverage"]},
 )
 

src/contents.ts

@@ -371,7 +371,7 @@ namespace Private {
 
   export const availableContentTypes: any = {};
   export let currentPath: string;
-  export const showingError = false;
+  export let showingError = false;
 
   export function showErrorMessage(message: string): void {
     Private.hideDirectoryLoadingSpinner();