Skip to content

events: create an event to open a new tab in Jupyter Lab #673

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

events: create an event to open a new tab in Jupyter Lab #673

wants to merge 1 commit into from

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Mar 10, 2025 •
edited
Loading

Training day exercise: Write a Jupyter Lab plugin

How it works:

  • The user is presented an "Open in Jupyter Lab" button in cylc-ui.
  • When pressed, cylc-ui sends a REST request to the URL lab-bridge/open/
  • When this request is received, cylc-uiserver logs an "event" with Jupyter Events.
  • This event is bubbled up to all components (incl, Lab).
  • A Jupyter Lab extension listens for this event and opens files when it receives one.

Components:

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • Changelog entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

@oliver-sanders
events: create an event to open a new tab in Jupyter Lab
c6a592d 
* Add a new Jupyter Event schema for this event.
* Add a new endpoint. The event is created server side.
* Works with https://github.com/oliver-sanders/cylc-jupyterlab-extension
This was referenced Mar 10, 2025
Draft
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JupyterServer: opening content in other extensions
1 participant
@oliver-sanders