Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[Jupyter] Update jupyter widget, release [email protected] (#1525)

Shan He3e47b4b49986
diff --git a/bindings/kepler.gl-jupyter/js/README.md b/bindings/kepler.gl-jupyter/js/README.md
index 6aba92398..2394dd693 100644
--- a/bindings/kepler.gl-jupyter/js/README.md
+++ b/bindings/kepler.gl-jupyter/js/README.md
@@ -3,36 +3,40 @@
This is a simple jupyter widget for kepler.gl, an advanced geospatial visualization tool, to render large-scale interactive maps.
## Package Install
----------------
+
+---
**Prerequisites**
+
- [node](http://nodejs.org/) >=8.15.0
- [yarn](https://yarnpkg.com/en/docs/install#mac-stable) >=1.6.0
**More links**
+
- [Jupyter Widget](https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Custom.html)
- [Widget Cookiecutter](https://github.com/jupyter-widgets/widget-cookiecutter)
## Local Dev
----------------
+
+---
### Local Dev Installation for Classic Notebook
To develop this package against the classic notebook, run:
- `pip install -e .` (installs python package for development, runs `npm install` and `npm run build`)
-- `jupyter nbextension install --py --symlink --sys-prefix <python_package_name>`\
-(symlinks `static/` directory into `<jupyter path>/nbextensions/<extension_name>/`). Now the notebook has access to the frontend code.
-- `jupyter nbextension enable --py --sys-prefix <python_package_name>`\
-(copies `<npm_package_name>.json` into `<environment path>/etc/jupyter/nbconfig/notebook.d/` directory). Now the notebook will load your frontend code on page load.
+- `jupyter nbextension install --py --symlink --sys-prefix keplergl`\
+ (symlinks `static/` directory into `<jupyter path>/nbextensions/keplergl/`). Now the notebook has access to the frontend code.
+- `jupyter nbextension enable --py --sys-prefix keplergl`\
+ (copies `<npm_package_name>.json` into `<environment path>/etc/jupyter/nbconfig/notebook.d/` directory). Now the notebook will load your frontend code on page load.
Now make some changes to your source code. Then:
- After making Python code changes, restarting the notebook kernel will be enough to reflect changes
- After making JavaScript code changes:
- - `cd js`
- - `npm run build`
- - Refresh browser to reflect changes
+ - `cd js`
+ - `npm run build`
+ - Refresh browser to reflect changes
### Local Dev Installation for JupyterLab
@@ -47,11 +51,12 @@ Now make some changes to your source code. Then:
- After making Python code changes, restarting the notebook kernel will be enough to reflect changes
- After making JavaScript code changes:
- - `cd js`
- - `npm run build:lab`
- - Refresh browser to reflect changes
-- By default, the application will load from the JupyterLab staging directory (default is <sys-prefix>/share/jupyter/lab/staging. Check the correct version of `@jupyter-widgets/jupyterlab-manager` and `@jupyter-widgets/base` is install in `yarn.lock`
+ - `cd js`
+ - `npm run build:lab`
+ - Refresh browser to reflect changes
+
+- By default, the application will load from the JupyterLab staging directory (default is <sys-prefix>/share/jupyter/lab/staging. Check the correct version of `@jupyter-widgets/jupyterlab-manager` and `@jupyter-widgets/base` is install in `yarn.lock`
#### JupyterLab widget Dependencies
@@ -59,4 +64,4 @@ Install correct version of jupyterlab-manager based on your Jupyter Lab version.
- [@jupyter-widgets/jupyterlab-manager](https://github.com/jupyter-widgets/ipywidgets/tree/master/packages/jupyterlab-manager)
- [@jupyter-widgets/base](https://github.com/jupyter-widgets/ipywidgets/tree/master/packages/base)
-- [@jupyter-widgets/base-manager](https://github.com/jupyter-widgets/ipywidgets/tree/master/packages/base-manager)
\ No newline at end of file
+- [@jupyter-widgets/base-manager](https://github.com/jupyter-widgets/ipywidgets/tree/master/packages/base-manager)
diff --git a/bindings/kepler.gl-jupyter/js/lib/keplergl/components/app.js b/bindings/kepler.gl-jupyter/js/lib/keplergl/components/app.js
index e97410d93..14fdd12ea 100644
--- a/bindings/kepler.gl-jupyter/js/lib/keplergl/components/app.js
+++ b/bindings/kepler.gl-jupyter/js/lib/keplergl/components/app.js
@@ -93,10 +93,7 @@ function App() {
}, []);
return (
- <StyledContainer
- ref={rootElm}
- className="keplergl-widget-container"
- >
+ <StyledContainer ref={rootElm} className="keplergl-widget-container">
{Helmet ? (
<Helmet>
<meta charSet="utf-8" />
diff --git a/bindings/kepler.gl-jupyter/keplergl/_version.py b/bindings/kepler.gl-jupyter/keplergl/_version.py
index 81941c261..3c8a63347 100644
--- a/bindings/kepler.gl-jupyter/keplergl/_version.py
+++ b/bindings/kepler.gl-jupyter/keplergl/_version.py
@@ -1,4 +1,4 @@
-version_info = (0, 2, 2, 'final', 0)
+version_info = (0, 3, 0, 'final', 0)
_specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
@@ -12,4 +12,4 @@ __version__ = '%s.%s.%s%s'%(version_info[0], version_info[1], version_info[2],
# the widget models, or if the serialized format changes.
#
# The major version needs to match that of the JS package.
-EXTENSION_SPEC_VERSION = '^0.2.2'
\ No newline at end of file
+EXTENSION_SPEC_VERSION = '^0.3.0'
\ No newline at end of file