Cookie Cutter Extension

Cloud AI Platform Notebooks JupyterLab extension cookiecutter project for quickly generating a JupyterLab extension that follows AI Platform best practices. The extension will display a list of strings retrieved from a JupyterLab backend in a React-based side panel widget. Follow the Quick Start instructions to get JupyterLab up and running with a custom example extension installed.

Prerequisites

• Python 3.5+
• JupyterLab
• Virtualenv (Recommended for local development)
• NPM (For local development)

Quick Start

Install cookiecutter:

pip install cookiecutter

Generate a new extension from the template. Press enter at each of the prompts to accept the default value or add the --no-input flag:

cookiecutter https://github.com/gclouduniverse/jupyterlab_cookiecutter -o my_extension

Change to the generated project directory:

cd my_extension/jupyterlab_cookies # Change this to the generated project directory

To build, install, and launch run:

virtualenv -p python3 venv && \
source venv/bin/activate && \
pip install . && \
npm install && \
npm run build && \
jupyter labextension install . --no-build && \
jupyter lab build && \
npm start