Code Snippets Extension for JupyterLab.
This extension is composed of a Python package named jupyterlab-code-snippets
for the server extension and a NPM package named jupyterlab-code-snippets
for the frontend extension.
- JupyterLab >= 2.0
- Node.js
pip install jupyterlab-code-snippets
jupyter lab buildAdd snippets in [jupyter_data_dir]/code_snippets (see: https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html#id2)
In JupyterLab, use the "Code Snippets" menu to select the snippet:
If you are seeing the frontend extension but it is not working, check that the server extension is enabled:
jupyter serverextension listIf the server extension is installed and enabled but you are not seeing the frontend, check the frontend extension is installed and enabled:
jupyter labextension listIf it is installed, try:
jupyter lab clean
jupyter lab buildThe 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-code-snippets directory
# Install the server extension
pip install -e .
# Register the server extension
jupyter serverextension enable --py jupyterlab-code-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 buildYou 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 --watchpip uninstall jupyterlab-code-snippets
jupyter labextension uninstall jupyterlab-code-snippets