https://github.com/gclouduniverse/jupyter-extensions-cookiecutter

https://github.com/gclouduniverse/jupyter-extensions-cookiecutter

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/gclouduniverse/jupyter-extensions-cookiecutter
• Owner: gclouduniverse
• Created: 2020-06-15T16:39:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T21:45:55.000Z (almost 2 years ago)
• Last Synced: 2024-05-29T19:02:26.627Z (7 months ago)
• Language: TypeScript
• Size: 1.18 MB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 19
• 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+

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

## Quick Start

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

```bash

pip install cookiecutter

```

Install [pipenv](https://github.com/pypa/pipenv#installation):

```bash

pip install pipenv

```

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/jupyter-extensions-cookiecutter -o my_extension

```

Change to the generated project directory:

```bash

cd my_extension/jupyter-extensions # Change this to the generated main directory

```

To build, install, and launch run:

```bash

npm install && \

npm run bootstrap && \

pipenv shell && \

pipenv install && \

npm run link

```

Change to the generated extension directory:

```bash

cd jupyterlab_cookies # Change this to the generated extension directory

npm run install-extension

```

Return to the main directory, and start the development server:

```

cd ..

npm run devserver

```