A cookiecutter recipe for building JupyterLab extensions.
Switch branches/tags
Nothing to show
Clone or download
jasongrout Merge pull request #21 from vidartf/patch-1
Ensure packge keyword "jupyterlab extension"
Latest commit ee1918e Feb 9, 2018


JupyterLab extension-cookiecutter-js

A cookiecutter template for creating a JupyterLab extension in CommonJS JavaScript. (See also extension-cookiecutter-ts for an extension in TypeScript.)

Use the template to create package

Install cookiecutter.

pip install cookiecutter

Use cookiecutter to generate a package, following the prompts to fill in the name and authorship of your new JupyterLab extension.

cookiecutter https://github.com/jupyterlab/extension-cookiecutter-js

A simple example

The lib/ directory of your new extension includes a very simple example of a working extension, written in JavaScript using CommonJS modules. Use this example as a guide to build your own extension.

Package name

Package name

We suggest that simple extension names start with jupyterlab_ and use underscores if needed to improve readability, such as jupyterlab_myextension.