visgl / visgl/deck.gl

[Feat] [pydeck] Update for JupyterLab 3

Open
#6,989 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature pydeck
Dominant language
TypeScript
Stars
14.6k
Forks
2.3k
Avg merge
2d 9h
Merged PRs (30d)
42

Description

Target Use Case

First, there is an issue with the jupyter-widget module in JupyterLab 3 (#5615).

Second, using a prebuilt extension in JupyterLab 3 would allow a more standard installation for pydeck. A user could just run pip install pydeck to install the JupyterLab extension and not require a rebuild.

Proposal

I think I was able to make the update for JupyterLab 3 here by following the advice in the ipywidgets CHANGELOG:

https://github.com/dakoop/deck.gl/tree/pydeck-8.7

Then, I tried to create a prebuilt extension. Since jupyter-builder uses webpack 5, and pydeck uses 4, there were some headaches, including something that seems to be related to the acorn package. pydeck specifies a resolution for acorn to 7.4.1, and jupyter labextension build just hangs. If I remove the resolution (which I think allows acorn versions to be different for different packages), the build suceeds. This should allow a python -m build in the bindings/pydeck directory, which produces a wheel that can be used for pip. That branch is available here:

https://github.com/dakoop/deck.gl/tree/pydeck-8.7-prebuilt

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the bindings/pydeck directory and compare the referenced pydeck-8.7 and pydeck-8.7-prebuilt branches. Run jupyter labextension build and python -m build to investigate the acorn resolution issue. Done means a JupyterLab 3 prebuilt extension is packaged in the wheel and can be installed with pip.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, python, webpack
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.