Appmode

将笔记本转换为Web应用程序的Jupyter扩展。

尝试在线体验

点击binder徽章，无需安装即可在线尝试。这将直接带您进入笔记本的“应用程序”版本。

安装

如果您使用conda，可以按照以下方式安装：

conda install --channel conda-forge appmode

如果您使用pip，可以按照以下方式安装：

pip install appmode
jupyter nbextension     enable --py --sys-prefix appmode
jupyter serverextension enable --py --sys-prefix appmode

如果您想使用mybinder，请将以下environment.yml文件添加到您的仓库：

channels:
  - conda-forge
dependencies:
  - appmode

描述

Appmode由服务器端和Jupyter笔记本扩展组成。这两个扩展一起提供以下功能

• 可以通过点击工具栏中的“Appmode”按钮在任何Appmode中查看任何笔记本。或者，可以将URL从baseurl/notebooks/foo.ipynb更改为baseurl/apps/foo.ipynb。这还允许直接链接到Appmode。

• 当在Appmode中打开笔记本时，所有代码单元都会自动执行。为了呈现干净的UI，所有代码单元都被隐藏，Markdown单元为只读。

• 在appmode模式下，笔记本可以多次打开而不互相干扰。这是通过为每个活动的appmode视图创建笔记本的临时副本来实现的。每个appmode视图都有其专用的ipython内核。当appmode页面关闭时，内核将关闭，临时副本将被删除。

• 为了允许通过URL参数在笔记本之间传递信息，当前URL被注入到变量jupyter_notebook_url中。

服务器端配置

Appmode添加了以下配置选项

• Appmode.trusted_path 在Appmode中只运行此路径下的笔记本。默认：无限制。
• Appmode.show_edit_button 在Appmode期间显示编辑应用按钮。默认：True。
• Appmode.show_other_buttons 在Appmode期间显示其他按钮，例如注销。默认：True。

客户端定制

可以通过custom.js文件定制Appmode的UI元素。一些示例包括

$('#appmode-leave').hide();                          // Hides the edit app button.
$('#appmode-busy').hide();                           // Hides the kernel busy indicator.
$('#appmode-loader').append('<h2>Loading...</h2>');  // Adds a loading message.

请注意，隐藏编辑按钮并不能阻止用户通过手动更改URL来离开Appmode。

开发

使用包含的Dockerfile，可以快速创建开发环境

1. 安装Docker。
2. 克隆此存储库
3. docker build --tag appmode_dev ./
4. docker run --init -ti -p8888:8888 appmode_dev
5. 浏览到http://localhost:8888/apps/example_app.ipynb