[[PageOutline(2-5,Contents,pullout)]]

= Jupyter Notebook Preview Plugin

== Description

This is a preview plugin for Jupyter Notebook (a.k.a. IPython Notebook).

It can render Jupyter Notebook files in the repository browser.

== !Bugs/Feature Requests

Existing bugs and feature requests for JupyterNotebookPlugin are 
[report:9?COMPONENT=JupyterNotebookPlugin here].

If you have any issues, create a 
[/newticket?component=JupyterNotebookPlugin new ticket].

[[TicketQuery(component=JupyterNotebookPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:jupyternotebookplugin here].

== Source

You can check out JupyterNotebookPlugin from [/svn/jupyternotebookplugin here] using Subversion, or [source:jupyternotebookplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

This plugin requires ipython, nbformat and nbconvert packages. To install them with pip:

{{{#!sh
$ pip install ipython
$ pip install nbformat
$ pip install nbconvert
}}}

Add `application/x-ipynb+json:ipynb` to `mime_map` in your trac.ini like:

{{{#!ini
[mimeviewer]
mime_map = text/x-dylan:dylan, text/x-idl:ice, text/x-ada:ads:adb, application/x-ipynb+json:ipynb
}}}


== Recent Changes

[[ChangeLog(jupyternotebookplugin, 3)]]

== !Author/Contributors

**Author:** [wiki:tkob-trac] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**