Snippets Extension for JupyterLab
Project description
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
If you use JupyterLab 2.x, you will have to rebuild JupyterLab with:
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
Development Install
Note: You will need NodeJS to build the extension package.
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
# 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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyterlab-snippets-0.4.1.tar.gz
.
File metadata
- Download URL: jupyterlab-snippets-0.4.1.tar.gz
- Upload date:
- Size: 125.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f054bb257b31f20732702962d251924693973a410fcd887d68ec72418d0711c |
|
MD5 | 3f3e56aae52a8384ecebcd0d3606a51d |
|
BLAKE2b-256 | 67dc400d6d7e60aee792fad9f18519b078c0e28c21a1813568ff30282bb6136a |
File details
Details for the file jupyterlab_snippets-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: jupyterlab_snippets-0.4.1-py3-none-any.whl
- Upload date:
- Size: 26.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83782841dcce5af5b346d1deb84711595f27b8dd1fd57831221a87baf481084f |
|
MD5 | 3e85a9347d867da33e6f8770328d6087 |
|
BLAKE2b-256 | 9a57df8fef3289a43a68c1a0bcc2d0a2911a4726d15ecc85a10d58cd273c034e |