A server extension for JupyterLab to handle ROS packages
This extension is composed of a Python package named jupyter_rospkg
for the server extension.
- JupyterLab >= 3.0
To install the extension, execute:
pip install jupyter_rospkg
To remove the extension, execute:
pip uninstall jupyter_rospkg
If it is not working, check that the server extension is enabled:
jupyter server extension list
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 jupyter_rospkg directory
# Install package in development mode
pip install -e .
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyter_rospkg
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
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyter_rospkg
pip uninstall jupyter_rospkg
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 jupyter-rospkg
within that folder.
This extension is using Pytest for Python code testing.
Install test dependencies (needed only once):
pip install -e ".[test]"
To execute them, run:
pytest -vv -r ap --cov jupyter_rospkg
See RELEASE