https://github.com/agoose77/jupyterlab-log-renderer

Mimebundle renderer for the JupyterLab log console.
https://github.com/agoose77/jupyterlab-log-renderer

display ipython jupyterlab log logger mimebundle rich

Last synced: 3 months ago
JSON representation

Mimebundle renderer for the JupyterLab log console.

• Host: GitHub
• URL: https://github.com/agoose77/jupyterlab-log-renderer
• Owner: agoose77
• License: bsd-3-clause
• Created: 2019-12-12T20:37:05.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-11T16:02:59.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T21:19:20.619Z (3 months ago)
• Topics: display, ipython, jupyterlab, log, logger, mimebundle, rich
• Language: TypeScript
• Homepage:
• Size: 3.84 MB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jupyterlab_log_renderer

[![pypi-badge][]][pypi] ![ci-badge][]

[pypi-badge]: https://img.shields.io/pypi/v/jupyterlab-log-renderer

[pypi]: https://pypi.org/project/jupyterlab-log-renderer

[ci-badge]: https://github.com/agoose77/jupyterlab-log-renderer/actions/workflows/build.yml/badge.svg

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

## Requirements

* JupyterLab >= 3.0

## Install

```bash

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](https://yarnpkg.com/) that is installed with JupyterLab. You may use

`yarn` or `npm` in lieu of `jlpm` below.

```bash

# 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.

```bash

# 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).

### Uninstall

```bash

pip uninstall jupyterlab_log_renderer

jupyter labextension uninstall @agoose77/jupyterlab_log_renderer

```