Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/finos/jupyterlab_templates

Support for jupyter notebook templates in jupyterlab
https://github.com/finos/jupyterlab_templates

data-science dataviz jupyter jupyterlab jupyterlab-extension machine-learning notebook

Last synced: about 1 month ago
JSON representation

Support for jupyter notebook templates in jupyterlab

Host: GitHub
URL: https://github.com/finos/jupyterlab_templates
Owner: finos
License: apache-2.0
Created: 2018-03-17T21:38:11.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-06-01T00:47:43.000Z (7 months ago)
Last Synced: 2024-06-12T08:24:41.237Z (6 months ago)
Topics: data-science, dataviz, jupyter, jupyterlab, jupyterlab-extension, machine-learning, notebook
Language: Python
Homepage:
Size: 1.87 MB
Stars: 381
Watchers: 16
Forks: 67
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md
- Authors: AUTHORS

Awesome Lists containing this project

awesome-jupyter-resources - GitHub - 8% open · ⏱️ 25.08.2022): (JupyterLab扩展)
best-of-jupyter - GitHub - 11% open · ⏱️ 01.12.2024): (JupyterLab Extensions)

README

        

Support for jupyter notebook templates in jupyterlab

[![Build Status](https://github.com/finos/jupyterlab_templates/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/finos/jupyterlab_templates/actions?query=workflow%3A%22Build+Status%22)

[![codecov](https://codecov.io/gh/finos/jupyterlab_templates/branch/main/graph/badge.svg)](https://codecov.io/gh/finos/jupyterlab_templates)

[![PyPI](https://img.shields.io/pypi/l/jupyterlab_templates.svg)](https://pypi.python.org/pypi/jupyterlab_templates)

[![PyPI](https://img.shields.io/pypi/v/jupyterlab_templates.svg)](https://pypi.python.org/pypi/jupyterlab_templates)

[![npm](https://img.shields.io/npm/v/jupyterlab_templates.svg)](https://www.npmjs.com/package/jupyterlab_templates)

[![FINOS Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://community.finos.org/docs/governance/software-projects/stages/active/)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/finos/jupyterlab_templates/main?urlpath=lab)

![](https://raw.githubusercontent.com/finos/jupyterlab_templates/main/docs/example1.gif)

## Install

### PyPI

`jupyterlab_templates` is available on [PyPI](https://pypi.org/project/jupyterlab-templates/):

```bash

pip install jupyterlab_templates

```

### Conda

`jupyterlab_templates` is also available on [conda-forge](https://github.com/conda-forge/jupyterlab_templates-feedstock):

```bash

conda install -c conda-forge jupyterlab_templates

```

### Jupyter Server/JupyterLab Extension

```

jupyter labextension install jupyterlab_templates

jupyter server extension enable --py jupyterlab_templates

```

## Adding templates

install the server extension, and add the following to `jupyter_notebook_config.py`

```python3

c.JupyterLabTemplates.allowed_extensions = ["*.ipynb"]

c.JupyterLabTemplates.template_dirs = ['list', 'of', 'template', 'directories']

c.JupyterLabTemplates.include_default = True

c.JupyterLabTemplates.include_core_paths = True

c.JupyterLabTemplates.template_label = "Template"

```

## Templates for libraries

The extension will search *subdirectories* of each parent directory specified in `template_dirs` for templates.

**Note!** Templates in the parent directories will be ignored. You must put the templates in *subdirectories*, in order to keep everything organized.

If `include_default = True` the `notebook_templates` directory under the [jupyter data folder](https://jupyter.readthedocs.io/en/latest/use/jupyter-directories.html) is one of the default parent directories. Thus, if you have tutorials or guides you'd like to install for users, simply copy them into your jupyter data folder inside the `notebook_templates` directory, e.g. `/usr/local/share/jupyter/notebook_templates/bqplot` for `bqplot`.

If you want to exclude templates from a specific directory, please add a file `.jupyterlab_templates_ignore` to to this location.

All notebooks in this directory will be ignored (but has no effect on subdirectories).

### Flags

- `allowed_extensions`: a list of extensions to allow templates for. (optional, default `["*.ipynb"]`)

- `template_dirs`: a list of absolute directory paths. All files matching `allowed_extensions` in any *subdirectories* of these paths will be listed as templates

- `include_default`: include the default Sample template (default True)

- `include_core_paths`: include jupyter core paths (see: jupyter --paths) (default True)

- `template_label`: set label for template UI icon (default "Template")

## Development

See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.

## License

This software is licensed under the Apache 2.0 license. See the

[LICENSE](LICENSE) and [AUTHORS](AUTHORS) files for details.