跳转到主要内容

Voilà 将 Jupyter 笔记本转换为独立网页应用

项目描述

voila

Documentation Binder Discourse Join the Gitter Chat

使用交互式小部件实时渲染Jupyter笔记本。

简介

Voilà将Jupyter笔记本转换为独立的Web应用程序。

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

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

安装

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

mamba install -c conda-forge voila

或从PyPI安装

pip install voila

JupyterLab预览扩展

Voilà提供了一个JupyterLab扩展,在侧边栏中显示笔记本的Voilà预览。

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

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

jupyter labextension install @voila-dashboards/jupyterlab-preview

用法

作为独立的tornado应用程序

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

例如,要使用Voilà从当前环境中渲染此存储库中的示例笔记本bqplot.ipynb,您可以首先使用以下命令更新笔记本的当前环境要求(在这种情况下在conda环境中)并使用以下命令渲染笔记本:

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

有关更多命令行选项(例如,指定不同的端口号),请运行voila --help

作为notebookjupyter_server的服务器扩展

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

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

jupyter serverextension enable voila
jupyter server extension enable voila

在运行Jupyter服务器时,Voilà应用程序可通过以voila后缀的基础URL访问。

文档

要开始使用Voilà,请参阅完整文档

https://voila.pythonlang.cn/

示例

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

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

Voilà basics

渲染使用自定义小部件库(bqplot)的笔记本

Voilà bqplot

显示Voilà笔记本的源代码

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

Voilà sources

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

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

Voilà cling

Voilà 画廊

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

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

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

开发

查看 CONTRIBUTING.md 了解如何贡献并设置开发环境。

相关项目

Voilà 依赖于 nbconvertjupyter_server

许可

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

本软件采用 BSD-3-Clause 许可证。有关详细信息,请参阅 LICENSE 文件。

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

voila-0.5.7.tar.gz (5.1 MB 查看哈希值)

上传时间

构建分发

voila-0.5.7-py3-none-any.whl (3.9 MB 查看哈希值)

上传时间 Python 3

支持者