Update for JupyterLab 3

.github/.condarc

@@ -0,0 +1,14 @@
+add_pip_as_python_dependency: False
+aggressive_update_packages: []
+always_yes: True
+auto_update_conda: False
+default_channels: []
+local_repodata_ttl: 99999
+notify_outdated_conda: False
+remote_connect_timeout_secs: 600.0
+remote_max_retries: 10
+remote_read_timeout_secs: 600.0
+show_channel_urls: True
+show_sources: True
+unsatisfiable_hints_check_depth: 0
+use_only_tar_bz2: True

.github/environment.yml

@@ -5,8 +5,9 @@ channels:
 
 dependencies:
   - anaconda-project =0.8.4
-  - conda =4.8.3
+  - conda =4.9
   - doit ==0.32
+  - mamba =0.7
   - pip
   - python >=3.7,<3.8
   - twine

.github/workflows/ci.yml

@@ -9,17 +9,65 @@ on:
       - master
 
 env:
-  ATEST_RETRIES: 2
-  INSTALL_ARTIFACT: wheel
-  PIP_DISABLE_PIP_VERSION_CHECK: 1
   PYTHONIOENCODING: utf-8
-  PYTHONUNBUFFERED: 1
+  PYTHONUNBUFFERED: '1'
+  PIP_DISABLE_PIP_VERSION_CHECK: '1'
+  # until have mamabforge...
+  CONDA_EXE: mamba
+  # our stuff
   SKIP_CONDA_PREFLIGHT: 1
   CACHE_EPOCH: 0
 
 jobs:
-  ci:
+  build:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+    steps:
+      - name: git checkout
+        uses: actions/checkout@v2
+
+      - name: cache (conda)
+        uses: actions/cache@v1
+        with:
+          path: ~/conda_pkgs_dir
+          key:
+            ${{ runner.os }}-conda-${{ hashFiles('.github/environment.yml',
+            'anaconda-project-lock.yml') }}
+          restore-keys: |
+            ${{ runner.os }}-conda-
+
+      - name: cache (yarn)
+        uses: actions/cache@v1
+        with:
+          path: .yarn-packages
+          key: yarn-${{ runner.os }}-${{ hashFiles('yarn.lock', '.yarnrc') }}
+          restore-keys: |
+            yarn-${{ runner.os }}-
+            yarn-
+
+      - name: base env (conda)
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          environment-file: .github/environment.yml
+          use-only-tar-bz2: true
+
+      - name: build
+        shell: bash -l {0}
+        run: |
+          doit -n4 lint release || doit lint release || exit 1
+
+      - name: publish dists
+        uses: actions/upload-artifact@v2
+        with:
+          name: ipyelk dist ${{ github.run_number }}
+          path: ./dist
+
+  test:
     runs-on: ${{ matrix.vm }}
+    needs: [build]
     strategy:
       fail-fast: false
       matrix:
@@ -37,6 +85,10 @@ jobs:
           - os: windows
             miniforge: Windows-x86_64.exe
             vm: windows-latest
+    env:
+      INSTALL_ARTIFACT: wheel
+      TESTING_IN_CI: 'true'
+      ATEST_RETRIES: '2'
     steps:
       - name: configure line endings
         run: |
@@ -54,6 +106,14 @@ jobs:
           restore-keys: |
             ${{ env.CACHE_EPOCH }}-${{ runner.os }}-conda-
 
+      - name: env (conda)
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          environment-file: .github/environment.yml
+          use-only-tar-bz2: true
+          installer-url: |
+            https://github.com/conda-forge/miniforge/releases/download/4.9.2-4/Miniforge3-4.9.2-4-${{ matrix.miniforge }}
+
       - name: cache (yarn)
         uses: actions/cache@v1
         with:
@@ -64,39 +124,31 @@ jobs:
             ${{ env.CACHE_EPOCH }}-yarn-${{ runner.os }}-
             ${{ env.CACHE_EPOCH }}-yarn-
 
-      - name: env (conda)
-        uses: conda-incubator/setup-miniconda@v2
+      - uses: actions/download-artifact@v2
         with:
-          environment-file: .github/environment.yml
-          use-only-tar-bz2: true
-          installer-url: |
-            https://github.com/conda-forge/miniforge/releases/download/4.9.2-0/Miniforge3-4.9.2-0-${{ matrix.miniforge }}
+          name: ipyelk dist ${{ github.run_number }}
+          path: ./dist
 
-      - name: build (linux)
+      - name: test (linux)
         if: ${{ contains(matrix.os, 'ubuntu') }}
         shell: bash -l {0}
-        run: INSTALL_ARTIFACT=sdist doit -n4 all || doit all || exit 1
+        run: |
+          export INSTALL_ARTIFACT=sdist
+          doit -n4 all || doit all || exit 1
 
-      - name: build (macos)
+      - name: test (macos)
         if: ${{ contains(matrix.os, 'macos') }}
         shell: bash -l {0}
         run: doit -n4 all || doit all || exit 1
 
-      - name: build (windows)
+      - name: test (windows)
         if: ${{ contains(matrix.os, 'windows') }}
         shell: cmd /C CALL {0}
         env:
           ATEST_PROCESSES: 1
           WIN_CI: 1
         run: doit all || doit all || exit 1
 
-      - name: publish (linux)
-        if: ${{ contains(matrix.os, 'ubuntu') }}
-        uses: actions/upload-artifact@v2
-        with:
-          name: ipyelk dist ${{ github.run_number }}
-          path: ./dist
-
       - name: reports
         uses: actions/upload-artifact@v2
         with:

.gitignore

@@ -159,6 +159,7 @@ py_src/ipyelk/labextension/*.tgz
 
 # generated files
 py_src/ipyelk/schema/*.json
+py_src/ipyelk/labextension/
 
 # editors
 .idea/

.prettierignore

@@ -0,0 +1,8 @@
+.yarn-packages/
+**/__pycache__/**/*
+**/.ipynb_checkpoints/**/*
+build/
+envs/
+lib/
+node_modules/
+py_src/ipyelk/labextension

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## @jupyrdf/jupyter-elk 1.0.0
+
+- updates for JupyterLab 3 ([#6][])
+  - uses `@lumino` components
+
+## ipyelk 1.0.0
+
+- supports (and depends on) JupyterLab 3 ([#6][])
+  - labextension is delivered as part of the `ipyelk` python package, no more
+    `lab build`
+  - `npm` tarballs will still be uploaded
+
+[#6]: https://github.com/jupyrdf/ipyelk/issues/6
+
+--
+
 ## @jupyrdf/jupyter-elk 0.3.0
 
 ## ipyelk 0.3.0

CONTRIBUTING.md

@@ -2,14 +2,20 @@
 
 ## Install
 
-- Get [Miniconda3](https://docs.conda.io/en/latest/miniconda.html)
+- Get [Miniforge](https://github.com/conda-forge/miniforge)
 - Get [anaconda-project](https://anaconda-project.readthedocs.io)
 - Get [doit](https://pydoit.org)
 
 ```bash
 conda install anaconda-project=0.8.4 doit=0.32
 ```
 
+To have an environment _similar_ to what's on CI:
+
+```bash
+CONDA_EXE=$(which mamba) CONDARC=.github/.condarc conda env update --file .github/environment.yml
+```
+
 ## Get Started
 
 ```bash
@@ -140,7 +146,7 @@ anaconda-project run twine upload where-you-expanded-the-archive/ipyelk-*
 - Run:
 
 ```bash
-anaconda-project update
+python scripts/lock.py
 doit lint
 ```
 

MANIFEST.in

@@ -1,5 +1,6 @@
 include LICENSE.txt README.md COPYRIGHT.md py_src/ipyelk/schema/elkschema.json
 recursive-include third-party *.html
+recursive-include py_src/ipyelk/labextension *.*
 recursive-exclude scripts *.*
 
 exclude src lib docs examples package.json scripts

README.md

@@ -19,36 +19,31 @@
 ## Prerequisites
 
 - `python >=3.7`
-- `jupyterlab >=1,<2` _JupyterLab 2+ compatibility coming soon!_
-- `nodejs >=10,<14`
+
+### JupyterLab compatibility
+
+| `jupyterlab` | `ipyelk` | special concerns                                                                                                          |
+| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------- |
+| `==1.*`      | `>1`     | needs `nodejs >10`<br/>`jupyter labextension install @jupyrdf/jupyter-elk`<br/>backports, etc. land on the `0.3.x` branch |
+| `==2.*`      | `>1`     | _untested_                                                                                                                |
+| `==3.*`      | `>=1`    |
 
 ## Install
 
 `ipyelk` is distributed on [conda-forge][] and [PyPI][].
 
 ### `ipyelk` with `conda` (recommended)
 
-`conda` can also install `nodejs`.
-
 ```bash
-conda install -c conda-forge ipyelk jupyterlab=1 nodejs
+conda install -c conda-forge ipyelk jupyterlab=3
 ```
 
 ### `ipyelk` with `pip`
 
 install `nodejs` with a [package manager][package-manager]
 
 ```bash
-pip install ipyelk jupyterlab=1
-```
-
-### `@jupyrdf/jupyter-elk` with `jupyter labextension install`
-
-`@jupyrdf/jupyter-elk` is distributed on [npm][], and relies on
-`@jupyter-widgets/jupyterlab-manager`.
-
-```bash
-jupyter labextension install @jupyter-widgets/jupyterlab-manager @jupyrdf/jupyter-elk
+pip install ipyelk jupyterlab=3
 ```
 
 ### Developing
@@ -62,6 +57,11 @@ In your kernel, `ipyelk`:
 - build [ELK JSON][elk-json]
   - optionally, use [networkx][]
 
+In your `jupyter_server`:
+
+- serve the `@jupyrdf/jupyter-elk` assets as a
+  [federated module](https://jupyterlab.readthedocs.io/en/latest/extension/extension_dev.html#prebuilt-extensions)
+
 In the browser, `@jupyrdf/jupyter-elk`:
 
 - [ELK][] lays out the diagram in a WebWorker
@@ -72,7 +72,6 @@ In the browser, `@jupyrdf/jupyter-elk`:
 
 ```bash
 pip uninstall ipyelk
-jupyter labextension uninstall @jupyrdf/jupyter-elk
 ```
 
 ## Open Source