Code Snippets Extension for JupyterLab
Snippets Extension for JupyterLab.
This extension is composed of a Python package named
for the server extension and a NPM package named
for the frontend extension.
- JupyterLab >= 2.0
pip install jupyterlab-snippets jupyter lab build
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.
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
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# 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
pip uninstall jupyterlab-snippets jupyter labextension uninstall jupyterlab-snippets
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for jupyterlab-snippets-0.3.1.tar.gz
Hashes for jupyterlab_snippets-0.3.1-py2.py3-none-any.whl