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
- git-friendly: stored as
.py
files - deployable: executable as a script, deployable as an app
pip install marimo && marimo tutorial intro
Watch the animated GIF as a video at this link.
Quickstart
Installation. In a terminal, run
pip install marimo
marimo tutorial intro
You should see a tutorial notebook in your browser.
marimo is also available through Conda: conda install -c conda-forge marimo
.
Create notebooks. Create an empty notebook with
marimo edit
or create/edit a notebook with a given name with
marimo edit your_notebook.py
- marimo reacts to your code changes, like a spreadsheet! This rapid feedback ensures your code and outputs are always in sync.
- Import
marimo
in your notebooks to use interactive elements, like sliders, dropdowns, tables, and more.
See our docs to learn more, including how to layout outputs in tabs, rows, columns, and more.
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, our platform for deploying marimo notebooks and supercharging them with cloud resources.
Execute as scripts. marimo noteboooks 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
GitHub Copilot. The marimo editor natively supports GitHub Copilot. Enable it via the settings menu in the marimo editor.
VS Code extension. If you prefer VS Code over terminal, try our VS Code extension.
Learn more
marimo is easy to get started with, with lots of room for power users. In addition to experimenting with code and models in a reproducible environment, marimo lets you build powerful tools including data labelers, embedding visualizers, and model evaluation dashboards, with surprisingly little code.
Examples are available in the examples/
directory.
We've deployed many of these examples at our public
gallery; try them out!
Ready to learn more? Check out our docs!
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!
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
Built Distribution
File details
Details for the file marimo-0.1.69.tar.gz
.
File metadata
- Download URL: marimo-0.1.69.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ad51bb87a0dd5a75d3b3caca0394dc8c95ed694d06f9075f47fa0b9f3910146 |
|
MD5 | c1d8591406b6f8fe3c713fa9943f7666 |
|
BLAKE2b-256 | 692bbbe3101053d0fe92efeda83447314ce5646dbf458cb257b773478dfab47a |
File details
Details for the file marimo-0.1.69-py3-none-any.whl
.
File metadata
- Download URL: marimo-0.1.69-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
Algorithm | Hash digest | |
---|---|---|
SHA256 | baeb246a26c67be4ea506e287b28fec7bb1946758ad349c9c9b026cb927470a9 |
|
MD5 | 559ca93f3a9ce049dfc9049b156e5822 |
|
BLAKE2b-256 | 1faed9c8e5f2427d1ec3a1dc591206111c2c0b90c63c1e756e43a472dc948818 |