Skip to main content

JupyterLab extension to show the js logs from the browser dev tools console

Project description

jupyterlab-js-logs

Extension status Github Actions Status lite-badge Binder

JupyterLab extension to show the console logs from the browser dev tools console.

https://github.com/user-attachments/assets/8d907bf6-8363-4b67-8431-22fca19f7d1e

Requirements

  • JupyterLab >= 2.0

Motivation

The main purpose for this extension is to provide a way to surface the console logs from the browser dev tools console in the JupyterLab interface. Especially for users that are not familiar with the browser dev tools, this extension can be very useful to debug and understand the logs generated by the JavaScript code running in the browser.

Settings

The extension exposes two settings in JupyterLab Settings Editor (JS Logs):

  • defaultLevel: default log level when opening the JS Logs panel. Default: info.
  • showLevelChangeMessages: whether to show metadata messages when log level changes. Default: false.

Install

jupyter labextension install jupyterlab-js-logs

Contributing

This extension was bootstrapped from the custom-log-console example contributed by Carlos Herrero, from the jupyterlab-extension-examples repository.

Install

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
# Move to jupyterlab-js-logs directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

jupyter labextension uninstall jupyterlab-js-logs

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_js_logs-1.2.0.tar.gz (93.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyterlab_js_logs-1.2.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_js_logs-1.2.0.tar.gz.

File metadata

  • Download URL: jupyterlab_js_logs-1.2.0.tar.gz
  • Upload date:
  • Size: 93.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyterlab_js_logs-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0eb2535cad1d1d05f051c679e36383b173dde2efc738709d173dfd1044b485bd
MD5 5e4902e4267b4263e56e4a16ea4decb4
BLAKE2b-256 486a5e9c7f22e33c1fe77b17608408d4f8de28bb79082be04512b8551cd59426

See more details on using hashes here.

File details

Details for the file jupyterlab_js_logs-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_js_logs-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7866236537718ec1dc310ae6f7640660f8dd40c9d86fca8b2672f1a7b18ab8a4
MD5 d623c9dcd01d2420c8b531f94888e8da
BLAKE2b-256 f0fec2be83736c9d0c3efbe89a371020f6cd83ffa2c5641b6d1a09be832e63c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page