Skip to main content

An OpenSARLab extension that adds a Hub Control Panel button to the topbar

Project description

opensarlab_controlbtn

Github Actions Status

An extension that adds a Hub Control Panel button to the topbar that links to the start/stop server page. This will only work specifically with OpenSARLab.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install opensarlab_controlbtn

Uninstall

To remove the extension, execute:

pip uninstall opensarlab_controlbtn

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

Development uninstall

pip uninstall opensarlab_controlbtn

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 opensarlab-controlbtn within that folder.

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

opensarlab_controlbtn-1.0.1.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

opensarlab_controlbtn-1.0.1-py3-none-any.whl (83.0 kB view details)

Uploaded Python 3

File details

Details for the file opensarlab_controlbtn-1.0.1.tar.gz.

File metadata

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

File hashes

Hashes for opensarlab_controlbtn-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b9b22bf73a21918d911d4bd7d8f7f3d99bc678ddcc639a63034f50c760f68e79
MD5 1062f103672957554ec0fe3159c3bf70
BLAKE2b-256 f13e3de64926525dd43dced9697f31c14a2bb8c40d1aca65d05d518609376b43

See more details on using hashes here.

File details

Details for the file opensarlab_controlbtn-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for opensarlab_controlbtn-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3a0156edb0a53373e7cae7b6cc7724b06f3de9e79d49b718bf38ec823b3ba0be
MD5 c231cdb072657d9fdc541b1487b146c5
BLAKE2b-256 c69fa9aa53ecae0946282091672a73b31f1a69a33bf1275b150a1acbe8f6ab44

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