JupyterLab 3 update

Signed-off-by: martinRenou <[email protected]>

Author: martinRenou

.github/workflows/reviewdog.yml

@@ -29,15 +29,7 @@ jobs:
       - name: Install flake8
         run: pip3 install flake8
 
-      - name: Set up reviewdog
-        run: |
-          mkdir -p $HOME/bin
-          curl -sfL \
-            https://github.com/reviewdog/reviewdog/raw/master/install.sh | \
-              sh -s -- -b $HOME/bin
-          echo ::add-path::$HOME/bin
-
       - name: Run flake8
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: flake8 | reviewdog -f=pep8 -name=flake8 -reporter=github-check
+        run: flake8 ipympl

.gitignore

@@ -6,8 +6,8 @@ build/
 node_modules/
 
 # Generated Javascript
-ipympl/static/
-ipympl/staticlab/
+ipympl/nbextension/
+ipympl/labextension/
 ipympl/*.tgz
 js/*.tgz
 

.travis.yml

@@ -7,26 +7,31 @@ cache:
   directories:
     - $HOME/.npm
 before_install:
-- wget https://github.com/mozilla/geckodriver/releases/download/v0.11.1/geckodriver-v0.11.1-linux64.tar.gz
-- mkdir geckodriver
-- tar -xzf geckodriver-v0.11.1-linux64.tar.gz -C geckodriver
-- export PATH=$PATH:$PWD/geckodriver
-- export DISPLAY=:99.0
-- sh -e /etc/init.d/xvfb start || true
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.11.1/geckodriver-v0.11.1-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.11.1-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start || true
 install:
-- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
-- bash miniconda.sh -b -p $HOME/miniconda
-- export PATH="$HOME/miniconda/bin:$PATH"
-- hash -r
-- conda config --set always_yes yes --set changeps1 no
-- conda update -q conda
-- conda info -a
-- conda install -c conda-forge nodejs=13 notebook matplotlib ipywidgets jupyterlab
-- pip install -v .
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda update -q conda
+  - conda info -a
+  - conda install -c conda-forge mamba
+  - mamba install -c conda-forge nodejs=13 matplotlib pytest nbval
+  - pip install pytest-tornasync --no-deps
+  - mamba install jupyterlab=3 ipywidgets=7.6 -c conda-forge
+  - pip install .
 script:
-- jupyter nbextension install --py --symlink --sys-prefix ipympl
-- jupyter nbextension enable --py --sys-prefix ipympl
-- jupyter labextension list 2>&1 | grep -q jupyter-matplotlib
-- jupyter labextension install @jupyter-widgets/jupyterlab-manager
-- jupyter labextension link js
-- python -m jupyterlab.browser_check --NotebookApp.ip=127.0.0.1
+  - pytest
+  - test -d $HOME/miniconda/share/jupyter/nbextensions/jupyter-matplotlib
+  - test -f $HOME/miniconda/share/jupyter/nbextensions/jupyter-matplotlib/extension.js
+  - test -f $HOME/miniconda/share/jupyter/nbextensions/jupyter-matplotlib/index.js
+  - test -d $HOME/miniconda/share/jupyter/labextensions/jupyter-matplotlib
+  - test -f $HOME/miniconda/share/jupyter/labextensions/jupyter-matplotlib/package.json
+  - jupyter labextension list 2>&1 | grep -q jupyter-matplotlib
+  - python -m jupyterlab.browser_check --NotebookApp.ip=127.0.0.1

MANIFEST.in

@@ -1,5 +1,10 @@
-recursive-include ipympl/static *.*
+recursive-include ipympl/nbextension *.*
+recursive-include ipympl/labextension *.*
+
 include js/*.tgz
 include js/package.json
 include LICENSE
 include jupyter-matplotlib.json
+
+include setup.py
+include pyproject.toml

README.md

@@ -39,26 +39,13 @@ conda install -c conda-forge ipympl
 pip install ipympl
 ```
 
-### Install the JupyterLab extension
+### Use in JupyterLab
 
-In order to install the JupyterLab extension `jupyter-matplotlib`, you will first need to install `nodejs` and `npm`.
-You can install both with `conda` doing
-
-```bash
-conda install -c conda-forge nodejs
-```
-
-Starting from ipympl `0.5.6`, **you do not need to manually install the JupyterLab extension**, but you still need to install the JupyterLab widget manager:
-```bash
-jupyter labextension install @jupyter-widgets/jupyterlab-manager
-
-# If you already installed the @jupyter-widgets/jupyterlab-manager extension, you will still need to rebuild JupyterLab after you installed ipympl
-jupyter lab build
-```
+If you want to use ipympl in JupyterLab, we recommend using JupyterLab >= 3.
 
 #### Install an old JupyterLab extension
 
-You will need to install the right `jupyter-matplotlib` version, according to the `ipympl` and `jupyterlab` versions you installed.
+If you are using JupyterLab 1 or 2, you will need to install the right `jupyter-matplotlib` version, according to the `ipympl` and `jupyterlab` versions you installed.
 For example, if you installed ipympl `0.5.1`, you need to install jupyter-matplotlib `0.7.0`, and this version is only compatible with JupyterLab `1`.
 
 ```bash
@@ -68,7 +55,6 @@ jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplot
 
 Versions lookup table:
 
-
 | `ipympl` | `jupyter-matplotlib` | `JupyterLab` | `Matplotlib` |
 |----------|----------------------|--------------|--------------|
 | 0.5.8    | 0.7.4                | 1 or 2       | 3.3.1        |

ipympl/__init__.py

@@ -4,10 +4,17 @@
 npm_pkg_name = 'jupyter-matplotlib'
 
 
+def _jupyter_labextension_paths():
+    return [{
+        'src': 'labextension',
+        'dest': npm_pkg_name
+    }]
+
+
 def _jupyter_nbextension_paths():
     return [{
         'section': 'notebook',
-        'src': 'static',
+        'src': 'nbextension',
         'dest': npm_pkg_name,
         'require': npm_pkg_name + '/extension'
     }]

ipympl/_version.py

@@ -1,2 +1,3 @@
 version_info = (0, 5, 8)
 __version__ = '.'.join(map(str, version_info))
+js_semver = '^0.7.4'

ipympl/backend_nbagg.py

@@ -3,7 +3,6 @@
 from base64 import b64encode
 import json
 import io
-import os
 
 from IPython.display import display, HTML
 
@@ -23,9 +22,7 @@
 from matplotlib.backend_bases import (ShowBase, NavigationToolbar2,
                                       FigureCanvasBase, cursors)
 
-here = os.path.dirname(__file__)
-with open(os.path.join(here, 'static', 'package.json')) as fid:
-    js_semver = '^%s' % json.load(fid)['version']
+from ._version import js_semver
 
 cursors_str = {
     cursors.HAND: 'pointer',
@@ -84,8 +81,8 @@ def connection_info():
     result = []
     for manager in Gcf.get_all_fig_managers():
         fig = manager.canvas.figure
-        result.append('{0} - {0}'.format((fig.get_label() or
-                                          "Figure {0}".format(manager.num)),
+        result.append('{0} - {1}'.format((fig.get_label() or
+                                          "Figure {}".format(manager.num)),
                                          manager.web_sockets))
     if not is_interactive():
         result.append('Figures pending show: {0}'.format(len(Gcf._activeQue)))