/yvis

Primary LanguagePython

yvis

A JupyterLab extension for rendering application/vnd.yvis.v1+json files.

Prerequisites

  • JupyterLab 1.0 or later

Installation

pip install yvis
jupyter labextension install yvis

Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

poetry install
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# 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

Uninstall

jupyter labextension uninstall yvis