Skip to main content

Customizations for jhub-apps.

Project description

jupyterlab_jhub_apps

Github Actions Status Binder

Customizations for jhub-apps.

Plugins

  • jhub-apps:deploy-app: Adds a command to deploy an app from the currently active widget. This command is available from the main menu and context menu, as well as a toolbar icon for both files and notebooks. If there is a path associated with the currently active widget, then this is the path used for deploying the app.

Toolbar Icon (Notebook):

Toolbar Icon (File Editor):

Main Menu:

Context Menu:

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_jhub_apps

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_jhub_apps

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

pip uninstall jupyterlab_jhub_apps

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-jhub-apps within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

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

jupyterlab_jhub_apps-0.3.1.tar.gz (246.9 kB view details)

Uploaded Source

Built Distribution

jupyterlab_jhub_apps-0.3.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_jhub_apps-0.3.1.tar.gz.

File metadata

  • Download URL: jupyterlab_jhub_apps-0.3.1.tar.gz
  • Upload date:
  • Size: 246.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.6

File hashes

Hashes for jupyterlab_jhub_apps-0.3.1.tar.gz
Algorithm Hash digest
SHA256 755480361ae6804f458d6ee8e0da8c3d8166a1fd70d80b88a03e34dbcd225327
MD5 9b031c09714eea607742ccb0e21b64eb
BLAKE2b-256 0623e9ce1bb25485d0ebbab25e4425e30eb50cb3a282c1ff0406de102b0ebfbc

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_jhub_apps-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_jhub_apps-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83722d5484fbcf0eb8c45b056f496ce42e2a0a59dac4c252339242488a37d77e
MD5 8080f3a1bf2772e0d475a7f4793015a6
BLAKE2b-256 02119cae49425dbb3e89a7bb3a4d2e974711ad86baa6cc1f47c9bb4e009adced

See more details on using hashes here.

Provenance

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