Skip to main content

A JupyterLab extension.

Project description

KNICS_Jupyter_frontend

Github Actions Status A JupyterLab extension.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install KNICS_Jupyter_frontend

Uninstall

To remove the extension, execute:

pip uninstall KNICS_Jupyter_frontend

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

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

knics_jupyter_frontend-0.1.0.tar.gz (203.4 kB view details)

Uploaded Source

Built Distribution

knics_jupyter_frontend-0.1.0-py3-none-any.whl (58.7 kB view details)

Uploaded Python 3

File details

Details for the file knics_jupyter_frontend-0.1.0.tar.gz.

File metadata

File hashes

Hashes for knics_jupyter_frontend-0.1.0.tar.gz
Algorithm Hash digest
SHA256 29b708299f719be488a67e2509dad497fd5ef255422204b7a9e3d46805027686
MD5 4240ee0dadf45d53c0c28fb595bb2c5b
BLAKE2b-256 e9714bd8d6b7cf477a064bf66f366e8368fe26126e62c613b8784fc5fd9c4fe1

See more details on using hashes here.

File details

Details for the file knics_jupyter_frontend-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for knics_jupyter_frontend-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25bb947872e800c4463b8c0a9083e05512ade8fa7acda72cd17e08e18c76206e
MD5 b90991e92e9fbbaec534484df445058e
BLAKE2b-256 968f671334997dd076653e912e442f483ae6c38037d071b8aa1931cbb507c5bc

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