Skip to content
From Jupyter notebooks to standalone web applications and dashboards
Branch: master
Clone or download
jtpio Merge pull request #262 from jtpio/jlab-save-on-click
Save the notebook before showing the Voila preview
Latest commit 9f6b231 Jun 24, 2019

README.md

voila

Documentation Binder Join the Gitter Chat

Rendering of live Jupyter notebooks with interactive widgets.

Introduction

Voila serves live Jupyter notebook including Jupyter interactive widgets.

Unlike the usual HTML-converted notebooks, each user connecting to the Voila tornado application gets a dedicated Jupyter kernel which can execute the callbacks to changes in Jupyter interactive widgets.

  • By default, voila disallows execute requests from the front-end, preventing execution of arbitrary code.
  • By defaults, voila runs with the strip_source option, which strips out the input cells from the rendered notebook.

Installation

Voila can be installed with the conda package manager

conda install -c conda-forge voila

or from pypi

pip install voila

Usage

As a standalone tornado application

To render the bqplot example notebook as a standalone app, run

voila bqplot.ipynb

To serve a directory of jupyter notebooks, just run voila with no argument.

For more command line options (e.g., to specify an alternate port number), run voila --help.

As a server extension to notebook or jupyter_server

Voila can also be used as a notebook server extension, both with the notebook server or with jupyter_server.

To install the notebook server extension, run

jupyter serverextension enable voila --sys-prefix

When running the notebook server, the voila app is accessible from the base url suffixed with voila.

Examples

The following two examples show how a standalone Jupyter notebook can be turned into a separate app, from the command-line integration.

Rendering a notebook including interactive widgets and rich mime-type rendering voila basics

Rendering a notebook making use of a custom widget library (bqplot)

voila bqplot

Showing the source code for a voila notebook

The sources of the Jupyter notebook can be displayed in a voila app if option strip_sources is set to False.

voila sources

Voila dashboards with other language kernels

Voila is built upon Jupyter standard formats and protocols, and is agnostic to the programming language of the notebook. In this example, we present an example of a voila application powered by the C++ Jupyter kernel xeus-cling, and the xleaflet project.

voila cling

Development

See CONTRIBUTING.md to know how to contribute and setup a development environment.

Related projects

Voila depends on the nbconvert and jupyter_server.

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.

You can’t perform that action at this time.