# keplergl-jupyter

> This is a simple jupyter widget for kepler.gl, an advanced geo-spatial visualization tool, to render large-scale interactive maps.

Latest version **0.3.7** (published 2025-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install keplergl-jupyter
pnpm add keplergl-jupyter
yarn add keplergl-jupyter
bun add keplergl-jupyter
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.3.7 |
| Published | 2025-02-01 |
| First published | 2019-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 24 |
| Unpacked size | 11.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12010 |
| Author | Shan He |
| Maintainers | heshan0131, igordykhta |
| Keywords | jupyter, jupyterlab, jupyterlab-extension, widgets, ipython, ipywidgets |

## Links

- npm: https://www.npmjs.com/package/keplergl-jupyter
- Repository: https://github.com/keplergl/kepler.gl
- Homepage: https://github.com/keplergl/kepler.gl#readme
- Issues: https://github.com/keplergl/kepler.gl/issues
- npm.io page: https://npm.io/package/keplergl-jupyter

## Dependencies (24)

- [react](https://npm.io/package/react.md) ^18.2.0
- [redux](https://npm.io/package/redux.md) ^4.2.1
- [global](https://npm.io/package/global.md) ^4.3.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-intl](https://npm.io/package/react-intl.md) ^6.3.0
- [querystring](https://npm.io/package/querystring.md) 0.2.1
- [react-redux](https://npm.io/package/react-redux.md) ^8.0.5
- [react-helmet](https://npm.io/package/react-helmet.md) ^5.2.0
- [redux-actions](https://npm.io/package/redux-actions.md) ^2.2.1
- [@loaders.gl/csv](https://npm.io/package/@loaders.gl/csv.md) ^4.1.0
- [@loaders.gl/core](https://npm.io/package/@loaders.gl/core.md) ^4.1.0
- [@loaders.gl/json](https://npm.io/package/@loaders.gl/json.md) ^4.1.0
- [@kepler.gl/styles](https://npm.io/package/@kepler.gl/styles.md) ^3.0.0
- [@loaders.gl/arrow](https://npm.io/package/@loaders.gl/arrow.md) ^4.1.0
- [styled-components](https://npm.io/package/styled-components.md) 6.1.8
- [@kepler.gl/actions](https://npm.io/package/@kepler.gl/actions.md) ^3.0.0
- [@kepler.gl/schemas](https://npm.io/package/@kepler.gl/schemas.md) ^3.0.0
- [@jupyterlab/builder](https://npm.io/package/@jupyterlab/builder.md) ^4.0.0
- [@kepler.gl/reducers](https://npm.io/package/@kepler.gl/reducers.md) ^3.0.0
- [@jupyter-widgets/base](https://npm.io/package/@jupyter-widgets/base.md) ^6
- [@kepler.gl/components](https://npm.io/package/@kepler.gl/components.md) ^3.0.0
- [@kepler.gl/processors](https://npm.io/package/@kepler.gl/processors.md) ^3.0.0
- [react-copy-to-clipboard](https://npm.io/package/react-copy-to-clipboard.md) ^5.0.2
- [node-polyfill-webpack-plugin](https://npm.io/package/node-polyfill-webpack-plugin.md) ^1.1.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.3.7 (latest) — 2025-02-01
- 0.3.6 — 2025-01-10
- 0.3.5 — 2024-12-27
- 0.3.4 — 2024-12-27
- 0.3.4-a4 — 2024-12-27
- 0.3.4-a3 — 2024-07-17
- 0.3.4-a2 — 2024-07-17
- 0.3.4-a1 — 2024-07-17
- 0.3.2 — 2021-09-16
- 0.3.1 — 2021-09-13
- 0.3.0 — 2021-06-29
- 0.2.2 — 2020-12-01
- 0.2.1 — 2020-08-16
- 0.2.0 — 2020-05-13
- 0.2.0-alpha2 — 2020-05-13
- … 6 more at https://npm.io/package/keplergl-jupyter/versions

## README

# keplergl-jupyter

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 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

### Local Dev Installation for JupyterLab

To develop this package against JupyterLab, run:

- `pip install -e .` (installs python package for development, runs `npm install` and `npm run build`)
- `jupyter labextension install @jupyter-widgets/jupyterlab-manager`: this install lab widgets manager.
- `jupyter labextension install js`: this installs the current labextension into JupyterLab and enables it.
- `jupyter lab --watch` starts JupyterLab, but in `--watch` mode: it will rebuild itself incrementally if it detects changes.

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`

#### JupyterLab widget Dependencies

Install correct version of jupyterlab-manager based on your Jupyter Lab version. Make sure `@jupyter-widgets/base` version in the widget does not conflict with requirements in `jupyterlab-manager`.

- [@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)

---
_Source: https://npm.io/package/keplergl-jupyter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
