examples/README.md
This folder contains example marimo notebooks, meant to teach you how to use marimo's features as well as inspire you to make awesome notebooks.
ui/: how to use UI elements or widgetssql/: how to use SQL in marimocontrol_flow/: how to control cell execution and output displaymarkdown/: how to write markdown, including dynamic markdownlayouts/: how to present notebooks as slides, add sidebars, and moreai/: AI-related examplestesting/: how to test marimo notebooks, and use marimo notebooks as teststhird_party/: using popular third-party packages in marimocloud/: using various cloud providersframeworks/: integrating with different frameworks (web/ASGI)misc/: miscellaneous topical examples[!TIP] New to marimo? Run
marimo tutorial introat the command line first!
[!TIP] Check out our public gallery of interactive notebooks to get inspired.
[!NOTE] Submit a pull request to add an example! We especially welcome library developers to add examples to
third_party/.
The requirements of each notebook are serialized in them as a top-level comment. Here are the steps to open an example notebook:
uvmarimo edit --sandbox <notebook-url>.For example:
uvx marimo edit --sandbox https://github.com/marimo-team/marimo/blob/main/examples/misc/seam_carving.py
[!TIP] The
--sandboxflag opens the notebook in an isolated virtual environment, automatically installing the notebook's dependencies ๐ฆ
You can also open notebooks without uv, in which case you'll need to
manually install marimo
first. Then run marimo edit <notebook.py>; however, you'll also need to
install the requirements yourself.
Every week, we highlight stellar examples and projects from our community. Check them out at our marimo spotlights repo!