jupyterlab-snippets

Snippets Extension for JupyterLab.

This extension is composed of a Python package named jupyterlab-snippets for the server extension and a NPM package named jupyterlab-snippets for the frontend extension.

Requirements

JupyterLab >= 2.0
Node.js

Install

Using conda:

conda install -c conda-forge jupyterlab-snippets

Using pip:

pip install jupyterlab-snippets

Rebuild JupyterLab:

jupyter lab build

Usage

Add snippets in [jupyter_data_dir]/snippets (see: https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html#id2)

To find the Jupyter data directory, run:

$ jupyter --path

This will for example show the following list on macOS:

config:
    /Users/<username>/.jupyter
    ...
data:
    /Users/<username>/Library/Jupyter
    /Users/<username>/miniconda3/envs/<envname>/share/jupyter
    ...
runtime:
    ...

Use the first directory listed under data: to add files to, these become snippets in the menu. Each file contains one snippet. Directories can be used to organize the snippet files and will become submenu's in the menu.

In JupyterLab, use the "Snippets" menu to select the snippet:

Convert snippets from jupyter-boilerplate format

See jupyter-boilerplate-converter on how to convert snippets from the jupyter-boilerplate classic notebook extension (not available for JupyterLab) to jupyterlab-snippets.

Troubleshoot

If you are seeing the frontend extension but it is not working, check that the server extension is enabled:

jupyter serverextension list

If the server extension is installed and enabled but you are not seeing the frontend, check the frontend extension is installed and enabled:

jupyter labextension list

If it is installed, try:

jupyter lab clean
jupyter lab build

Contributing

Development Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Move to jupyterlab-snippets directory
# Install the server extension
pip install -e .

# Register the server extension
jupyter serverextension enable --py jupyterlab-snippets

# Install the dependencies
jlpm

# Build the TypeScript source
jlpm build

# Link your development version of the extension with JupyterLab
jupyter labextension link .

# Rebuild the TypeScript source after making changes
jlpm build

# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch

# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Uninstall

pip uninstall jupyterlab-snippets
jupyter labextension uninstall jupyterlab-snippets

fagan2888 / jupyterlab-snippets Goto Github PK