Skip to main content

A JupyterLab extension.

Project description

jupyterlab_keycloak_opener

Github Actions StatusBinder A JupyterLab extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_keycloak_opener

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_keycloak_opener

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

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-keycloak-opener 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_keycloak_opener-0.1.0.tar.gz (104.4 kB view details)

Uploaded Source

Built Distribution

jupyterlab_keycloak_opener-0.1.0-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterlab_keycloak_opener-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c65d0ef42a5a0a81082b94fc6893d8aa4d592c8d36a20888753e49986f1d8bdc
MD5 4c37610fb973fb3dd1ceee32a78a3f2a
BLAKE2b-256 2ad077aa56a3f166576762160447e32fc5d9a8902ea0d6187c2c85227aa2b5b9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_keycloak_opener-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d91c752da0ef4eadee8aecff85d10432b286e9a5343143b0da0125889f6eb21f
MD5 40c2af481484505b48bee52686ad00d2
BLAKE2b-256 141f111fe9bb0715eb7d45c13471d2dcbbf9a101dd7d03f7116ac9c2e1413d84

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