marimo0.14.2
Published
A library for making reactive notebooks and apps
pip install marimo
Package Downloads
Authors
Project URLs
Requires Python
>=3.9
Dependencies
- click
<9,>=8.0 - docutils
>=0.16.0 - itsdangerous
>=2.0.0 - jedi
>=0.18.0 - loro
>=1.5.0; python_version >= "3.11" - markdown
<4,>=3.4 - narwhals
>=1.12.0 - packaging
- psutil
>=5.0 - pygments
<3,>=2.13 - pymdown-extensions
<11,>=10.11.2 - pyyaml
>=6.0 - starlette
!=0.36.0,>=0.26.1 - tomlkit
>=0.12.0 - typing-extensions
>=4.4.0; python_version < "3.11" - uvicorn
>=0.22.0 - websockets
>=10.0.0 - black
~=23.12.1; extra == "dev" - click
<9,>=8.0; extra == "dev" - duckdb
>=1.0.0; extra == "dev" - openai
>=1.55.3; extra == "dev" - opentelemetry-api
~=1.26.0; extra == "dev" - opentelemetry-sdk
~=1.26.0; extra == "dev" - ruff
~=0.9.1; extra == "dev" - sqlglot
>=23.4; extra == "dev" - cairosvg
>=2.7.1; extra == "docs" - mdx-include
>=1.4.2; extra == "docs" - mike
>=2.0.0; extra == "docs" - mkdocs-autorefs
>=1.2.0; extra == "docs" - mkdocs-click
>=0.8.1; extra == "docs" - mkdocs-git-revision-date-localized-plugin
>=1.3.0; extra == "docs" - mkdocs-glightbox
>=0.4.0; extra == "docs" - mkdocs-macros-plugin
>=1.3.7; extra == "docs" - mkdocs-material-extensions
>=1.3.1; extra == "docs" - mkdocs-material
>=9.5.49; extra == "docs" - mkdocs-minify-plugin
>=0.8.0; extra == "docs" - mkdocs-redirects
>=1.2.2; extra == "docs" - mkdocs
>=1.6.1; extra == "docs" - mkdocstrings
[python]>=0.27.0; extra == "docs" - pillow
>=10.2.0; extra == "docs" - pymdown-extensions
>=10.7; extra == "docs" - python-lsp-ruff
>=2.0.0; extra == "lsp" - python-lsp-server
>=1.10.0; extra == "lsp" - altair
>=5.4.0; extra == "recommended" - duckdb
>=1.0.0; extra == "recommended" - nbformat
>=5.7.0; extra == "recommended" - openai
>=1.55.3; extra == "recommended" - polars
[pyarrow]>=1.9.0; extra == "recommended" - ruff
; extra == "recommended" - sqlglot
>=23.4; extra == "recommended" - duckdb
>=1.0.0; extra == "sql" - polars
[pyarrow]>=1.9.0; extra == "sql" - sqlglot
>=23.4; extra == "sql"
A reactive Python notebook that's reproducible, git-friendly, and deployable as scripts or apps.
Docs · Discord · Examples · Gallery · YouTube
English | 简体中文 | 日本語 | Español
marimo is a reactive Python notebook: run a cell or interact with a UI element, and marimo automatically runs dependent cells (or marks them as stale), keeping code and outputs consistent. marimo notebooks are stored as pure Python (with first-class SQL support), executable as scripts, and deployable as apps.
Highlights.
- 🚀 batteries-included: replaces
jupyter,streamlit,jupytext,ipywidgets,papermill, and more - ⚡️ reactive: run a cell, and marimo reactively runs all dependent cells or marks them as stale
- 🖐️ interactive: bind sliders, tables, plots, and more to Python — no callbacks required
- 🐍 git-friendly: stored as
.pyfiles - 🛢️ designed for data: query dataframes, databases, warehouses, or lakehouses with SQL, filter and search dataframes
- 🤖 AI-native: generate cells with AI tailored for data work
- 🔬 reproducible: no hidden state, deterministic execution, built-in package management
- 🏃 executable: execute as a Python script, parameterized by CLI args
- 🛜 shareable: deploy as an interactive web app or slides, run in the browser via WASM
- 🧩 reusable: import functions and classes from one notebook to another
- 🧪 testable: run pytest on notebooks
- ⌨️ a modern editor: GitHub Copilot, AI assistants, vim keybindings, variable explorer, and more
pip install marimo && marimo tutorial intro
Try marimo at our online playground, which runs entirely in the browser!
Jump to the quickstart for a primer on our CLI.
A reactive programming environment
marimo guarantees your notebook code, outputs, and program state are consistent. This solves many problems associated with traditional notebooks like Jupyter.
A reactive programming environment. Run a cell and marimo reacts by automatically running the cells that reference its variables, eliminating the error-prone task of manually re-running cells. Delete a cell and marimo scrubs its variables from program memory, eliminating hidden state.
Compatible with expensive notebooks. marimo lets you configure the runtime to be lazy, marking affected cells as stale instead of automatically running them. This gives you guarantees on program state while preventing accidental execution of expensive cells.
Synchronized UI elements. Interact with UI elements like sliders, dropdowns, dataframe transformers, and chat interfaces, and the cells that use them are automatically re-run with their latest values.
Interactive dataframes. Page through, search, filter, and sort millions of rows blazingly fast, no code required.
Generate cells with data-aware AI. Generate code with an AI assistant that is highly specialized for working with data, with context about your variables in memory; zero-shot entire notebooks. Customize the system prompt, bring your own API keys, or use local models.
Query data with SQL. Build SQL queries that depend on Python values and execute them against dataframes, databases, lakehouses, CSVs, Google Sheets, or anything else using our built-in SQL engine, which returns the result as a Python dataframe.
Your notebooks are still pure Python, even if they use SQL.
Dynamic markdown. Use markdown parametrized by Python variables to tell dynamic stories that depend on Python data.
Built-in package management. marimo has built-in support for all major package managers, letting you install packages on import. marimo can even serialize package requirements in notebook files, and auto install them in isolated venv sandboxes.
Deterministic execution order. Notebooks are executed in a deterministic order, based on variable references instead of cells' positions on the page. Organize your notebooks to best fit the stories you'd like to tell.
Performant runtime. marimo runs only those cells that need to be run by statically analyzing your code.
Batteries-included. marimo comes with GitHub Copilot, AI assistants, Ruff code formatting, HTML export, fast code completion, a VS Code extension, an interactive dataframe viewer, and many more quality-of-life features.
Quickstart
Installation. In a terminal, run
pip install marimo # or conda install -c conda-forge marimo
marimo tutorial intro
To install with additional dependencies that unlock SQL cells, AI completion, and more, run
pip install marimo[recommended]
Create notebooks.
Create or edit notebooks with
marimo edit
Run apps. Run your notebook as a web app, with Python code hidden and uneditable:
marimo run your_notebook.py
Execute as scripts. Execute a notebook as a script at the command line:
python your_notebook.py
Automatically convert Jupyter notebooks. Automatically convert Jupyter notebooks to marimo notebooks with the CLI
marimo convert your_notebook.ipynb > your_notebook.py
or use our web interface.
Tutorials. List all tutorials:
marimo tutorial --help
Questions?
See the FAQ at our docs.
Learn more
marimo is easy to get started with, with lots of room for power users. For example, here's an embedding visualizer made in marimo (video):
Check out our docs, usage examples, and our gallery to learn more.
|
|
|
|
| Tutorial | Inputs | Plots | Layout |
|
|
|
|
Contributing
We appreciate all contributions! You don't need to be an expert to help out. Please see CONTRIBUTING.md for more details on how to get started.
Questions? Reach out to us on Discord.
Community
We're building a community. Come hang out with us!
- 🌟 Star us on GitHub
- 💬 Chat with us on Discord
- 📧 Subscribe to our Newsletter
- ☁️ Join our Cloud Waitlist
- ✏️ Start a GitHub Discussion
- 🦋 Follow us on Bluesky
- 🐦 Follow us on Twitter
- 🎥 Subscribe on YouTube
- 🕴️ Follow us on LinkedIn
A NumFOCUS affiliated project. marimo is a core part of the broader Python ecosystem and is a member of the NumFOCUS community, which includes projects such as NumPy, SciPy, and Matplotlib.
Inspiration ✨
marimo is a reinvention of the Python notebook as a reproducible, interactive, and shareable Python program, instead of an error-prone JSON scratchpad.
We believe that the tools we use shape the way we think — better tools, for better minds. With marimo, we hope to provide the Python community with a better programming environment to do research and communicate it; to experiment with code and share it; to learn computational science and teach it.
Our inspiration comes from many places and projects, especially Pluto.jl, ObservableHQ, and Bret Victor's essays. marimo is part of a greater movement toward reactive dataflow programming. From IPyflow, streamlit, TensorFlow, PyTorch, JAX, and React, the ideas of functional, declarative, and reactive programming are transforming a broad range of tools for the better.
