Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 2 months 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-03-27T01:22:53.000Z (3 months ago)
- Last Synced: 2024-04-14T03:11:26.731Z (3 months ago)
- Topics: data-science, dataviz, jupyter, jupyterlab, jupyterlab-extension, machine-learning, notebook
- Language: Python
- Homepage:
- Size: 1.86 MB
- Stars: 372
- Watchers: 16
- Forks: 65
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md
- Authors: AUTHORS
Lists
- awesome-jupyter - jupyterlab_templates - Notebook templates in JupyterLab. (JupyterLab Extensions)
- best-of-jupyter - GitHub - 9% open · ⏱️ 01.06.2024): (JupyterLab Extensions)
README
Support for jupyter notebook templates in jupyterlab
[](https://github.com/finos/jupyterlab_templates/actions?query=workflow%3A%22Build+Status%22)
[](https://codecov.io/gh/finos/jupyterlab_templates)
[](https://pypi.python.org/pypi/jupyterlab_templates)
[](https://pypi.python.org/pypi/jupyterlab_templates)
[](https://www.npmjs.com/package/jupyterlab_templates)
[](https://community.finos.org/docs/governance/software-projects/stages/active/)
[](https://mybinder.org/v2/gh/finos/jupyterlab_templates/main?urlpath=lab)
## 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.