jupyterlab-workshop

Guided, interactive workshops inside JupyterLab.

Teaching in JupyterLab usually means a notebook with explanation between the code cells, which learners read down pressing Run. 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 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, and hold pages until requirements are met. A workshop is a directory with a workshop.yaml manifest and Markdown pages, and it runs wherever JupyterLab runs, including entirely in the browser with JupyterLite.

• Get started

  Install the extension, run an example workshop and scaffold your own in fifteen minutes.

• Documentation

  How workshops work, writing workshops, the manifest reference, the command line and more.

• Showcase on Binder

  Three short workshops that show what the extension does and why, in a full JupyterLab with a real terminal.

• Try the demo

  The Hello JupyterLab example running in JupyterLite, with no installation, started afresh on every visit.

• PyPI package

  uv add jupyterlab jupyterlab-workshop or pip install jupyterlab jupyterlab-workshop in a virtual environment.

• Source on GitHub

  Issues, examples and contributing.

• JSON schemas

  workshop.schema.json for workshop.yaml and collection.schema.json for collection indexes and catalog.schema.json for catalogs.