https://github.com/gclouduniverse/jupyterlab_cookiecutter

Cloud AI Platform Notebooks JupyterLab extension cookie cutter project
https://github.com/gclouduniverse/jupyterlab_cookiecutter

Last synced: 5 days ago
JSON representation

Cloud AI Platform Notebooks JupyterLab extension cookie cutter project

• Host: GitHub
• URL: https://github.com/gclouduniverse/jupyterlab_cookiecutter
• Owner: gclouduniverse
• Created: 2020-04-17T20:17:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T11:00:55.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T15:16:27.098Z (7 months ago)
• Language: Python
• Size: 1.44 MB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)

* [Virtualenv](https://virtualenv.pypa.io/en/latest/) (Recommended for local development)

* [NPM](https://nodejs.org/en/) (For local development)

## Quick Start

Install [cookiecutter](https://pypi.org/project/cookiecutter/):

```bash

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:

```bash

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

```

Change to the generated project directory:

```bash

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

```

To build, install, and launch run:

```bash

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

```