craigcitro / jupyter-js-plugins

Jupyter JS Plugins

Plugins for JupyterLab. The default set of phosphide plugins used to create JupyterLab.

Package Install

Prerequisites

• node
• python

npm install --save jupyter-js-plugins
conda install notebook  # notebook 4.1+ required

Source Build

Prerequisites

• git
• node 0.12+
• python

git clone https://github.com/jupyter/jupyter-js-plugins.git
cd jupyter-js-plugins
npm install
npm run build
conda install notebook  # notebook 4.1+ required

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

npm test

Build Example

Follow the source build instructions first. Requires a Python install with the Jupyter notebook.

npm run build:example

Change to example directory and run python main.py.

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

• IE 11+
• Firefox 32+
• Chrome 38+

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.