实时Jupyter笔记本的渲染，带有交互式小部件。

简介

Voilà可以将Jupyter笔记本转换为独立网络应用程序。

与通常的HTML转换笔记本不同，每个连接到Voilà tornado应用程序的用户都获得一个专用的Jupyter内核，该内核可以执行Jupyter交互式小部件的更改回调。

• 默认情况下，Voilà不允许从前端执行请求，防止执行任意代码。
• 默认情况下，Voilà使用strip_source选项，该选项会从渲染的笔记本中删除输入单元。

安装

Voilà可以使用conda-forge的mamba（或conda）包管理器安装

mamba install -c conda-forge voila

或从PyPI安装

pip install voila

JupyterLab预览扩展

Voilà提供JupyterLab扩展，可以在侧边栏中显示笔记本的Voilà预览。

从JupyterLab 3.0开始，在安装voila（使用pip install voila）后，该扩展会自动安装。

如果您想从源安装扩展，请运行以下命令。

jupyter labextension install @voila-dashboards/jupyterlab-preview

使用方法

作为独立的tornado应用程序

要将bqplot示例笔记本渲染为独立应用程序，请运行voila bqplot.ipynb。要服务笔记本目录，请不带参数运行voila。

例如，要使用Voilà渲染本存储库中的示例笔记本bqplot.ipynb，您首先需要更新当前环境以满足该笔记本的要求（在这种情况下是在一个conda环境中）并使用以下命令渲染笔记本：

mamba env update -f environment.yml
cd notebooks/
voila bqplot.ipynb

有关更多命令行选项（例如，指定备用端口号），请运行voila --help。

作为notebook或jupyter_server的服务器扩展

Voilà也可以用作Jupyter服务器扩展，无论是与notebook服务器还是jupyter_server。

要安装Jupyter服务器扩展，请运行

jupyter serverextension enable voila --sys-prefix

在运行Jupyter服务器时，Voilà应用程序可通过带有voila后缀的基本URL访问。

文档

要开始使用Voilà，请查看完整文档

https://voila.jupyter.org.cn/

示例

以下两个示例展示了如何将独立的Jupyter笔记本从命令行集成转换为单独的应用程序。

渲染包含交互式小部件和丰富MIME类型渲染的笔记本

渲染利用自定义小部件库（bqplot）的笔记本

显示Voilà笔记本的源代码

如果将选项strip_sources设置为False，则可以在Voilà应用程序中显示Jupyter笔记本的源代码。

使用其他语言内核的Voilà仪表板**

Voilà基于Jupyter标准格式和协议构建，对笔记本的编程语言无关。在本例中，我们展示了一个由C++ Jupyter内核xeus-cling和xleaflet项目驱动的Voilà应用程序示例。

Voilà画廊

Voilà画廊是一个使用Voilà和Jupyter小部件构建的实时仪表板和应用程序集合。

大多数示例依赖于小部件库，如ipywidgets、ipyleaflet、ipyvolume、bqplot和ipympl，并展示了如何完全基于笔记本构建复杂Web应用程序。

可以通过遵循voila-gallery/gallery存储库中列出的步骤将新示例添加到画廊中。

开发

有关如何贡献和设置开发环境的说明，请参阅CONTRIBUTING.md。

相关项目

Voilà依赖于nbconvert和jupyter_server。

许可证

我们采用共享版权模式，允许所有贡献者保留其贡献的版权。

本软件根据BSD-3-Clause许可证授权。有关详细信息，请参阅LICENSE文件。