Skip to main content

A JupyterLab extension for Appmode.

Project description

appmode-jupyterlab

Github Actions Status

A JupyterLab extension for Appmode (https://github.com/oschuett/appmode). This extension is created from the modification of the voila JupyterLab extension code (https://github.com/voila-dashboards/voila).

Requirements

  • JupyterLab >= 4.0

Install

pip install appmode-jupyterlab

Contributing

Install

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
# Move to appmode-jupyterlab directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

jupyter labextension uninstall @osscar/appmode-jupyterlab

Acknowledgements

We acknowledge support from the EPFL Open Science Fund via the OSSCAR project.

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

appmode_jupyterlab-1.0.0.tar.gz (132.2 kB view details)

Uploaded Source

Built Distribution

appmode_jupyterlab-1.0.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file appmode_jupyterlab-1.0.0.tar.gz.

File metadata

  • Download URL: appmode_jupyterlab-1.0.0.tar.gz
  • Upload date:
  • Size: 132.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for appmode_jupyterlab-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bf85c6b3b5c3d8dcceb89cab18b734c2ed53a7ef769898e0d6b56350e5adf4cb
MD5 647d3da638030e89f66b73e0298d18aa
BLAKE2b-256 dceb9c59d19e3d95aa06a227d4b3c093c4bc4c4a16471fba8b46757f3b1a2563

See more details on using hashes here.

File details

Details for the file appmode_jupyterlab-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for appmode_jupyterlab-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17b50fdd152d116aad2d8c45d70eb145a4a1e307607a8c2233e2e7935dfd67c0
MD5 424c9a09dc231de9dede339fbd4c31eb
BLAKE2b-256 3db0f787b72acca5f3f94893b7063c10456697045cbb8296fb0f3a7fa3e5e250

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