GitHub - QuantStack/jupyterlab-snippets: Snippets Extension for JupyterLab (original) (raw)

jupyterlab-snippets

Github Actions Status Version Conda Version Binder

Snippets Extension for JupyterLab.

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

Requirements

Install

Using conda:

conda install -c conda-forge jupyterlab-snippets

Using pip:

pip install jupyterlab-snippets

If you use JupyterLab 2.x, you will have to rebuild JupyterLab with:

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:

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:

Schermafbeelding 2020-03-30 om 17 25 31

Convert snippets from jupyter-boilerplate format

See jupyter-boilerplate-converter on how to convert snippets from thejupyter-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

Development Install

Note: You will need NodeJS to build the extension package.

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

Clone the repo to your local environment

Change directory to the jupyterlab-snippets directory

Install package in development mode

pip install -e .

Link your development version of the extension with JupyterLab

jupyter labextension develop . --overwrite

Rebuild extension Typescript source after making changes

jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

Watch the source directory in one terminal, automatically rebuilding when needed

jlpm run watch

Run JupyterLab in another terminal

jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab-snippets