Merge pull request #53 from miya-biz/lab4.x_squash

migrate to JupyterLab 4.x, add ui-tests

.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.1.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: [email protected]
+author_name: ii masamitsu
+has_binder: true
+has_settings: true
+kind: frontend
+labextension_name: lc_multi_outputs
+project_short_description: Multiple outputs as tabs
+python_name: lc_multi_outputs
+repository: https://github.com/entap/lc_multi_outputs.git
+test: false
+

.eslintignore

@@ -3,3 +3,5 @@ dist
 coverage
 **/*.d.ts
 tests
+
+_temp_extension

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
     - name: Install dependencies
-      run: python -m pip install -U jupyterlab~=3.1 check-manifest
+      run: python -m pip install -U 'jupyterlab>=4.0.0,<5'
 
     - name: Build the extension
       run: |
@@ -29,8 +29,6 @@ jobs:
         jupyter labextension list 2>&1 | grep -ie "lc_multi_outputs.*OK"
         python -m jupyterlab.browser_check
 
-        check-manifest -v
-
         pip install build
         python -m build --sdist
         cp dist/*.tar.gz myextension.tar.gz
@@ -52,7 +50,7 @@ jobs:
     - name: Install Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.8'
+        python-version: '3.9'
         architecture: 'x64'
     - uses: actions/download-artifact@v2
       with:

.github/workflows/check-release.yml

@@ -22,9 +22,9 @@ jobs:
           python-version: 3.9
           architecture: 'x64'
       - name: Install node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: '14.x'
+          node-version: 18
 
 
       - name: Get pip cache dir

.github/workflows/release.yml

@@ -12,23 +12,23 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v2
     - name: Install node
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
-       node-version: '14.x'
+       node-version: 18
     - name: Install Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.8'
+        python-version: '3.9'
         architecture: 'x64'
 
 
     - name: Setup pip cache
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: pip-3.8-${{ hashFiles('package.json') }}
+        key: pip-3.9-${{ hashFiles('package.json') }}
         restore-keys: |
-          pip-3.8-
+          pip-3.9-
           pip-
 
     - name: Get yarn cache directory path
@@ -44,20 +44,23 @@ jobs:
           yarn-
 
     - name: Install dependencies
-      run: python -m pip install -U jupyterlab~=3.1 check-manifest
+      run: python -m pip install -U 'jupyterlab>=4.0.0,<5'
     - name: Build the extension
       run: |
         set -eux
         jlpm
         jlpm run eslint:check
         python -m pip install .
 
-        #jupyter server extension list 2>&1 | grep -ie "lc_multi_outputs.*OK"
-
-        #jupyter labextension list 2>&1 | grep -ie "lc_multi_outputs.*OK"
+        jupyter labextension list 2>&1 | grep -ie "lc_multi_outputs.*OK"
         python -m jupyterlab.browser_check
 
-        check-manifest -v
+        jlpm install
+        cd ./ui-tests
+        jlpm install
+        jlpm playwright install
+        jlpm playwright test
+        cd ..
 
         pip install build
         python -m build --sdist

.gitignore

@@ -1,12 +1,19 @@
 *.bundle.*
-/lib/
+lib/
 node_modules/
+*.log
 .eslintcache
 .stylelintcache
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
 lc_multi_outputs/labextension
+# Version file is handled by hatchling
+lc_multi_outputs/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
@@ -28,7 +35,7 @@ dist/
 downloads/
 eggs/
 .eggs/
-/lib
+lib/
 lib64/
 parts/
 sdist/
@@ -58,6 +65,7 @@ htmlcov/
 .coverage.*
 .cache
 nosetests.xml
+coverage/
 coverage.xml
 *.cover
 .hypothesis/
@@ -112,3 +120,6 @@ dmypy.json
 
 # OSX files
 .DS_Store
+
+# Yarn cache
+.yarn/

.prettierignore

@@ -2,4 +2,5 @@ node_modules
 **/node_modules
 **/lib
 **/package.json
+!/package.json
 lc_multi_outputs

.yarnrc.yml

@@ -0,0 +1,3 @@
+enableImmutableInstalls: false
+
+nodeLinker: node-modules

Dockerfile

@@ -0,0 +1,19 @@
+FROM jupyter/scipy-notebook:latest
+
+USER root
+
+### extensions for jupyter
+COPY . /tmp/multi_outputs
+RUN pip --no-cache-dir install jupyter_nbextensions_configurator \
+    /tmp/multi_outputs
+
+RUN jupyter labextension enable lc_multi_outputs
+
+RUN jupyter nbclassic-extension install --py jupyter_nbextensions_configurator --sys-prefix && \
+    jupyter nbclassic-extension enable --py jupyter_nbextensions_configurator --sys-prefix && \
+    jupyter nbclassic-serverextension enable --py jupyter_nbextensions_configurator --sys-prefix && \
+    jupyter nbclassic-extension install --py lc_multi_outputs --sys-prefix && \
+    jupyter nbclassic-extension enable --py lc_multi_outputs --sys-prefix && \
+    fix-permissions /home/$NB_USER
+
+USER $NB_USER

README.md

@@ -28,21 +28,21 @@ pip install git+https://github.com/NII-cloud-operation/Jupyter-multi_outputs
 Copy the nbextension files into the jupyter server's search directory.
 
 ```
-jupyter nbextension install --py lc_multi_outputs --user
+jupyter nbclassic-extension install --py lc_multi_outputs --user
 ```
 
-About details of `jupyter nbextension` subcommand, execute this command with `--help` option, and see the results.
+About details of `jupyter nbclassic-extension` subcommand, execute this command with `--help` option, and see the results.
 
 ```
-jupyter nbextension --help
+jupyter nbclassic-extension --help
 ```
 
 ## Enabling extension
 
 To use the multi_outputs extension, you will also need to enable it.
 
 ```
-jupyter nbextension enable --py lc_multi_outputs --user
+jupyter nbclassic-extension enable --py lc_multi_outputs --user
 ```
 
 # Usage
@@ -122,6 +122,66 @@ This is an example of a code cell
 }
 ```
 
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall lc_multi_outputs
+```
+
+## Contributing
+
+### 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
+# Change directory to the lc_multi_outputs directory
+# Install package in development mode
+pip install -e .
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+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 one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+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 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
+```
+
+### Development uninstall
+
+```bash
+pip uninstall lc_multi_outputs
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `lc_multi_outputs` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)
+
 # License
 
 This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), see LICENSE.txt.