Development
Install
Requirements
JupyterLab >= 4.0
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.
Copy the repo to your local environment
git clone git@github.com:jupyter-robotics/jupyterlab-urdf.git cd jupyterlab-urdf
Install package in editable 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 build
Launch JupyterLab for testing the extension
jupyter lab
Note
Troubleshooting
If you encounter the following error, install yarn=1.21
note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed
\× Encountered error while generating package metadata.
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.
# Terminal 1
jlpm watch
# Terminal 2
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
Uninstall
pip uninstall jupyterlab_urdf
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_urdf
within that folder.