Skip to content

rahulpshah/jupyterlab_templates

 
 

Repository files navigation

jupyterlab_templates

Support for jupyter notebook templates in jupyterlab

Build Status GitHub issues Coverage PyPI PyPI npm

Install

pip install jupyterlab_templates
jupyter labextension install jupyterlab_templates
jupyter serverextension enable --py jupyterlab_templates

Adding templates

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

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

Templates for libraries

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

The notebook_templates directory under the jupyter data folder is one of the default parent directory. 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.

Flags

  • template_dirs: a list of absolute directory paths. All .ipynb files 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)

Development

See CONTRIBUTING.md for guidelines.

License

This software is licensed under the Apache 2.0 license. See the LICENSE and AUTHORS files for details.

About

Support for jupyter notebook templates in jupyterlab

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 73.1%
  • Python 12.2%
  • JavaScript 9.2%
  • Jupyter Notebook 2.9%
  • Makefile 2.6%