https://github.com/jupyterlab/extension-cookiecutter-ts
A cookiecutter recipe for JupyterLab extensions in Typescript
https://github.com/jupyterlab/extension-cookiecutter-ts
cookiecutter jupyterlab jupyterlab-extension typescript
Last synced: 8 months ago
JSON representation
A cookiecutter recipe for JupyterLab extensions in Typescript
- Host: GitHub
- URL: https://github.com/jupyterlab/extension-cookiecutter-ts
- Owner: jupyterlab
- License: bsd-3-clause
- Created: 2016-09-27T02:45:42.000Z (about 9 years ago)
- Default Branch: 4.0
- Last Pushed: 2024-09-03T21:16:14.000Z (about 1 year ago)
- Last Synced: 2025-01-11T15:41:28.881Z (9 months ago)
- Topics: cookiecutter, jupyterlab, jupyterlab-extension, typescript
- Language: CSS
- Size: 351 KB
- Stars: 183
- Watchers: 19
- Forks: 88
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JupyterLab extension-cookiecutter-ts
[](https://github.com/jupyterlab/extension-cookiecutter-ts/actions/workflows/main.yml)
⚠️ **We strongly advice to use the template next generation: https://github.com/jupyterlab/extension-template**
A [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating
a JupyterLab extension. Three kinds of extension are supported:
- _frontend_: Pure frontend extension written in TypeScript.
- _server_: Extension with frontend (in TypeScript) and backend (in Python) parts.
- _theme_: Theme for JupyterLab (using CSS variables).
> See also [extension-cookiecutter-js](https://github.com/jupyterlab/extension-cookiecutter-js)
for an extension in CommonJS.
## 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 JupyterLab extension.
```
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout 4.0
```
The available options are:
- `kind`:
* frontend --> Extension has only a frontend (TypeScript + CSS) part
* server --> Extension has frontend and backend (new Python endpoint handlers for the server) parts
* theme --> Extension provides a new theme (and nothing else)
- `author_name`: The extension author name
- `author_email`: The extension author email
- `labextension_name`: Extension name
- `python_name`: Pythonic extension name (if your extension has no server part, it will only be used to distribute the extension as a Python package)
- `project_short_description`: Extension short description
- `has_settings`: Whether the extension will have user settings or not.
- `has_binder`: Whether to set up [binder](https://mybinder.readthedocs.io/en/latest/) for the extension or not.
- `test`: Whether to add test set ups and skeletons for the extension or not
- `repository`: Version Control System repository URI
If you'd like to generate a package for a specific JupyterLab release, use the `--checkout` option and give a tag or commit from this repository.
```
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v1.0
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v2.0
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout 3.0
```
## 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.