Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic screencasts #210

Merged
merged 1 commit into from
Jun 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,11 @@ 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, disabling
the ability to execute arbitrary code.
- 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.

When using these default settings, the code powering the Jupyter notebook is
never sent to the front-end.

## Installation

Voila can be installed with the conda package manager
Expand Down Expand Up @@ -66,12 +63,22 @@ jupyter serverextension enable voila --sys-prefix
When running the notebook server, the voila app is accessible from the base url
suffixed with `voila`.

## Example
## 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](voila-basics.gif)

**Rendering a notebook making use of a custom widget library ([bqplot](https://github.com/bloomberg/bqplot)).**

![voila bqplot](voila-bqplot.gif)

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

The following screencast shows the voila-rendered version of notebook
reproducing the "wealth of nation" data visualization with bqplot.
**Showing the source code for a voila notebook.**

![wealth of nations](voila-won.gif)
![voila sources](voila-sources.gif)

## Related projects

Expand Down
Binary file added voila-basics.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added voila-bqplot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added voila-sources.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed voila-won.gif
Binary file not shown.