jupyterlab-workshop

Guided, interactive workshops inside JupyterLab.

Early in development. The documentation and the experience are still being polished, and the workshop format, settings and command line can change between releases without a compatibility path.

Teaching in JupyterLab usually means a notebook with explanation between the code cells. Learners read down it pressing Run, everything has to be a cell in one language, and nothing can tell whether a step was done. This extension separates the instructions from the work: they live in a side panel, one page at a time, and each step is a clickable action that does something real in the JupyterLab session beside it, in a terminal, the editor, a notebook, a kernel or the interface itself. Workshops can check what the learner has done, ask questions, collect values, hold pages until requirements are met, and snapshot the working directory, and the subject can be anything JupyterLab can host, including JupyterLab itself.

A workshop is a directory with a workshop.yaml manifest and Markdown pages. The format is text based and git friendly. A workshop runs wherever JupyterLab runs, and can be handed to learners through a published collection, a Binder link, or a static JupyterLite site that runs entirely in the browser.

Install

The package is a prebuilt JupyterLab 4 extension with its server extension, installed into a virtual environment alongside JupyterLab with uv add jupyterlab jupyterlab-workshop or the pip equivalent. Getting started walks through the setup, runs an example workshop and scaffolds one of your own; the jupyter workshop command that comes with the package lints, self-tests and publishes workshops, and author mode in JupyterLab edits them in place.

Learn more

Launch the showcase on Binder: three short workshops that show what the extension does and why, in a full JupyterLab with a real terminal, from the showcase repository that is also the pattern for publishing a collection of your own. Or try the demo: the Hello JupyterLab example running in JupyterLite, started afresh on every visit.
How workshops work and the tutorial, which writes a small workshop from nothing and publishes it.
Using workshops for learners and Deploying workshops for Binder, JupyterHub and locked-down images.
The documentation for the rest: every action a page can use, checks and forms, variables, layouts, platforms, JupyterLite, publishing, trust, the manifest and settings references, the command line and authoring in JupyterLab.
Source, issues and contributing: see CONTRIBUTING.md in the repository for the development setup.

License

Apache License 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_workshop-0.1.14.tar.gz (1.2 MB view details)

Uploaded Sep 8, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

jupyterlab_workshop-0.1.14-py3-none-any.whl (432.1 kB view details)

Uploaded Sep 8, 2026 Python 3

File details

Details for the file jupyterlab_workshop-0.1.14.tar.gz.

File metadata

Download URL: jupyterlab_workshop-0.1.14.tar.gz
Upload date: Sep 8, 2026
Size: 1.2 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for jupyterlab_workshop-0.1.14.tar.gz
Algorithm	Hash digest
SHA256	`3a15295f1e2663e80d3ee0e471f906dd728cd91c447659ee6b3fe35f6e1592a1`
MD5	`4c0feea73b3609cc8e87d1c98ef99883`
BLAKE2b-256	`38642028dcd01880d571a5c42ed2ea9b6653a0509e059440d82635cdf39bf99a`

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterlab_workshop-0.1.14.tar.gz:

Publisher: release.yml on GrahamDumpleton/jupyterlab-workshop

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: jupyterlab_workshop-0.1.14.tar.gz
- Subject digest: 3a15295f1e2663e80d3ee0e471f906dd728cd91c447659ee6b3fe35f6e1592a1
- Sigstore transparency entry: 2755313714
- Sigstore integration time: Sep 8, 2026
Source repository:
- Permalink: GrahamDumpleton/jupyterlab-workshop@eb912c7ad8ee0f58d84a53a7905524656502e660
- Branch / Tag: refs/tags/0.1.14
- Owner: https://github.com/GrahamDumpleton
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@eb912c7ad8ee0f58d84a53a7905524656502e660
- Trigger Event: push