Jupyterlab 3.x.x support

[bdecato]

With a fresh install of Jupyterlab version 3.0.0, installing plotly with the command jupyter labextension install jupyterlab-plotly@4.14.1 yields an error:

An error occured.
ValueError: 
"jupyterlab-plotly@4.14.1" is not compatible with the current JupyterLab
Conflicting Dependencies:
JupyterLab                        Extension      Package
>=3.0.0 <3.1.0                    >=1.3.0 <2.0.0||>=2.0.0 <3.0.0@jupyterlab/rendermime-interfaces

Obviously this is a bleeding edge issue and very much a feature request, not a bug, I just wanted to make sure it was documented. Thank you!

[ptyshevs]

It will be also nice to have an option to disable version check during install. Who knows, maybe it doesn't have any breaking changes.

[nabetse00]

I've tested locally by cloning plotly.py repo and modifying the package.json line 34 to:

"@jupyterlab/rendermime-interfaces": "^1.3.0 || ^2.0.0  || ^3.0.0",

So far so good, no issues.

So steps to try that workaround:

• install jupyterlab v3 (i recommend conda to do this) and plotly

conda install -c conda-forge jupyterlab

• install nodejs (i used my local version v12 but >v12 should work too).
• run jupyter labextension install jupyterlab-plotly@4.14.1 you will get the same error as @bdecato said:

An error occured.
ValueError: 
"jupyterlab-plotly@4.14.1" is not compatible with the current JupyterLab
Conflicting Dependencies:
JupyterLab                        Extension      Package
>=3.0.0 <3.1.0                    >=1.3.0 <2.0.0||>=2.0.0 <3.0.0@jupyterlab/rendermime-interfaces

• clone plotly.py repo in another folder (TMP, EXT whatever ... ) and open the correct folder for the extension

mkdir EXT
cd EXT
git clone https://github.com/plotly/plotly.py.git
cd .\plotly.py\packages\javascript\jupyterlab-plotly\

• modify package.json line 34 to

"@jupyterlab/rendermime-interfaces": "^1.3.0 || ^2.0.0  || ^3.0.0",

• Build the extension and install; Inside this folder run:

npm instal
npm run build 
jupyter labextension install

• once it finishes, check the extension list:

jupyter labextension list

returns something like:

JupyterLab v3.0.0
Other labextensions (built into JupyterLab)
   app dir: C:\XXXXXXX\YYYYYY\jupyter\lab
        @jupyter-widgets/jupyterlab-manager v3.0.0 enabled ok
        jupyter-matplotlib v0.7.4 enabled ok
        jupyterlab-plotly v4.14.1 enabled ok*


   local extensions:
        jupyterlab-plotly: C:\XXX\EXT\plotly.py\packages\javascript\jupyterlab-plotly

Ready to test v3 compat !

[cvanelteren]

Although the workaround from @bdecato installs the plugin. FigureWidget is broken as of jlab v3 embedding inside ipywidgets V/Hboxes. Running them standalone works fine.

[nabetse00]

@cvanelteren did you install Jupyter widgets extension:

jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.14.1

Official doc say it's optional but maybe needed for widgets in ipywidgets.

[cvanelteren]

Yes I have. For the time being I downgraded jupyerlab back down.

On Sun, 3 Jan 2021 at 10:10, nabetse ***@***.***> wrote: @cvanelteren <https://github.com/cvanelteren> did you install *Jupyter widgets extension*: jupyter labextension install @jupyter-widgets/jupyterlab-manager ***@***.*** Official doc say it's optional but maybe needed for widgets in ipywidgets. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2994 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEUVDV74GKQVOMHKRHVMYLLSYAX7ZANCNFSM4VJKLKEA> .

-- - Checkout my website <https://cvanelteren.github.io/> for contact info and current projects!

[jasongrout]

FYI, see the ipywidgets changelog for instructions for maintainers to upgrade widgets packages: https://ipywidgets.readthedocs.io/en/stable/changelog.html#updates-for-widget-maintainers

[jasongrout]

CC @nicolaskruchten - see my comment above for tips to upgrade for JupyterLab 3. This hopefully should be a pretty straightforward upgrade.

[cvanelteren]

Hi @jasongrout , thanks for the tip. Unfortunately I am running the latest ipywidgets already. There is a current PR that should fix the issue.

[jasongrout]

There is a current PR that should fix the issue.

Nice! What PR is open? I couldn't find one.

[nicolaskruchten]

Thanks @jasongrout! We'll look at getting JupyterLab 3.x support in the next week or so.

[barathvb]

Would older versions of plotly (such as 4.8.x) get JupyterLab 3.x support?

[nicolaskruchten]

In general, newer versions of the extension play nicely with older versions of the Python module, so tentatively "yes".