Skip to main content

Custom look and feel for nbhosting notebooks

Project description

jupyterlab_nbhosting

Github Actions Status Custom look and feel for nbhosting notebooks

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_nbhosting

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_nbhosting

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

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-nbhosting 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_nbhosting-0.5.5.tar.gz (713.5 kB view details)

Uploaded Source

Built Distribution

jupyterlab_nbhosting-0.5.5-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_nbhosting-0.5.5.tar.gz.

File metadata

  • Download URL: jupyterlab_nbhosting-0.5.5.tar.gz
  • Upload date:
  • Size: 713.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for jupyterlab_nbhosting-0.5.5.tar.gz
Algorithm Hash digest
SHA256 29a6c5bf20998c9c5634e542b7222df95d0e913fb24ed734ed7c5c278cc29721
MD5 c916898a19de941b6e7e1a8d95e6557f
BLAKE2b-256 00d7f7e794614fdd75a63d223bf4c7ffca17a7050fe206eb4ca5ac825c536b9b

See more details on using hashes here.

File details

Details for the file jupyterlab_nbhosting-0.5.5-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_nbhosting-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3923ab921039af7586bc22bddc186b7065feb3fecd3e0e2db84d321e09df31f3
MD5 66b1cf092a45b69afb0f2d461bca0365
BLAKE2b-256 7c04d084d01c594a6c90cf2ce31ce0c0d32f88b49938787873722baf4a972a21

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