Merge pull request #296 from martinRenou/lab2

Fix JupyterLab 2 and use yarn

Author: martinRenou

.github/workflows/main.yml

@@ -8,15 +8,19 @@ on:
     branches:
     - master
 
+defaults:
+  run:
+    shell: bash -l {0}
+
 jobs:
   run:
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        python-version: [3.7, 3.8]
+        os: [ubuntu-latest]
+        python-version: [3.8]
 
     steps:
     - name: Checkout
@@ -25,19 +29,17 @@ jobs:
     - name: Setup conda
       uses: conda-incubator/setup-miniconda@v2
       with:
+        activate-environment: ipympl-dev
+        environment-file: dev-environment.yml
+        python-version: ${{ matrix.python-version }}
         mamba-version: "*"
+        auto-activate-base: false
         channels: conda-forge
 
-    - name: Mamba install dependencies
-      shell: bash -l {0}
-      run: mamba install python=${{ matrix.python-version }} pip nodejs ipywidgets=7.6 jupyter jupyterlab=3 pillow numpy matplotlib flake8 pytest nbval
-
     - name: Install ipympl
-      shell: bash -l {0}
       run: pip install -e .
 
     - name: Check installation files
-      shell: bash -l {0}
       run: |
         test -d $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib
         test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib/extension.js
@@ -46,22 +48,109 @@ jobs:
         test -f $CONDA_PREFIX/share/jupyter/labextensions/jupyter-matplotlib/package.json
 
     - name: Check nbextension and labextension
-      shell: bash -l {0}
       run: |
         jupyter nbextension list 2>&1 | grep -ie "jupyter-matplotlib/extension.*enabled" -
         jupyter labextension list 2>&1 | grep -ie "jupyter-matplotlib.*enabled.*ok" -
 
     - name: Run tests
-      shell: bash -l {0}
       run: pytest .
 
     - name: Test flake8
-      shell: bash -l {0}
       run: flake8 ipympl --ignore=E501,W504,W503
 
     - name: Test JS linters
-      shell: bash -l {0}
       working-directory: js
       run: |
         npm run eslint:check
         npm run prettier:check
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup conda
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        activate-environment: ipympl-dev
+        environment-file: dev-environment.yml
+        python-version: ${{ matrix.python-version }}
+        mamba-version: "*"
+        auto-activate-base: false
+        channels: conda-forge
+
+    - name: Build packages
+      run: |
+        python setup.py sdist bdist_wheel
+        cd dist
+        sha256sum * | tee SHA256SUMS
+
+    - name: Upload builds
+      uses: actions/upload-artifact@v2
+      with:
+        name: dist ${{ github.run_number }}
+        path: ./dist
+
+  install:
+    runs-on: ${{ matrix.os }}-latest
+    needs: [build]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        python: ['3.6', '3.9']
+        include:
+          - python: '3.6'
+            dist: 'ipympl*.tar.gz'
+            jlab_version: 3
+          - python: '3.9'
+            dist: 'ipympl*.whl'
+            jlab_version: 2
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup conda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          mamba-version: "*"
+          auto-activate-base: false
+          channels: conda-forge
+
+      - name: Install dependencies
+        run: mamba install python=${{ matrix.python-version }} pip yarn jupyterlab=${{ matrix.jlab_version }} ipywidgets jupyter-packaging
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: dist ${{ github.run_number }}
+          path: ./dist
+
+      - name: Install the package
+        run: |
+          cd dist
+          pip install -vv ${{ matrix.dist }}
+
+      - name: Manually install labextension for lab2
+        if: ${{ matrix.jlab_version }} == 2
+        run: jupyter labextension install js
+
+      - name: Test installation files
+        run: |
+          test -d $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib
+          test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib/extension.js
+          test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-matplotlib/index.js
+          test -d $CONDA_PREFIX/share/jupyter/labextensions/jupyter-matplotlib
+          test -f $CONDA_PREFIX/share/jupyter/labextensions/jupyter-matplotlib/package.json
+          test -d $CONDA_PREFIX/share/jupyter/labextensions/jupyter-matplotlib/static
+
+      - name: Validate the nbextension
+        run: jupyter nbextension list 2>&1 | grep "jupyter-matplotlib/extension"
+
+      - name: Validate the labextension
+        run: jupyter labextension list 2>&1 | grep jupyter-matplotlib

README.md

@@ -43,6 +43,13 @@ pip install ipympl
 
 If you want to use ipympl in JupyterLab, we recommend using JupyterLab >= 3.
 
+If you use JupyterLab 2, you still need to install the labextension manually:
+
+```bash
+conda install -c conda-forge nodejs
+jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib
+```
+
 #### Install an old JupyterLab extension
 
 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.

dev-environment.yml

@@ -0,0 +1,15 @@
+name: ipympl-dev
+channels:
+    - conda-forge
+dependencies:
+    - pip
+    - yarn
+    - jupyter-packaging
+    - jupyterlab=3
+    - ipywidgets>=7.6
+    - flake8
+    - pillow
+    - numpy
+    - matplotlib
+    - pytest
+    - nbval