jupyterlab-workshop

Guided, interactive workshops inside JupyterLab.

Workshop instructions are shown in a JupyterLab side panel and contain clickable actions that drive the live session: terminals, the file browser, the editor, notebooks, kernels and layout. Workshops can check what the learner has done, ask questions, collect values, hold pages until requirements are met, and snapshot the working directory. The concept comes from the Educates Training Platform, re-imagined so that a single workshop runs wherever JupyterLab runs, without Kubernetes or containers.

A workshop is a directory with a workshop.yaml manifest and Markdown pages. The format is text based and git friendly, and a workshop can also be published as a static JupyterLite site that runs entirely in the browser.

Warning: This project is in an early phase of development. The documentation is still being improved, the experience is still being polished, and the workshop format, settings and command line can change between releases without a compatibility path.

Install

pip install jupyterlab-workshop

The package is a prebuilt JupyterLab 4 extension with its server extension; nothing else needs installing. Open the Workshop panel from the right sidebar, or right-click a workshop directory in the file browser and choose "Open as Workshop".

Writing a workshop

pip install "jupyterlab-workshop[test]"
playwright install chromium
jupyter workshop init my-workshop
jupyter workshop lint my-workshop
jupyter workshop test my-workshop

lint needs Node.js on the path; test runs every action of the workshop in a real JupyterLab and reports each one. Inside JupyterLab, "Workshop: Author Mode" adds an editing toolbar to the panel, and jupyter workshop mcp (with the mcp extra) serves the same tools to AI agents. The lite extra adds jupyter workshop lite for building a JupyterLite site.

Learn more

Documentation: the actions a page can use, checks, forms and checkpoints, platforms, JupyterLite, the manifest reference, trust, the command line and authoring in JupyterLab.
Try the demo: the example workshop running in JupyterLite.
Launch on Binder: the git-basics example in a full JupyterLab with a real terminal.
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.0.tar.gz (647.3 kB view details)

Uploaded Sep 6, 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.0-py3-none-any.whl (377.2 kB view details)

Uploaded Sep 6, 2026 Python 3

File details

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

File metadata

Download URL: jupyterlab_workshop-0.1.0.tar.gz
Upload date: Sep 6, 2026
Size: 647.3 kB
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.0.tar.gz
Algorithm	Hash digest
SHA256	`fac876195af25cc3ad674a865c2843c8004ce15de1a743c2fa1917e7163a5b7b`
MD5	`5ccdd43804d41ae111403fbede5e9937`
BLAKE2b-256	`ebabf7c273a1481b12ac5afc3ade0b7961ae645ec5605bbc66454f714ea1424f`

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterlab_workshop-0.1.0.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.0.tar.gz
- Subject digest: fac876195af25cc3ad674a865c2843c8004ce15de1a743c2fa1917e7163a5b7b
- Sigstore transparency entry: 2733225348
- Sigstore integration time: Sep 6, 2026
Source repository:
- Permalink: GrahamDumpleton/jupyterlab-workshop@d11e0da2b4b76af1efd1d59422b9495e2f485239
- Branch / Tag: refs/tags/0.1.0
- Owner: https://github.com/GrahamDumpleton
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@d11e0da2b4b76af1efd1d59422b9495e2f485239
- Trigger Event: push