IJavascript: A Javascript Kernel for IPython's Graphical Notebook

IJavascript is an npm package that implements a Javascript kernel for IPython's graphical notebook (also known as Jupyter). An IPython notebook combines the creation of rich-text documents (including equations, plots and videos) with the execution of code in a number of programming languages.

The execution of code is carried out by means of a kernel that implements the IPython messaging protocol. There are kernels available for Python, Julia, Ruby, Haskell and many other languages.

Main Features

• Run Javascript code within a node.js session
• Autocompletion: press TAB to complete keywords and object properties
• Object inspection: press Shift-TAB to inspect an object and show its content or, if available, its documentation
• Graphical output for HTML, PNG, ...

Installation

The instructions to install IJavascript are platform-dependent. For example, in Ubuntu 14.04, IJavascript and its prerequisites can be installed simply by running:

sudo apt-get install nodejs-legacy npm ipython ipython-notebook libzmq-dev
sudo npm install -g ijavascript

For other platforms, please, refer to the installation notes.

Usage

To start an IPython notebook session with the IJavascript kernel, run:

ijs

This command should open the IPython notebook dashboard in your default web browser:

Here's a sample notebook that makes use of the IJavascript kernel:

Please, refer to the usage notes for further details.

Documentation

Currently, the documentation is hosted on the gh-pages branch on github, you can view it here: http://n-riesco.github.io/ijavascript/

The IJavascript code is documented using jsdoc. You can build the documentation for this package with the command npm run doc. To run this command you'll need to install ipython on your system as it uses nbconvert to convert ipython notebooks to html files.

Contributions

First of all, thank you for taking the time to contribute. Please, read CONTRIBUTING and use the issue tracker for any contributions: support requests, bug reports, enhancement requests, pull requests, ...

TO DO

• Add tests
• Complete the implementation of IPython's messaging protocol v4.1
• Complete the implementation of IPython's messaging protocol v5.0
• Add tutorials