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.
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
.pyfiles
pip install marimo && marimo tutorial intro
Jump to the quickstart for a primer on our CLI.
A reactive programming environment
A reactive programming environment. Run a cell and marimo reacts by automatically running the cells that reference its variables, giving you instant feedback as you experiment with models. Delete a cell and marimo scrubs its variables from program memory, eliminating hidden state.
Notebooks are executed in a deterministic order, based on variable references instead of cells' positions on the page. Organize your notebook to best fit the story you're telling.
Synchronized UI elements. Import marimo to use
interactive elements like sliders, dropdowns, dataframe transformers, selectable plots, and more. Interact with
an element and all cells that use it are automatically re-run with its
latest value.
Performant runtime. marimo's runtime uses static analysis to run only those cells that need to be run. 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
Learn more
Ready to learn more? Check out our docs,
the examples/ folder, and our gallery.
|
|
|
|
| Tutorial | Inputs | Plots | Layout |
FAQ
See the FAQ at our docs.
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!
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.
