Migration from jupyter widget 7.x to 8.x and from jupyter packaging to hatch jupyter builder

.github/workflows/main.yml

@@ -21,6 +21,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         python-version: [3.12]
+        yarn-version: [1.22.22]
 
     steps:
     - uses: actions/checkout@v2
@@ -29,21 +30,22 @@ jobs:
       uses: conda-incubator/setup-miniconda@v3
       with:
         mamba-version: "*"
-        channels: conda-forge
+        channels: conda-forge,defaults
 
     - name: Mamba install dependencies
-      run: mamba install python=${{ matrix.python-version }} pip nodejs jupyter-packaging
+      run: mamba install python=${{ matrix.python-version }} pip nodejs yarn=${{ matrix.yarn-version }}
 
-    - name: Mamba install JupyterLab 3
-      run: mamba install jupyterlab=3.5 ipywidgets=7.6
+    - name: Mamba install JupyterLab 4
+      run: mamba install jupyterlab=4.4.3 ipywidgets=8.1.7
 
     - name: Install here-map-widget-for-jupyter
       run: |
-        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
         pip install .[dev]
 
     - name: Check installation files
       run: |
+        echo "CONDA_PREFIX=$CONDA_PREFIX"
         test -d $CONDA_PREFIX/share/jupyter/nbextensions/@here/map-widget-for-jupyter
         test -f $CONDA_PREFIX/share/jupyter/nbextensions/@here/map-widget-for-jupyter/extension.js
         test -f $CONDA_PREFIX/share/jupyter/nbextensions/@here/map-widget-for-jupyter/index.js
@@ -59,7 +61,8 @@ jobs:
     - name: Build the package (Only on Linux for saving time)
       if: matrix.os == 'ubuntu-latest'
       run: |
-        python setup.py sdist bdist_wheel
+        pip install hatch
+        hatch build
 
     - name: Build docs (Only on Linux for saving time)
       if: matrix.os == 'ubuntu-latest'

.github/workflows/release.yml

@@ -16,6 +16,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         python-version: [3.12]
+        yarn-version: [1.22.22]
     steps:
     - uses: actions/checkout@v2
 
@@ -26,10 +27,10 @@ jobs:
         channels: conda-forge
 
     - name: Mamba install dependencies
-      run: mamba install python=${{ matrix.python-version }} pip nodejs yarn jupyter-packaging
+      run: mamba install python=${{ matrix.python-version }} pip nodejs yarn=${{ matrix.yarn-version }}
 
-    - name: Mamba install JupyterLab 3
-      run: mamba install jupyterlab=3.5 ipywidgets=7.6
+    - name: Mamba install JupyterLab 4
+      run: mamba install jupyterlab=4.4.3 ipywidgets=8.1.7
 
     - name: Install tools
       run: |
@@ -40,9 +41,10 @@ jobs:
         node --version
         npm --version
         yarn --version
-        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
         pip install .
-        python setup.py sdist bdist_wheel
+        pip install hatch
+        hatch build
     - name: Publish to PyPI
       uses: pypa/gh-action-pypi-publish@master
       with:
@@ -56,10 +58,10 @@ jobs:
     - name: Publish to NPM
       run: |
         cd js
-        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+        npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
         npm install --legacy-peer-deps
         npm run build
-        npm config delete @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+        npm config delete @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
         npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
         npm publish --access=public
       env:

.gitignore

@@ -1,23 +1,24 @@
 *.egg-info/
 .ipynb_checkpoints/
-dist/
-build/
-*.py[cod]
-node_modules/
 .idea/
 .vscode/
+build/
+*.py[cod]
+src/*
+venv/
 
 # Compiled javascript
 here_map_widget/static/
-src/*
-*package-lock.json
+here_map_widget/nbextension/
+here_map_widget/labextension/
 
 # OS X
 .DS_Store
-venv
 
-# Compiled javascript
-here_map_widget/nbextension/
-here_map_widget/labextension/
+# Source javascript
+js/.yarn/
 js/dist/
-yarn.lock
+js/node_modules/
+js/.npmrc
+js/.yarnrc
+js/yarn.lock

.ort.yml

@@ -14,6 +14,6 @@ excludes:
     reason: "DOCUMENTATION_OF"
     comment: "Directory is only used for generating documentation for gitlab pages."
   scopes:
-  - name: "devDependencies"
+  - pattern: "devDependencies"
     reason: "DEV_DEPENDENCY_OF"
     comment: "Packages for development only."

README.md

@@ -72,7 +72,7 @@ Below extra commands are required only if you are using classic Jupyter Notebook
 
 Below extra commands are required only if you are using JupyterLab (version 2 or older):
 
-    $ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+    $ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
 
     $ jupyter labextension install @jupyter-widgets/jupyterlab-manager @here/map-widget-for-jupyter
 
@@ -81,7 +81,7 @@ Below extra commands are required only if you are using JupyterLab (version 2 or
 
 For a development installation (requires yarn, you can install it with `conda install -c conda-forge yarn`):
 
-    $ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+    $ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
     $ git clone https://github.com/heremaps/here-map-widget-for-jupyter.git
     $ cd here-map-widget-for-jupyter
     $ pip install -e .

RELEASE.md

@@ -5,7 +5,8 @@ This document describes the release process of here-map-widget-for-jupyter, and
 
 The following are mandatory pre-release steps to bring the repository into a proper shape:
 
-- Update version in [here_map_widget/_version.py](here_map_widget/_version.py) as desired.
+- Update versions in [pyproject.toml](pyproject.toml)
+- Update versions in [here_map_widget/_version.py](here_map_widget/_version.py) as desired.
 - Update [js/package.json](js/package.json) with new npm package version.  
 - Make sure all tests listed in `CONTRIBUTING.md` pass successfully.
 - Make sure badges appear as expected in the [README.md on GitHub](https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/README.md).

examples/basemaps.ipynb

@@ -171,9 +171,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "from here_map_widget import Map, Platform, MapTile, TileLayer\n",
@@ -259,7 +257,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -273,7 +271,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.13.1"
   }
  },
  "nbformat": 4,

here_map_widget/_version.py

@@ -4,7 +4,7 @@
 """Project version information."""
 
 # Module version
-version_info = (1, 1, 3)
+version_info = (2, 0, 0)
 
 # Module version accessible using here_map_widget.__version__
 __version__ = "%s.%s.%s" % (
@@ -13,4 +13,4 @@
     version_info[2],
 )
 
-EXTENSION_VERSION = "^1.1.3"
+EXTENSION_VERSION = "^2.0.0"

js/.babelrc

@@ -23,5 +23,12 @@
 */
 
 {
-  "plugins": ["transform-object-rest-spread"]
+  "presets": [
+    ["env", {
+      "targets": {
+        "node": "current"
+      }
+    }]
+  ],
+  "plugins": ["@babel/plugin-proposal-object-rest-spread"]
 }

js/README.md

@@ -9,7 +9,7 @@ Package Install
 - [node](http://nodejs.org/)
 
 ```bash
-npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/maps-api-for-javascript
 
-npm install --save @here/map-widget-for-jupyter
+yarn add @here/map-widget-for-jupyter
 ```

js/lib/Map.js

@@ -449,17 +449,17 @@ export class MapView extends widgets.DOMWidgetView {
     );
   }
 
-  processPhosphorMessage(msg) {
-    super.processPhosphorMessage(msg);
+  processLuminoMessage(msg) {
+    super.processLuminoMessage(msg);
     switch (msg.type) {
       case 'resize':
-        console.log('Phosphor resize');
+        console.log('Lumino resize');
         if (this.obj) {
           this.obj.getViewPort().resize();
         }
         break;
       case 'after-show':
-        console.log('Phosphor after-show');
+        console.log('Lumino after-show');
         this.obj.getViewPort().resize();
         break;
     }

js/lib/control/FullscreenControl.js

@@ -5,8 +5,8 @@
 const control = require('./Control.js');
 const widgets = require('@jupyter-widgets/base');
 const _ = require('lodash');
-const PMessaging = require('@phosphor/messaging');
-const PWidgets = require('@phosphor/widgets');
+const LMessaging = require('@lumino/messaging');
+const LWidgets = require('@lumino/widgets');
 
 class FullscreenControl extends H.ui.Control {
   constructor(map_view) {

js/lib/control/SearchControl.js

@@ -5,8 +5,8 @@
 const control = require('./Control.js');
 const widgets = require('@jupyter-widgets/base');
 const _ = require('lodash');
-const PMessaging = require('@phosphor/messaging');
-const PWidgets = require('@phosphor/widgets');
+const LMessaging = require('@lumino/messaging');
+const LWidgets = require('@lumino/widgets');
 var centroid = require("@turf/centroid");
 var helpers = require("@turf/helpers");
 

js/lib/control/SplitMapControl.js

@@ -5,8 +5,8 @@
 const control = require('./Control.js');
 const widgets = require('@jupyter-widgets/base');
 const _ = require('lodash');
-const PMessaging = require('@phosphor/messaging');
-const PWidgets = require('@phosphor/widgets');
+const LMessaging = require('@lumino/messaging');
+const LWidgets = require('@lumino/widgets');
 const Map = require('../Map');
 class SplitMapControl extends H.ui.Control {
   constructor(map_view, leftLayer, rightLayer, left_map, right_map, left_container, right_container) {

js/lib/control/WidgetControl.js

@@ -5,8 +5,8 @@
 const control = require('./Control.js');
 const widgets = require('@jupyter-widgets/base');
 const _ = require('lodash');
-const PMessaging = require('@phosphor/messaging');
-const PWidgets = require('@phosphor/widgets');
+const LMessaging = require('@lumino/messaging');
+const LWidgets = require('@lumino/widgets');
 
 class WidgetControl extends H.ui.Control {
   constructor(opts) {
@@ -75,14 +75,14 @@ export class WidgetControlView extends control.ControlView {
         this.displayed.then(() => {
           this.widget_view.trigger('displayed', this);
           this.widget_view.displayed.then(() => {
-            PMessaging.MessageLoop.sendMessage(
+            LMessaging.MessageLoop.sendMessage(
               view.pWidget,
-              PWidgets.Widget.Msg.BeforeAttach
+              LWidgets.Widget.Msg.BeforeAttach
             );
             this.obj.setContent(view.el);
-            PMessaging.MessageLoop.sendMessage(
+            LMessaging.MessageLoop.sendMessage(
               view.pWidget,
-              PWidgets.Widget.Msg.AfterAttach
+              LWidgets.Widget.Msg.AfterAttach
             );
           });
         });

js/lib/provider/MapTile.js

@@ -65,7 +65,7 @@ export class MapTileView extends provider.ProviderView {
       var format = this.model.get('format');
       var options = {}
       if (this.model.get('additional_params')) {
-        options['additionalParameters'] = this.model.get('additional_params');
+        Object.assign(options, this.model.get('additional_params'));
       }
       this.obj = mapTiler.createTileProvider(TileType, scheme, TileSize, format, options);
     });

js/lib/provider/OMV.js

@@ -41,7 +41,7 @@ export class OMVView extends provider.ProviderView {
       const style_view = result[1];
       const engineType = H.Map.EngineType["HARP"];
       const platform = pltform_view !== null ? pltform_view.obj : null;
-      const config = style_view !== null ? style_view.obj.po : null;
+      const config = style_view !== null ? style_view.model.get('config') : null;
       const st = new H.map.render.harp.Style(config);
       var omvService = platform.getOMVService({
         path: this.model.get('path')