GitHub - CDAT/jupyterlab-tutorial (original) (raw)

jupyterlab-tutorial

A package which provides a tutorial manager for incorporating interactive tutorials within JupyterLab. Front-end components provided by React Joyride: https://github.com/gilbarbara/react-joyride

Prerequisites

Installation

jupyter labextension install jupyterlab-tutorial

Development

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

npm install npm run build jupyter labextension link .

To rebuild the package and the JupyterLab app:

npm run build jupyter lab build

Steps to test npm package without publishing (MacOS):

  1. Go to the package repository/directory
  2. Prepare the tar package with npm
  3. Copy the package to home directory for simplicity

cp jupyterlab-tutorial-.tgz ~ #Copy the package to the cache folder too if testing in JupyterLab: cp jupyterlab-tutorial-extension-.tgz ~/Library/Caches

  1. Go to the project directory where the package is needed for testing

cd <project/where/you/need/package>

  1. Install the package using the home directory
npm install ~/jupyterlab-tutorial-<version>.tgz