Skip to main content

A JupyterLab extension to opt in to using MutableAI

Project description

jupyterlab_mutableai_optin

Github Actions Status

A JupyterLab extension to opt in to using MutableAI

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_mutableai_optin

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_mutableai_optin 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 run 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 run 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 run 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

Uninstall

pip uninstall jupyterlab_mutableai_optin

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_mutableai_optin-0.1.0.tar.gz (171.3 kB view details)

Uploaded Source

Built Distribution

jupyterlab_mutableai_optin-0.1.0-py3-none-any.whl (174.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterlab_mutableai_optin-0.1.0.tar.gz
Algorithm Hash digest
SHA256 757205c0d49af0196a270bf75e6a66f9ef26daa0cf9df282e52c2adc6428758d
MD5 caee15881fdd68d19115245c94ef8521
BLAKE2b-256 59cb04231ee8a11b9fb1982589abcbaa6e6849e1152edaf493b26cfb1e99242b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_mutableai_optin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d26cd4f0a2be370dd7fc21b8f252157abaad326f5fd9c7b471ce29a510db7613
MD5 e5c8d944cbe797a1b7f38c46fc3e48bf
BLAKE2b-256 c5578b1313e3a6fadbcd1d917361cce805d34c82b85055ddd8e8e44f46e4c562

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