jupyterlab-s3content-version-plugin v0.0.5

s3content-version-plugin

This jupyterlab plugin allows for running (but not editing) of older versions of a notebook hosted on the s3contents backend.

Note: this plugin requires a fork of s3contents w/ version control hooks. To install this fork, add the following to your Pipfile (for pipenv users):

s3contents = {editable = true, git = "https://github.com/KitchenMate/s3contents.git", ref = "master"}

Requirements

• JupyterLab >= 1.0
• s3contents (KitchenMate fork)
• s3 bucket with versioning turned on

Install

jupyter labextension install jupyterlab-s3content-version-plugin

Contributing

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 s3content-version-plugin directory
# 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 jupyterlab-s3content-version-plugin