Skip to content

Update dependencies to include jupyterlab 3.x.x (JupyterLab 3 support) #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jan 11, 2021

Conversation

dipanjank
Copy link
Contributor

@dipanjank dipanjank commented Dec 30, 2020

Changed jupyterlab component dependencies to include jupyterlab 3.0.0.

Fixes #219

@welcome
Copy link

welcome bot commented Dec 30, 2020

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@dipanjank dipanjank mentioned this pull request Dec 30, 2020
@dipanjank dipanjank changed the title Update dependencies to include jupyterlab 3.x.x Update dependencies to include jupyterlab 3.x.x - Fixes #219 Dec 30, 2020
@jtpio
Copy link
Contributor

jtpio commented Jan 7, 2021

Thanks!

Maybe it could be useful to add a small CI step to build and install the lab extension, similar to: https://github.com/jupyterlab/jupyterlab_apod/blob/2df8db256d67a28b3f728e2c3b5adef0a7a67fa9/.github/workflows/build.yml#L1

@dipanjank
Copy link
Contributor Author

dipanjank commented Jan 7, 2021 via email

@jtpio
Copy link
Contributor

jtpio commented Jan 7, 2021

A follow-up PR could also update the setup.py and the packaging of the extension, so it adopts the new distribution system.

Meaning that a single pip install jupyter-server-proxy would also install the JupyterLab 3.0 extension by default.

There is more information about the new distribution in the docs:

@dipanjank
Copy link
Contributor Author

dipanjank commented Jan 7, 2021 via email

@jtpio
Copy link
Contributor

jtpio commented Jan 7, 2021

Yes it would make sense to first release a new version of the extension to npm, with the changes from this PR, so it can be installed with JupyterLab 3.0 using the jupyter labextension install.

And then as a second step switch to the new distribution system, which will require releasing the Python package to PyPI.

@dipanjank
Copy link
Contributor Author

dipanjank commented Jan 7, 2021 via email

@dipanjank
Copy link
Contributor Author

Okay, added the "build" job which installs the extension in a virtualenv with all supported python versions, installs jupyterlab, installs the extension.

Copy link
Member

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM!

Along with merging this, I figure we should release a jupyterlab extension as a NPM package, but then transition to packaging it in Python. I opened #233 for that.

@dipanjank have you tried this to work locally as well btw? I'm not a very active maintainer on this project and have only now done a review of the changes rather than tried them.

@jtpio do you suggest we release v3.0.0 of the NPM package to indicate its JL 3 compatible, or stay with v2.x.y as it is not a breaking change involved?

@dipanjank
Copy link
Contributor Author

@consideRatio yes, I did the following

  • Create a virtualenv and install jupyterlab.
  • Install my local version with jupyter labextension install .
  • Install tensorflow (which comes bundled with tensorboard)
  • Add a tensorboard proxy entry in ~/.jupyter/jupyter_notebook_config.json
  • Start jupyterlab and verify that tensorboard is available at http://localhost:8888/tensorboard.

I think this can be done as an automated test. Will give it a try at some point if you think it's valuable.

@dipanjank dipanjank closed this Jan 11, 2021
@dipanjank dipanjank reopened this Jan 11, 2021
@consideRatio
Copy link
Member

@dipanjank nice, thank you!

@consideRatio consideRatio merged commit 8b047aa into jupyterhub:master Jan 11, 2021
@welcome
Copy link

welcome bot commented Jan 11, 2021

Congrats on your first merged pull request in this project! 🎉
congrats
Thank you for contributing, we are very proud of you! ❤️

@consideRatio
Copy link
Member

I released version 2.1.2 of the JupyterLab extension to NPM.

@jtpio
Copy link
Contributor

jtpio commented Jan 11, 2021

do you suggest we release v3.0.0 of the NPM package to indicate its JL 3 compatible, or stay with v2.x.y as it is not a breaking change involved?

Usually semver is useful to communicate the type of changes (breaking or not) to the consumer of the package. For this extension if it's still compatible with both lab 2 and 3, then it should be fine to stick to v2.x.y I think.

@ryanlovett
Copy link
Collaborator

See #197 for more discussion about npm package versioning.

@dipanjank dipanjank deleted the feature/jupyterlab-3.x.x branch January 11, 2021 16:22
@consideRatio consideRatio changed the title Update dependencies to include jupyterlab 3.x.x - Fixes #219 Update dependencies to include jupyterlab 3.x.x (JupyterLab 3 support) Feb 2, 2021
@meeseeksmachine
Copy link

This pull request has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/how-to-launch-browser-from-jupyterlab/7912/6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support JupyterLab 3
5 participants