Skip to main content

Roboweb JupyterLab extension

Project description

roboweb-extension

Github Actions Status

Roboweb extension

Requirements

  • JupyterLab >= 3.1

Install

pip install roboweb-extension

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

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

pip install tbump
tbump <new-version>

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

roboweb_extension-0.1.42.tar.gz (91.1 kB view details)

Uploaded Source

Built Distribution

roboweb_extension-0.1.42-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file roboweb_extension-0.1.42.tar.gz.

File metadata

  • Download URL: roboweb_extension-0.1.42.tar.gz
  • Upload date:
  • Size: 91.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for roboweb_extension-0.1.42.tar.gz
Algorithm Hash digest
SHA256 46dd2d1b7ca974bb6cf0f8aa1179ea10bae180c7e13a17203492060186d9955e
MD5 590c26139a8ae4ae3318aaf4279c08f5
BLAKE2b-256 a35f98d3daa93accf1cad69f7e7129fdddff585094c0c8825eb5494add3a0898

See more details on using hashes here.

File details

Details for the file roboweb_extension-0.1.42-py3-none-any.whl.

File metadata

File hashes

Hashes for roboweb_extension-0.1.42-py3-none-any.whl
Algorithm Hash digest
SHA256 801e5292edee9f7fa9f9cddf5d498b3d0461f7e1770951e0e49f88310ede7cb3
MD5 074ec849b8437f172749bdd1431a5514
BLAKE2b-256 b747b8023f3d56b4326e53f0b7c2fe82ab7f84248aae8a319ddb793aa1d2cf60

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