Skip to main content

A JupyterLab extension for Elice-branded theme.

Project description

jupyterlab-elice-theme

Github Actions StatusBinder A JupyterLab extension for Elice-branded theme.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab-elice-theme

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-elice-theme

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

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

jupyterlab_elice_theme-1.1.2.tar.gz (12.1 MB view details)

Uploaded Source

Built Distribution

jupyterlab_elice_theme-1.1.2-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_elice_theme-1.1.2.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_elice_theme-1.1.2.tar.gz
Algorithm Hash digest
SHA256 be7b9e6562e6553786d36f2e6fa16d7193a5413475693427a7e385e1064b2189
MD5 3ef05edf8d1d6d47618a6134f99a891c
BLAKE2b-256 4195f5953748f9574b80a3d26e3e55fd8d76b759af8c6821fdce4761e0abceda

See more details on using hashes here.

File details

Details for the file jupyterlab_elice_theme-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_elice_theme-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2eaf643c9e29405eac5b7f97fe4bbccaac9d623e3b737931229b608899e6207a
MD5 fe7edb16f3ea043b2624ef40b398e2c9
BLAKE2b-256 902caaac6de0c6938e25ae5164a475b1b51252ba40929d8676af64890cee5041

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