# jupyterlab-tutorial

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

Latest version **1.1.0** (published 2021-02-23) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install jupyterlab-tutorial
pnpm add jupyterlab-tutorial
yarn add jupyterlab-tutorial
bun add jupyterlab-tutorial
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-02-23 |
| First published | 2019-07-16 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 30.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Carlos Downie |
| Maintainers | doutriaux1, downie4 |
| Keywords | jupyter, jupyterlab, jupyterlab-extension |

## Links

- npm: https://www.npmjs.com/package/jupyterlab-tutorial
- Repository: https://github.com/CDAT/jupyterlab-tutorial
- Homepage: https://github.com/cdat/jupyterlab-tutorial.git
- Issues: https://github.com/cdat/jupyterlab-tutorial.git/issues
- npm.io page: https://npm.io/package/jupyterlab-tutorial

## Dependencies (3)

- [react-joyride](https://npm.io/package/react-joyride.md) ^2.3.0
- [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^3.0.5
- [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^3.0.6

## Recent versions

- 1.1.0 (latest) — 2021-02-23
- 1.0.6 — 2020-10-21
- 1.0.5 — 2020-04-17
- 1.0.4 — 2019-08-07
- 1.0.3 — 2019-07-24
- 1.0.1 — 2019-07-16
- 1.0.0 — 2019-07-16

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

```bash
jupyter labextension install jupyterlab-tutorial
```

## Development

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

```bash
npm install
npm run build
jupyter labextension link .
```

To rebuild the package and the JupyterLab app:

```bash
npm run build
jupyter lab build
```

## Steps to test npm package without publishing (MacOS):
1.  Go to the package repository/directory
```bash
cd <package/directory>
```

2. Prepare the tar package with npm
```bash
npm pack
```

3. Copy the package to home directory for simplicity
```bash
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
```

5. Go to the project directory where the package is needed for testing
```bash
cd <project/where/you/need/package>
```

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

---
_Source: https://npm.io/package/jupyterlab-tutorial · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._