Metadata-Version: 2.1
Name: jupyterlab-templates
Version: 0.2.2
Summary: Notebook templates
Home-page: https://github.com/timkpaine/jupyterlab_templates
Author: Tim Paine
Author-email: t.paine154@gmail.com
License: Apache 2.0
Keywords: jupyter jupyterlab
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Jupyter
Requires-Dist: jupyterlab (>=1.0.0)
Provides-Extra: dev
Requires-Dist: autopep8 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov (>=2.6.1) ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: bumpversion ; extra == 'dev'
Requires-Dist: mock ; extra == 'dev'

# jupyterlab_templates
Support for jupyter notebook templates in jupyterlab

[![Build Status](https://travis-ci.org/timkpaine/jupyterlab_templates.svg?branch=master)](https://travis-ci.org/timkpaine/jupyterlab_templates)
[![GitHub issues](https://img.shields.io/github/issues/timkpaine/jupyterlab_templates.svg)]()
[![codecov](https://codecov.io/gh/timkpaine/jupyterlab_templates/branch/master/graph/badge.svg)](https://codecov.io/gh/timkpaine/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)

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


## Install
```bash
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`

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

## Templates for libraries
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`.

Templates will be looked for in a subdirectory of one of the `template_dirs` specified above.

### Flags
- `template_dirs`: a list of directories. all `.ipynb` files in these directories 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)


