marimo-team/marimo

一款响应式的 Python notebook，具有可重现性、对 git 友好，并可部署为脚本或应用。

文档 · Discord · 示例 · 画廊 · YouTube

English | 繁體中文 | 简体中文 | 日本語 | Español

**marimo** 是一款响应式的 Python notebook：运行一个单元格或与 UI 元素交互，marimo 会自动运行依赖单元格（或 将其标记为过时），从而保持代码和输出的一致性。marimo notebook 以纯 Python 形式存储（提供一流的 SQL 支持），可作为脚本执行，并可部署为应用。 **亮点**。 - 🚀 **功能齐备：** 替代 `jupyter`、`streamlit`、`jupytext`、`ipywidgets`、`papermill` 等工具 - ⚡️ **响应式：** 运行一个单元格，marimo 会响应式地 [运行所有依赖单元格](https://docs.marimo.io/guides/reactivity.html) 或 将其标记为过时 - 🖐️ **交互式：** 将 [滑块、表格、绘图等](https://docs.marimo.io/guides/interactivity.html) 绑定到 Python —— 无需回调函数 - 🐍 **git 友好：** 以 `.py` 文件存储 - 🛢️ **为数据而设计：** [使用 SQL](https://docs.marimo.io/guides/working_with_data/sql.html) 查询 dataframe、数据库、数据仓库或湖仓，筛选和搜索 [dataframe](https://docs.marimo.io/guides/working_with_data/dataframes.html) - 🤖 **AI 原生：** [将 Claude Code 等 agent CLI](https://docs.marimo.io/guides/generate_with_ai/marimo_pair/) 连接到 notebook，或使用我们编辑器的 [内置 AI 功能](https://docs.marimo.io/guides/editor_features/ai_completion/) - 🔬 **可重现：** [无隐藏状态](https://docs.marimo.io/guides/reactivity.html#no-hidden-state)，确定性执行，[内置包管理](https://docs.marimo.io/guides/package_management/) - 🏃 **可执行：** [作为 Python 脚本执行](https://docs.marimo.io/guides/scripts.html)，可通过 CLI 参数进行参数化 - 🛜 **可共享：** [部署为交互式 Web 应用](https://docs.marimo.io/guides/apps.html) 或 [幻灯片](https://docs.marimo.io/guides/apps.html#slides-layout)，[通过 WASM 在浏览器中运行](https://docs.marimo.io/guides/wasm.html) - 🧩 **可复用：** [从一个 notebook 导入函数和类](https://docs.marimo.io/guides/reusing_functions/) 到另一个 notebook - 🧪 **可测试：** [对 notebook 运行 pytest](https://docs.marimo.io/guides/testing/) - ⌨️ **现代化编辑器：** [GitHub Copilot](https://docs.marimo.io/guides/editor_features/ai_completion.html#github-copilot)、[AI 助手](https://docs.marimo.io/guides/editor_features/ai_completion.html)、vim 按键绑定、变量浏览器，以及 [更多](https://docs.marimo.io/guides/editor_features/index.html) - 🧑‍💻 **使用您喜爱的编辑器：** 在 [VS Code 或 Cursor](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo) 中运行，或在 neovim、Zed、[或任何其他文本编辑器](https://docs.marimo.io/guides/editor_features/watching/) 中编辑 ``` pip install marimo && marimo tutorial intro ``` _立即通过我们的免费在线 notebook [**mo**lab](https://molab.marimo.io/notebooks) 开始使用。或跳转到 [快速入门](#quickstart) 了解我们的 CLI 基础知识。_ ## 响应式编程环境 marimo 保证您的 notebook 代码、输出和程序状态是一致的。这 [解决了许多](https://docs.marimo.io/faq.html#faq-problems) 与 Jupyter 等传统 notebook 相关的问题。 **一个响应式编程环境。** 运行一个单元格，marimo 会通过自动运行引用其变量的单元格来做出_反应_，从而消除手动重新运行单元格这一易错的任务。删除一个单元格，marimo 会从程序内存中清除其变量，从而消除隐藏状态。 **兼容昂贵 notebook。** marimo 允许您 [将运行时配置为惰性](https://docs.marimo.io/guides/configuration/runtime_configuration.html)，将受影响的单元格标记为过时，而不是自动运行它们。这既保证了程序状态，又防止了意外执行昂贵的单元格。 **同步的 UI 元素。** 与 [UI 元素](https://docs.marimo.io/guides/interactivity.html)（如 [滑块](https://docs.marimo.io/api/inputs/slider.html#slider)、[下拉菜单](https://docs.marimo.io/api/inputs/dropdown.html)、[dataframe 转换器](https://docs.marimo.io/api/inputs/dataframe.html) 和 [聊天界面](https://docs.marimo.io/api/inputs/chat.html)）交互，使用它们的单元格会自动使用最新值重新运行。 **交互式 dataframe。** [浏览、搜索、筛选和排序](https://docs.marimo.io/guides/working_with_data/dataframes.html) 数百万行数据，速度极快，无需编写代码。 **通过数据感知 AI 生成单元格。** 使用您喜爱的 agent（如 Claude Code、Codex 或 OpenCode）通过 [marimo pair](https://docs.marimo.io/guides/generate_with_ai/marimo_pair/) 在 marimo notebook 上协作。或者，在 marimo 编辑器中使用 [AI 助手](https://docs.marimo.io/guides/editor_features/ai_completion/) 生成代码，该助手专门针对数据处理进行了优化，并了解内存中变量的上下文。自定义系统提示词，自带 API 密钥，或使用本地模型。 **使用 SQL 查询数据。** 构建依赖 Python 值的 [SQL](https://docs.marimo.io/guides/working_with_data/sql.html) 查询，并使用我们内置的 SQL 引擎将其针对 dataframe、数据库、湖仓、CSV、Google Sheets 或任何其他数据源执行，该引擎将结果作为 Python dataframe 返回。 即使您的 notebook 使用了 SQL，它们仍然是纯 Python。 **动态 markdown。** 使用由 Python 变量参数化的 markdown 来讲述依赖 Python 数据的动态故事。 **内置包管理。** marimo 内置支持所有主要包管理器，允许您 [在导入时安装包](https://docs.marimo.io/guides/editor_features/package_management.html)。marimo 甚至可以在 notebook 文件中 [序列化包需求](https://docs.marimo.io/guides/package_management/inlining_dependencies/)，并在隔离的 venv 沙箱中自动安装它们。 **确定性执行顺序。** Notebook 按确定性顺序执行，基于变量引用而非单元格在页面上的位置。组织您的 notebook 以最适合您想要讲述的故事。 **高性能运行时。** marimo 通过静态分析您的代码，仅运行那些需要运行的单元格。 **功能齐备。** marimo 附带 GitHub Copilot、AI 助手、Ruff 代码格式化、HTML 导出、快速代码补全、[VS Code 扩展](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)、交互式 dataframe 查看器，以及 [许多](https://docs.marimo.io/guides/editor_features/index.html) 提升生活质量的特性。 ## 快速入门 _我们在 [YouTube 频道](https://www.youtube.com/@marimo-team) 上的 [marimo 概念播放列表](https://www.youtube.com/watch?v=3N6lInzq5MI&list=PLNJXGo8e1XT9jP7gPbRdm1XwloZVFvLEq) 概述了许多功能。_ **安装。** 在终端中运行 ``` pip install marimo # or conda install -c conda-forge marimo marimo tutorial intro ``` 若要安装解锁 SQL 单元格、AI 补全等功能的额外依赖项，请运行 ``` pip install "marimo[recommended]" ``` **创建 notebook。** 使用以下命令创建或编辑 notebook ``` marimo edit ``` **运行应用。** 将您的 notebook 作为 Web 应用运行，此时 Python 代码被隐藏且不可编辑： ``` marimo run your_notebook.py ``` **作为脚本执行。** 在命令行中将 notebook 作为脚本执行： ``` python your_notebook.py ``` **自动转换 Jupyter notebook。** 使用 CLI 自动将 Jupyter notebook 转换为 marimo notebook ``` marimo convert your_notebook.ipynb > your_notebook.py ``` 或使用我们的 [Web 界面](https://marimo.io/convert)。 **教程。** 列出所有教程： ``` marimo tutorial --help ``` **共享基于云的 notebook。** 使用 [molab](https://molab.marimo.io/notebooks)（一款类似于 Google Colab 的基于云的 marimo notebook 服务）来创建和共享 notebook 链接。 ## 有问题？ 请参阅我们文档中的 [FAQ](https://docs.marimo.io/faq.html)。 ## 了解更多 marimo 易于上手，同时也为高级用户提供了广阔的探索空间。 例如，这是一个用 marimo 制作的嵌入可视化器（[在 molab 上实时试用 notebook！](https://molab.marimo.io/notebooks/nb_jJiFFtznAy4BxkrrZA1o9b/app?show-code=true)）： 查看我们的 [文档](https://docs.marimo.io)、[使用示例](https://docs.marimo.io/examples/) 和 [画廊](https://marimo.io/gallery) 以了解更多信息。

Tutorial	Inputs	Plots	Layout

## 灵感 ✨ marimo 是对 Python notebook 的一次**重新发明**，将其作为一个可重现、可交互和可共享的 Python 程序，而不是一个容易出错的 JSON 草稿本。 我们相信，我们使用的工具塑造了我们的思维方式 —— 更好的工具，成就更好的思想。通过 marimo，我们希望为 Python 社区提供一个更好的编程环境，用于进行研究并展示成果；进行代码实验并分享成果；学习计算科学并传授知识。 我们的灵感来自许多地方和项目，特别是 [Pluto.jl](https://github.com/fonsp/Pluto.jl)、[ObservableHQ](https://observablehq.com/tutorials) 和 [Bret Victor 的文章](http://worrydream.com/)。marimo 是迈向响应式数据流编程这一更大运动的一部分。从 [IPyflow](https://github.com/ipyflow/ipyflow)、[streamlit](https://github.com/streamlit/streamlit)、[TensorFlow](https://github.com/tensorflow/tensorflow)、[PyTorch](https://github.com/pytorch/pytorch/tree/main)、[JAX](https://github.com/google/jax) 到 [React](https://github.com/facebook/react)，函数式、声明式和响应式编程的思想正在广泛地改进各种工具。

标签：AI原生, Git, Jupyter替代, Mutation, Python, SOC Prime, SQL, 代码示例, 代码编辑器, 前端, 可复现, 可视化, 响应式, 多线程, 安全可观测性, 应用程序, 开发工具, 开源, 数据分析, 数据科学, 无后门, 查询, 版本控制, 生产力工具, 科学计算, 笔记本, 系统审计, 脚本, 资源验证, 逆向工具, 部署, 防御加固