Repolode
oschuett

oschuett/appmode

为 Jupyter 笔记本提供应用模式,自动运行代码并隐藏代码单元,将其呈现为网页应用。

Star
463
Fork
69
未关闭 Issue
4
最近提交
9天前

这是什么?

Appmode 是一个 Jupyter 服务端与笔记本端扩展,可以把笔记本呈现为网页应用,而不是可编辑的文档。以应用模式打开笔记本时,所有代码单元会自动执行,随后代码被隐藏,Markdown 单元变为只读,终端用户只看到输出和界面。

每个应用模式会话都会获得一份笔记本的临时副本和独立的 IPython 内核,因此同一个笔记本可以被多人同时打开而互不干扰。关闭页面后,内核会被关闭,临时副本也会被删除。当前 URL 会注入变量 jupyter_notebook_url,便于通过 URL 参数在笔记本之间传递信息。

服务端可配置受信任的笔记本路径、编辑等按钮的显示以及临时笔记本的存放目录,也可以通过 custom.js 进一步自定义界面。项目支持通过 conda 或 pip 安装,并可在 mybinder 上运行。

核心功能

  • 01将任意笔记本以应用形式打开,代码单元自动执行并隐藏。
  • 02每个应用会话拥有独立的临时笔记本副本和内核。
  • 03支持通过 /apps/foo.ipynb 形式的直接链接访问应用。
  • 04提供受信任路径和按钮显示等服务端配置项。
  • 05可通过 custom.js 自定义界面元素。

适用场景

  • 将数据分析笔记本以交互页面的形式分享给非技术用户。
  • 把基于笔记本的小工具发布出去,访客无需看到代码即可运行。
  • 在 mybinder 上托管示例笔记本,让人无需安装即可体验。

快速上手

  1. 1

    使用 pip 从 PyPI 安装

    pip install appmode
  2. 2

    启用 notebook 扩展

    jupyter nbclassic-extension enable --py --sys-prefix appmode
  3. 3

    启用服务器扩展

    jupyter server extension enable --py --sys-prefix appmode

使用前须知

  • 在较新版本的 Jupyter 中,写入隐藏的临时笔记本副本需要启用 ContentsManager.allow_hidden。

收录于专题

标签

常见问题

appmode 是什么?
为 Jupyter 笔记本提供应用模式,自动运行代码并隐藏代码单元,将其呈现为网页应用。 Appmode 是一个 Jupyter 服务端与笔记本端扩展,可以把笔记本呈现为网页应用,而不是可编辑的文档。以应用模式打开笔记本时,所有代码单元会自动执行,随后代码被隐藏,Markdown 单元变为只读,终端用户只看到输出和界面。
appmode 可以免费使用吗?用的什么许可证?
appmode 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
appmode 还在维护吗?
活跃维护中。appmode 最近一次提交是在 2026年10月29日。
appmode 适合用来做什么?
将数据分析笔记本以交互页面的形式分享给非技术用户。 把基于笔记本的小工具发布出去,访客无需看到代码即可运行。 在 mybinder 上托管示例笔记本,让人无需安装即可体验。
appmode 怎么安装和运行?
使用 pip 从 PyPI 安装: pip install appmode 启用 notebook 扩展: jupyter nbclassic-extension enable --py --sys-prefix appmode 启用服务器扩展: jupyter server extension enable --py --sys-prefix appmode
在哪里获取 appmode?
源代码和安装说明在 GitHub 上:https://github.com/oschuett/appmode

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目