Skip to main content

A JupyterLab extension.

Project description

jupyterlab_telemetry_system

Github Actions Status A JupyterLab extension.

This extension is composed of a Python package named jupyterlab_telemetry_system for the server extension and a NPM package named jupyterlab-telemetry-system for the frontend extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_telemetry_system

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_telemetry_system

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

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_telemetry_system directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_telemetry_system
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_telemetry_system
pip uninstall jupyterlab_telemetry_system

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-telemetry-system 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_telemetry_system-0.1.1.tar.gz (99.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_telemetry_system-0.1.1.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_telemetry_system-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fb7e290fbb94b1869aa61b901588a76c6c754f0a934df2f9c423a3b3c96e0dea
MD5 e0be49e24fb37273112a547224e72738
BLAKE2b-256 1bddaac8fb76fd8910db3603166fc978ac9ab9979e07ed7cb4c3b24105a82f25

See more details on using hashes here.

File details

Details for the file jupyterlab_telemetry_system-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_telemetry_system-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a57cbdcbd06ac69f0896eccfdd6d1c8cdb346c7a835c074527f5b75d390c95a
MD5 f0ce67aaf307371a232e3d2141733ba6
BLAKE2b-256 1a960e9387036faa8214b7752f7dd65cb8bd9adc5bdf55af536d056bafcfa6cf

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