20cfc93c58
<!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary This change adds a new integration guide, on using uv with marimo notebooks. It is similar to but simpler than the existing Jupyter guide, since marimo stores notebooks as Python files and also integrates tightly with uv for package management. The guide showcases four ways of using uv with marimo: 1. marimo as a standalone tool (`uvx`) 2. managing inline script metadata (an alternative to Jupyter kernels, marimo has no concept of kernels) 3. in project environments 4. in non-project environments ## Test Plan N/A as this is a docs-only change. --------- Co-authored-by: Zanie Blue <contact@zanie.dev>
3.4 KiB
| title | description |
|---|---|
| Using uv with marimo | A complete guide to using uv with marimo notebooks for interactive computing, script execution, and data apps. |
Using uv with marimo
marimo is an open-source Python notebook that blends interactive computing with the reproducibility and reusability of traditional software, letting you version with Git, run as scripts, and share as apps. Because marimo notebooks are stored as pure Python scripts, they are able to integrate tightly with uv.
You can readily use marimo as a standalone tool, as self-contained scripts, in projects, and in non-project environments.
Using marimo as a standalone tool
For ad-hoc access to marimo notebooks, start a marimo server at any time in an isolated environment with:
$ uvx marimo edit
Start a specific notebook with:
$ uvx marimo edit my_notebook.py
Using marimo with inline script metadata
Because marimo notebooks are stored as Python scripts, they can encapsulate their own dependencies
using inline script metadata, via uv's support for scripts. For example,
to add numpy as a dependency to your notebook, use this command:
$ uv add --script my_notebook.py numpy
To interactively edit a notebook containing inline script metadata, use:
$ uvx marimo edit --sandbox my_notebook.py
marimo will automatically use uv to start your notebook in an isolated virtual environment with your script's dependencies. Packages installed from the marimo UI will automatically be added to the notebook's script metadata.
You can optionally run these notebooks as Python scripts, without opening an interactive session:
$ uv run my_notebook.py
Using marimo within a project
If you're working within a project, you can start a marimo notebook with access to the project's virtual environment via the following command (assuming marimo is a project dependency):
$ uv run marimo edit my_notebook.py
To make additional packages available to your notebook, either add them to your project with
uv add, or use marimo's built-in package installation UI, which will invoke uv add on your
behalf.
If marimo is not a project dependency, you can still run a notebook with the following command:
$ uv run --with marimo marimo edit my_notebook.py
This will let you import your project's modules while editing your notebook. However, packages installed via marimo's UI when running in this way will not be added to your project, and may disappear on subsequent marimo invocations.
Using marimo in a non-project environment
To run marimo in a virtual environment that isn't associated with a project, add marimo to the environment directly:
$ uv venv
$ uv pip install numpy
$ uv pip install marimo
$ uv run marimo edit
From here, import numpy will work within the notebook, and marimo's UI installer will add packages
to the environment with uv pip install on your behalf.
Running marimo notebooks as scripts
Regardless of how your dependencies are managed (with inline script metadata, within a project, or with a non-project environment), you can run marimo notebooks as scripts with:
$ uv run my_notebook.py
This executes your notebook as a Python script, without opening an interactive session in your browser.