search

jupyterlab / extension-examples

JupyterLab Extensions by Examples
BSD 3-Clause "New" or "Revised" License
461 stars 170 forks source link
jupyter jupyterlab jupyterlab-extensions

readme

JupyterLab Extensions by Examples

Github Actions Status Binder

  1. Goal
  2. Develop by Examples
    1. CodeMirror extension
    2. Commands
    3. Command Palette
    4. Completer
    5. Main Widget Content Header
    6. Context Menu
    7. Custom Log Console
    8. Datagrid
    9. Dual Compatibility
      1. Top Area Text Widget
      2. Shout Button
      3. Clap Button
    10. Collaborative Document
    11. Hello World
    12. Kernel Messaging
    13. Kernel Output
    14. Launcher
    15. Log Messages
    16. Main Menu
    17. Metadata Form
    18. MIME Renderer
    19. Notifications
    20. React Widget
    21. Server Hello World
    22. Settings
    23. Signals
    24. State
    25. Toolbar Item
    26. Widgets
  3. Prerequisites
  4. Develop and Use the Examples
  5. Test the Examples
  6. Install a Published Extension
  7. About JupyterLab
  8. Credits
  9. Community Guidelines and Code of Conduct

TL;DR

The goal of this repository is to show how to develop extensions for JupyterLab, presented as short tutorial series.

To get started:

# clone the repository
git clone https://github.com/jupyterlab/extension-examples.git jupyterlab-extension-examples

# go to the extension examples folder
cd jupyterlab-extension-examples

# create a new environment
conda env create

# activate the environment
conda activate jupyterlab-extension-examples

# go to the hello world example
cd hello-world

# Required to deal with Yarn 3 workspace rules
touch yarn.lock

# install the extension in editable mode
python -m pip install -e .

# install your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite

# build the TypeScript source after making changes
jlpm run build

# start JupyterLab
jupyter lab

The examples currently target JupyterLab 4.0 or later.

If you would like to use the examples with JupyterLab 3.x, check out the 3.x branch.

If you would like to use the examples with JupyterLab 2.x, check out the 2.x branch.

If you would like to use the examples with JupyterLab 1.x, check out the 1.x branch.

Note that the 1.x, 2.x and 3.x branches are not updated anymore.

Develop by Examples

You may find it easier to learn how to create extensions by examples, instead of going through the documentation.

Start with the Hello World and then jump to the topic you are interested in.

You can expect from each example:

We have structured the examples based on the extension points. Browse the previews below or skip them and jump directly to the sections for developers.

You are welcome to open any issue or pull request.

Cell toolbar

Add a command button to the cell toolbar.

Cell toolbar

CodeMirror extension

Add a configurable CodeMirror extension.

CodeMirror extension

Commands

Extend the main app with a Command.

Command example

Command Palette

Register commands in the Command Palette.

Command Palette

Completer

Customize tab autocomplete data sources.

Completer

Main Widget Content Header

Put widgets at the top of a main JupyterLab area widget.

contentHeader

Context Menu

Add a new button to an existent context menu.

Context Menu

Custom Log Console

Create a new log console.

Custom Log Console

Datagrid

Display a Datagrid as a Lumino Widget.

Datagrid

Dual Compatibility

The dual compatibility examples demonstrates how to design an extension that can be integrated similtaneously in JupyterLab and Jupyter Notebook v7+.

They are listed from the simplest to the most advanced case:

Top Area Text Widget

A very simple example that adds a basic text widget to the top area. See related video.. This example is part of the Extension Compatibility Guide.

Top Area Text Widget

Shout Button

This example shows dual compatibility: Make an extension that is compatible with both JupyterLab and Jupyter Notebook by using optional features. Adds a shout button to the right sidebar, and if running in JupyterLab, also adds a status bar widget. This example is part of the Extension Compatibility Guide. Read more about this example on that page.

Dual compatibility shout button

Clap Button

This example shows an alternate method for achieving dual compatibility: Make an extension that is compatible with both JupyterLab and Jupyter Notebook by exporting multiple plugins and using "required" features to select different behaviors. Adds a clap button to the top area (in JupyterLab) or the right sidebar (Jupyter Notebook). This example is part of the Extension Compatibility Guide. Read more about this example on that page.

Dual Compatibility Clap Button

Collaborative Document

Create new documents and make them collaborative.

Documents

Hello World

Set up the development environment and print to the console.

Hello World

Kernel Messaging

Interact with a kernel from an extension.

Kernel Messages

Kernel Output

Render kernel messages in an OutputArea.

OutputArea class

Launcher

Start your extension from the Launcher.

Launcher

Log Messages

Send a log message to the log console.

Log Messages

Main Menu

Add a Menu to the main app.

Main Menu

Metadata Form

Add user interface to edit cell or notebook metadata.

Metadata Form

MIME Renderer

Add a MIME renderer for mp4 content to the application.

MIME Renderer

Notifications

Emit notifications.

Notifications

React Widget

Create a React.js Widget in JupyterLab.

react-widget

Server Hello World

Create a minimal extension with backend (i.e. server) and frontend parts.

Server Hello World

Settings

Create and use new Settings for your extension.

Settings

Signals

Use Signals to allow Widgets communicate with each others.

Button with Signal

State

Use State persistence in an extension.

State

Toolbar Item

Add a new button to the notebook toolbar.

Toolbar button

Widgets

Add a new Widget element to the main window.

Custom Tab

Prerequisites

Writing an extension requires basic knowledge of JavaScript, Typescript and potentially Python.

Don't be scared of Typescript, even if you never coded in TypeScript before you touch JupyterLab you may find it easier to understand than pure JavaScript if you have a basic understanding of object oriented programming and types.

These examples are developed and tested on top of JupyterLab. You can create a conda environment to get started after cloning this repository.

conda env create && \
  conda activate jupyterlab-extension-examples

The previous command will use the environment.yml file as requirements for the environment.

Develop and Use the Examples

Build and Install all Examples at once

jlpm
jlpm build-ext
jlpm install-py
jlpm install-ext
jupyter lab

To rebuild all the extensions:

jlpm build-ext

To clean the lib folders:

jlpm clean-ext

Build and Install one Example

Go to the example directory you want to install, e.g. cd ./hello-world, and run the following commands:

touch yarn.lock
pip install -e .
jupyter labextension develop . --overwrite

Rebuild the extension:

jlpm run build

You can now start JupyterLab and check if your extension is working fine:

jupyter lab

Change the Sources

If you want to develop and iterate on the code, you will need to open 2 terminals.

In terminal 1, go to the extension folder and run the following:

jlpm watch

Then in terminal 2, start JupyterLab:

jupyter lab

From there, you can change your extension source code, it will be recompiled, and you can refresh your browser to see your changes.

We are using embedme to embed code snippets into the markdown READMEs. If you make changes to the source code, ensure you update the README and run jlpm embedme from the root of the repository to regenerate the READMEs.

Update extension template

Execute from the example root folder:

./scripts/update-template.sh

Then fix the conflicts.

Test the Examples

The examples are automatically tested for:

Install a Published Extension

Once your extension is published on pypi.org (outside of this scope), you can install it with the following command:

pip install <published_extension>

About JupyterLab

JupyterLab can be used as a platform to combine existing data-science components into a new powerful application that can be deployed remotely to many users. Some of the higher level components that can be used are text editors, terminals, notebooks, interactive widgets, filebrowser, renderers for different file formats that provide access to an enormous ecosystem of libraries from different languages.

Complementary to these examples, you can rely on the official JupyterLab documentation.

Credits

We would like to thank MMesch for initiating this work, as well as everyone else who contributed!

Community Guidelines and Code of Conduct

This examples repository is a Jupyter project and follows the Jupyter Community Guides and Code of Conduct.