Skip to main content

A server extension for JupyterLab to handle ROS packages

Project description

jupyter-rospkg

Github Actions Status A server extension for JupyterLab to handle ROS packages

This extension is composed of a Python package named jupyter_rospkg for the server extension.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyter_rospkg

Uninstall

To remove the extension, execute:

pip uninstall jupyter_rospkg

Troubleshoot

If it is not working, check that the server extension is enabled:

jupyter server extension list

Contributing

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 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

Development uninstall

# 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.

Testing the extension

Server tests

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

Packaging the extension

See RELEASE

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

jupyter_rospkg-0.3.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

jupyter_rospkg-0.3.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_rospkg-0.3.0.tar.gz.

File metadata

  • Download URL: jupyter_rospkg-0.3.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for jupyter_rospkg-0.3.0.tar.gz
Algorithm Hash digest
SHA256 53b3cbc05095676d8ba2a4a321e7fb7c1f7b0c5c6b580259bcc597bb320d28b5
MD5 ac11e5693c1743810eb049ca60d78f0c
BLAKE2b-256 27e1f9214feeb438e7034165616489617551c45ad56f14397b88bb8998fc2e12

See more details on using hashes here.

File details

Details for the file jupyter_rospkg-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_rospkg-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9368b8aebca92dd96ef6acc09ac780df7cb5f5fcbd75069cfd3cd6ca9e016f4b
MD5 a0d7d5e403284082ecd473ca8502ed1e
BLAKE2b-256 acdbf73aa2c39766366a394fed0768e425b9bd8fa9c1e652b8de493139145a77

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page