一个可重复、适合git版本控制、可部署为脚本或应用的响应式Python笔记本。
marimo 是一个响应式Python笔记本:运行一个单元格或与UI元素交互时,marimo会自动运行依赖的单元格(或将其标记为过时),保持代码和输出的一致性。marimo笔记本以纯Python形式存储,可作为脚本执行,并可部署为应用程序。
主要特点:
- 响应式:运行一个单元格时,marimo会自动运行所有依赖的单元格
- 交互式:将滑块、表格、图表等绑定到Python代码 — 无需回调函数
- 可重现:无隐藏状态,确定性执行
- 可执行:作为Python脚本执行,可通过命令行参数进行参数化
- 可共享:部署为交互式Web应用,或通过WASM在浏览器中运行
- 数据中心:内置SQL支持和数据源面板
- 适合git版本控制:以 .py 文件形式存储
pip install marimo && marimo tutorial intro
在我们的在线游乐场尝试marimo,完全在浏览器中运行!
跳转到快速入门了解我们的CLI使用入门。
响应式编程环境
marimo保证您的笔记本代码、输出和程序状态保持一致。这解决了许多与传统笔记本(如Jupyter)相关的问题。
响应式编程环境。 运行一个单元格时,marimo会自动运行引用其变量的单元格,消除了手动重新运行单元格的容易出错的任务。删除一个单元格时,marimo会从程序内存中清除其变量,消除隐藏状态。
兼容计算密集型笔记本。 marimo允许您将运行时配置为惰性模式,将受影响的单元格标记为过时而不是自动运行它们。这在保证程序状态的同时,防止意外执行计算密集型单元格。
同步UI元素。 与滑块、下拉菜单和数据框转换器等UI元素交互时,使用它们的单元格会自动以最新值重新运行。
高性能运行时。 marimo通过静态分析您的代码,仅运行需要运行的单元格。
动态Markdown和SQL。 使用Markdown讲述依赖Python数据的动态故事。或构建依赖Python值的SQL查询,并使用我们内置的SQL引擎对数据框、数据库、CSV、Google表格或任何其他内容执行查询,结果以Python数据框形式返回。
即使使用Markdown或SQL,您的笔记本仍然是纯Python。
确定性执行顺序。 笔记本按照确定性顺序执行,基于变量引用而不是单元格在页面上的位置。组织您的笔记本以最适合您想讲述的故事。
功能丰富。 marimo配备了GitHub Copilot、Ruff代码格式化、HTML导出、快速代码补全、VS Code扩展、交互式数据框查看器以及许多其他便利功能。
快速入门
安装。 在终端中运行
pip install marimo # 或 conda install -c conda-forge marimo
marimo tutorial intro
或在Gitpod中运行。
点击此链接在Gitpod工作区中打开仓库:
https://gitpod.io/#https://github.com/marimo-team/marimo
创建笔记本。
使用以下命令创建或编辑笔记本:
marimo edit
运行应用。 将您的笔记本作为Web应用运行,隐藏并禁止编辑Python代码:
marimo run your_notebook.py
作为脚本执行。 在命令行中将笔记本作为脚本执行:
python your_notebook.py
自动转换Jupyter笔记本。 使用CLI自动将Jupyter笔记本转换为marimo笔记本
marimo convert your_notebook.ipynb > your_notebook.py
或使用我们的Web界面。
教程。 列出所有教程:
marimo tutorial --help
有问题?
查看我们文档中的常见问题。
了解更多
marimo易于上手,同时为高级用户提供了大量功能。 例如,这里有一个用marimo制作的嵌入可视化工具 (视频):
查看我们的文档、
examples/
文件夹和我们的画廊以了解更多信息。
贡献
我们感谢所有的贡献!您不需要成为专家就能提供帮助。 请参阅CONTRIBUTING.md以了解如何开始的更多详细信息。
有问题?请在Discord上联系我们。
社区
我们正在建立一个社区。来和我们一起交流吧!
- 🌟 在GitHub上给我们点星
- 💬 在Discord上与我们聊天
- 📧 订阅我们的新闻简报
- ☁️ 加入我们的云服务等候名单
- ✏️ 开始GitHub讨论
- 🐦 在Twitter上关注我们
- 🕴️ 在LinkedIn上关注我们
灵感 ✨
marimo是对Python笔记本的重新构想,将其打造成一个可重现、交互式和可共享的Python程序,而不是一个容易出错的JSON草稿本。
我们相信,我们使用的工具塑造了我们的思维方式——更好的工具,带来更好的思维。通过marimo,我们希望为Python社区提供一个更好的编程环境,用于进行研究并传播成果;用于试验代码并分享;用于学习和教授计算科学。
我们的灵感来自许多地方和项目,特别是Pluto.jl、ObservableHQ和Bret Victor的文章。marimo是朝着反应式数据流编程这一更广泛运动的一部分。从IPyflow、streamlit、TensorFlow、PyTorch、JAX到React,函数式、声明式和反应式编程的理念正在以更好的方式改变广泛的工具。