An open API service indexing awesome lists of open source software.

https://github.com/jupyter-server/extension-cookiecutter

A Cookiecutter recipe for Jupyter Server extensions
https://github.com/jupyter-server/extension-cookiecutter

Last synced: 7 months ago
JSON representation

A Cookiecutter recipe for Jupyter Server extensions

Awesome Lists containing this project

README

          

# Jupyter Server Extension CookieCutter

[![Github Actions Status](https://github.com/jupyter-server/extension-cookiecutter/workflows/CI/badge.svg)](https://github.com/jupyter-server/extension-cookiecutter/actions/workflows/main.yml)

A [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating
a Jupyter Server extension.

## 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 Jupyter Server extension.

```
cookiecutter https://github.com/jupyter-server/extension-cookiecutter
```

## A simple example

Your new extension includes a very simple example of a working extension. Use this example as a guide to build your own extension.