Port to JupyterLab 3 (#8)

Author: fcollonval

.github/workflows/build.yml

@@ -11,24 +11,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - name: Install node
       uses: actions/setup-node@v1
       with:
        node-version: '10.x'
     - name: Install Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: '3.7'
         architecture: 'x64'
     - name: Install dependencies
-      run: python -m pip install "jupyterlab~=2.0"
+      run: python -m pip install jupyterlab~=3.0
     - name: Build the extension
       run: |
         jlpm
         jlpm run eslint:check
+        python -m pip install .
 
-        jupyter labextension install .
-        jupyter labextension disable @jupyterlab/launcher-extension
-
+        jupyter labextension list 2>&1 | grep -ie "@jlab-enhanced/launcher.*OK"
         python -m jupyterlab.browser_check

.gitignore

@@ -4,3 +4,109 @@ node_modules/
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
+jlab_enhanced_launcher/labextension
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store

MANIFEST.in

@@ -0,0 +1,23 @@
+include LICENSE
+include README.md
+include pyproject.toml
+include jupyter-config/jlab_enhanced_launcher.json
+
+include package.json
+include install.json
+include ts*.json
+
+graft jlab_enhanced_launcher/labextension
+
+# Javascript files
+graft src
+graft style
+prune **/node_modules
+prune lib
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints

README.md

@@ -1,6 +1,6 @@
-# @jlab-enhanced/launcher
+# jlab_enhanced_launcher
 
-![Github Actions Status](https://github.com/fcollonval/jlab-enhanced-launcher/workflows/Build/badge.svg) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fcollonval/jlab-enhanced-launcher/master?urlpath=lab) [![npm](https://img.shields.io/npm/v/@jlab-enhanced/launcher)](https://www.npmjs.com/package/@jlab-enhanced/launcher)
+![Github Actions Status](https://github.com/fcollonval/jlab-enhanced-launcher/workflows/Build/badge.svg) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fcollonval/jlab-enhanced-launcher.git/master?urlpath=lab) [![npm](https://img.shields.io/npm/v/@jlab-enhanced/launcher)](https://www.npmjs.com/package/@jlab-enhanced/launcher)
 
 A enhanced launcher for JupyterLab.
 
@@ -10,54 +10,66 @@ This codes started from https://github.com/jupyterlab/jupyterlab/pull/5953.
 
 ## Requirements
 
-* JupyterLab >= 2.0
+- JupyterLab >= 3.0
 
 ## Install
 
 ```bash
-jupyter labextension install @jlab-enhanced/launcher
-jupyter labextension disable @jupyterlab/launcher-extension
+pip install jlab-enhanced-launcher
 ```
 
-## Uninstall
+or
 
 ```bash
-jupyter labextension uninstall @jlab-enhanced/launcher
-jupyter labextension enable @jupyterlab/launcher-extension
+conda install jlab-enhanced-launcher
+```
+
+### Uninstall
+
+```bash
+pip uninstall jlab-enhanced-launcher
+```
+
+or
+
+```bash
+conda remove jlab-enhanced-launcher
 ```
 
 ## Contributing
 
-### Development Install
+### Development install
+
+Note: You will need NodeJS to build the extension package.
 
 The `jlpm` command is JupyterLab's pinned version of
 [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
 `yarn` or `npm` in lieu of `jlpm` below.
 
 ```bash
 # Clone the repo to your local environment
-# Move to launcher directory
-
-# Install dependencies
-jlpm
-# Build Typescript source
-jlpm build
+# Change directory to the jlab_enhanced_launcher directory
+# Install package in development mode
+pip install -e .
 # Link your development version of the extension with JupyterLab
-jupyter labextension install .
-jupyter labextension disable @jupyterlab/launcher-extension
-# Rebuild Typescript source after making changes
-jlpm build
-# Rebuild JupyterLab after making any changes
-jupyter lab build
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm run build
 ```
 
-You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
 
 ```bash
-# Watch the source directory in another terminal tab
-jlpm watch
-# Run jupyterlab in watch mode in one terminal tab
-jupyter lab --watch
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm run watch
+# Run JupyterLab in another terminal
+jupyter lab
 ```
 
-Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```

binder/environment.yml

@@ -1,17 +1,22 @@
-# a mybinder.org-ready environment for demoing launcher
+# a mybinder.org-ready environment for demoing jlab_enhanced_launcher
 # this environment may also be used locally on Linux/MacOS/Windows, e.g.
 #
 #   conda env update --file binder/environment.yml
-#   conda activate launcher-demo
+#   conda activate jlab-enhanced-launcher-demo
 #
-name: launcher-demo
+name: jlab-enhanced-launcher-demo
 
 channels:
   - conda-forge
 
 dependencies:
   # runtime dependencies
   - python >=3.8,<3.9.0a0
-  - jupyterlab >=2,<3.0.0a0
+  - jupyterlab >=3,<4.0.0a0
   # labextension build dependencies
   - nodejs >=14,<15
+  - pip
+  - wheel
+  # Fix binder
+  - parso >=0.8.0,<0.9.0
+  - jupyter_telemetry >=0.1.0

binder/postBuild

@@ -1,19 +1,44 @@
-#!/bin/bash
-set -e
-jlpm
+#!/usr/bin/env python3
+""" perform a development install of jlab_enhanced_launcher
 
-# initially list installed extensions to determine if there are any surprises
-jupyter labextension list
+    On Binder, this will run _after_ the environment has been fully created from
+    the environment.yml in this directory.
+
+    This script should also run locally on Linux/MacOS/Windows:
+
+        python3 binder/postBuild
+"""
+import subprocess
+import sys
+from pathlib import Path
+
+
+ROOT = Path.cwd()
+
+def _(*args, **kwargs):
+    """ Run a command, echoing the args
+
+        fails hard if something goes wrong
+    """
+    print("\n\t", " ".join(args), "\n")
+    return_code = subprocess.call(args, **kwargs)
+    if return_code != 0:
+        print("\nERROR", return_code, " ".join(args))
+        sys.exit(return_code)
+
+# verify the environment is self-consistent before even starting
+_(sys.executable, "-m", "pip", "check")
 
 # install the labextension
-jlpm pack
-jupyter labextension install --no-build jlab-enhanced-launcher-*.tgz
-jupyter labextension disable @jupyterlab/launcher-extension
+_(sys.executable, "-m", "pip", "install", "-e", ".")
+_("jupyter", "labextension", "disable", "@jupyterlab/launcher-extension")
 
-# verify the list of extensions
-jupyter labextension list
+# verify the environment the extension didn't break anything
+_(sys.executable, "-m", "pip", "check")
+
+# initially list installed extensions to determine if there are any surprises
+_("jupyter", "labextension", "list")
 
-jupyter lab build --dev-build=False --minimize=True --debug
 
-# verify the list of extensions one last time
-jupyter labextension list
+print("JupyterLab with jlab_enhanced_launcher is ready to run with:\n")
+print("\tjupyter lab\n")

install.json

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

jlab_enhanced_launcher/__init__.py

@@ -0,0 +1,19 @@
+
+import json
+import pathlib
+
+from ._version import __version__
+
+HERE = pathlib.Path(__file__).parent.absolute()
+
+with (HERE / 'labextension' / 'package.json').open() as fid:
+    data = json.load(fid)
+
+def _jupyter_labextension_paths():
+    return [{
+        'src': 'labextension',
+        'dest': data['name']
+    }]
+
+
+

jlab_enhanced_launcher/_version.py

@@ -0,0 +1,18 @@
+__all__ = ['__version__']
+
+def _fetchVersion():
+    import json
+    import pathlib
+
+    HERE = pathlib.Path(__file__).parent.absolute()
+
+    for d in HERE.rglob('package.json'): 
+        try:
+            with d.open() as f:
+                return json.load(f)['version']
+        except FileNotFoundError:
+            pass
+
+    raise FileNotFoundError('Could not find package.json under dir {}'.format(HERE))
+
+__version__ = _fetchVersion()