Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyterlab/extension-template
A `copier` template for JupyterLab extensions
https://github.com/jupyterlab/extension-template
copier-template jupyterlab jupyterlab-extension template
Last synced: 2 months ago
JSON representation
A `copier` template for JupyterLab extensions
- Host: GitHub
- URL: https://github.com/jupyterlab/extension-template
- Owner: jupyterlab
- License: cc0-1.0
- Created: 2023-04-14T09:06:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-23T15:39:30.000Z (4 months ago)
- Last Synced: 2024-07-23T18:20:07.866Z (4 months ago)
- Topics: copier-template, jupyterlab, jupyterlab-extension, template
- Language: Jinja
- Homepage:
- Size: 200 KB
- Stars: 48
- Watchers: 9
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JupyterLab extension template
[](https://github.com/jupyterlab/extension-template/actions/workflows/main.yml)
A [copier](https://copier.readthedocs.io) template for creating
a JupyterLab extension. Four kinds of extension are supported:
- _frontend_: Pure frontend extension written in TypeScript.
- _mimerenderer_: MIME renderer extension.
- _server_: Extension with frontend (in TypeScript) and backend (in Python) parts.
- _theme_: Theme for JupyterLab (using CSS variables).
## Use the template to create extension
1. Install copier and some plugins.
With `pip`:
```sh
pip install "copier~=9.2" jinja2-time
```
Or with `conda` / `mamba`:
```sh
conda install -c conda-forge "copier>=9.2,<10" jinja2-time
```
2. Create an extension directory and go to it.
```sh
mkdir myextension
cd myextension
```
3. Use copier to generate an extension, following the prompts to fill all required information.
```sh
copier copy --trust https://github.com/jupyterlab/extension-template .
```
> If you are using Visual Studio Code, you may be interested in the
> [configuration template](https://github.com/jupyterlab/vscode-config-template) for JupyterLab extension.
---
If you'd like to generate an extension for a older release, use the `--vcs-ref` option and give a tag or commit from this repository.
```sh
copier copy --vcs-ref v4.0.0 --trust https://github.com/jupyterlab/extension-template .
```
> If you are looking for a template compatible with JupyterLab version prior to 4.0.0, look at
> the [cookiecutter template](https://github.com/jupyterlab/extension-cookiecutter-ts) or the
> [mimerenderer template](https://github.com/jupyterlab/mimerender-cookiecutter-ts).
## Update an extension to the latest template version
> This only works with an older version of the _copier_ template. It does not work
> with an extension generated using the cookiecutter template. In that case, you
> could try the script `python -m jupyterlab.upgrade_extension`.
Extension generated from the copier template can be [updated](https://copier.readthedocs.io/en/stable/updating/)
with a newer version of the template by executing the command:
```sh
copier update --trust
```
## 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. Have a look at the [extension examples](https://github.com/jupyterlab/extension-examples) repository for more information on various JupyterLab features.