Installation#
Requirements#
JupyterLab >= 4.0.0
Install#
To install the extension, execute:
conda install -c conda-forge jupyterlab-blockly
or
pip install jupyterlab-blockly
Kernels#
ipykernel
xeus-python
xeus-lua
Uninstall#
To remove the extension, execute:
conda uninstall -c conda-forge jupyterlab-blockly
or
pip uninstall jupyterlab-blockly
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.
micromamba create -n blockly -c conda-forge python nodejs=18 yarn pre-commit jupyterla jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR ipykernel xeus-python xeus-lua
micromamba activate blockly
# Clone the repo to your local environment
# Change directory to the jupyterlab_blockly directory
# Install package in development mode
pip install -e ".[dev]"
# Installing pre-commit to run command when adding commits
pre-commit install
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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 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 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
Development uninstall#
pip uninstall jupyterlab_blockly
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list
to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyterlab-blockly
within that folder.