JSPM

jupyterlab-tutorial

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q12468F
  • License BSD-3-Clause

A package which provides a tutorial manager for incorporating interactive tutorials within JupyterLab.

Package Exports

  • jupyterlab-tutorial

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jupyterlab-tutorial) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

  • JupyterLab

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
cd <package/directory>
  1. Prepare the tar package with npm
npm pack
  1. Copy the package to home directory for simplicity
cp jupyterlab-tutorial-<version>.tgz ~
#Copy the package to the cache folder too if testing in JupyterLab:
cp jupyterlab-tutorial-extension-<version>.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