Skip to main content

A library for making reactive notebooks and apps

Project description

A reactive Python notebook that's reproducible, git-friendly, and deployable as scripts or apps.

Docs · Discord · Examples

marimo is a reactive notebook for Python. It allows you to rapidly experiment with data and models, code with confidence in your notebook's correctness, and productionize notebooks as pipelines or interactive web apps.

Highlights.

  • reactive: run a cell, and marimo automatically updates all affected cells and outputs
  • interactive: bind sliders, tables, plots, and more to Python — no callbacks required
  • reproducible: no hidden state, deterministic execution order
  • executable: execute as a Python script
  • shareable: deploy as an app
  • git-friendly: stored as .py files
pip install marimo && marimo tutorial intro

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.

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.

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.

Synchronized UI elements. Interact with UI elements like sliders, dropdowns, and dataframe transformers, and the cells that use them are automatically re-run with their latest values.

Performant runtime. marimo runs only those cells that need to be run by statically analyzing your code. You can optionally disable expensive cells to prevent them from automatically running.

Batteries-included. marimo comes with GitHub Copilot, Black code formatting, HTML export, fast code completion, a VS Code extension, 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

Create notebooks. Create an empty notebook with

marimo edit

or create/edit a notebook with a given name with

marimo edit your_notebook.py

Run apps. Run your notebook as a web app, with Python code hidden and uneditable:

marimo run your_notebook.py

This app is deployed on marimo cloud.

Execute as scripts. marimo notebooks can be executed as scripts 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, the examples/ folder, 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!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marimo-0.1.73.tar.gz (8.4 MB view details)

Uploaded Source

Built Distribution

marimo-0.1.73-py3-none-any.whl (8.5 MB view details)

Uploaded Python 3

File details

Details for the file marimo-0.1.73.tar.gz.

File metadata

  • Download URL: marimo-0.1.73.tar.gz
  • Upload date:
  • Size: 8.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for marimo-0.1.73.tar.gz
Algorithm Hash digest
SHA256 9443e5d80861c7b86c712a632f7cb926a70cae7a0ba4f0975d446b9da61ad618
MD5 3b13f964ea2dd86eb456a238d37e4fca
BLAKE2b-256 a98e7aecf1f918eea3e0b054856d22defa6bee87c9c26ec47bafdd5b14bc3578

See more details on using hashes here.

File details

Details for the file marimo-0.1.73-py3-none-any.whl.

File metadata

  • Download URL: marimo-0.1.73-py3-none-any.whl
  • Upload date:
  • Size: 8.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for marimo-0.1.73-py3-none-any.whl
Algorithm Hash digest
SHA256 ef749ed25bba5f9cf0a5ec5f445495ad399728960230144dbe39621ec2099262
MD5 4e3e6bed4b6f74dee175d262fcd7f7d1
BLAKE2b-256 917b694ac7110568fe088e6b97e6be974009962b2aec7b5b0aa449e931894f00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page