✨[Feature]: Add pip-based install support for JupyterLab side panel extension #35399
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Assigning reviewers: R: @jrmccluskey for label python. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
Contributor
|
Please fix the failed workflows. |
Contributor
|
I'll hold off on merging until your requested reviewer takes a look. |
Contributor
Author
Thank you! I think it can be merged now😁 |
Contributor
Author
Contributor
|
Next step to release this to pypi? |
Contributor
Author
Now I've released the package on PyPI: https://pypi.org/project/apache-beam-jupyterlab-sidepanel/ |
shunping
pushed a commit
to shunping/beam
that referenced
this pull request
Jun 27, 2025
…xtension (apache#35399) * Add pip installation * update CHANGES.md * Add license * update format * Fix whitspace problem * Fix isort problem * update ignore rules
25 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR enables the
apache-beam-jupyterlab-sidepanelJupyterLab extension to be installed viapipdirectly, without requiring the use ofjupyter labextension install. Fixing the issue #35397This makes the extension fully compatible with the JupyterLab prebuilt extension system, improves ease of use, and aligns with the packaging approaches adopted by other JupyterLab 4.x-compatible projects.
Changes
Packaging Example
After installation, the extension is automatically available in JupyterLab — no jupyter labextension install step required.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.