Skip to main content

A JupyterLab extension to render rich-display objects to the JupyterLab log window.

Project description

jupyterlab_log_renderer

Github Actions StatusBinder

A JupyterLab extension to render rich-display objects to the JupyterLab log window.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_log_renderer

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

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_log_renderer-2.0.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

jupyterlab_log_renderer-2.0.0-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_log_renderer-2.0.0.tar.gz.

File metadata

  • Download URL: jupyterlab_log_renderer-2.0.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5

File hashes

Hashes for jupyterlab_log_renderer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 e042c74e9169e719a13a10a49757b8ffad64b2902865830855f1ee002cbee799
MD5 c6930222cbfbd84a4a1a1cf2dcc9ee44
BLAKE2b-256 d260c86db4bd76b8a6ef9d903aac2a1d75d8cf356094e5e30287920007ad77ef

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_log_renderer-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_log_renderer-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5

File hashes

Hashes for jupyterlab_log_renderer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f839ddf00a8f31622c0da45b219a54a652452398831f4a766d7f05182ac78af
MD5 181cc4fcc83bac1e25bc5e8a8e3847bf
BLAKE2b-256 4d9d4e723be50fc775f9f8014e69df138ff07ef3b4a6a61330509eb0428cbe66

See more details on using hashes here.

Provenance

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