Skip to content

Compatibility

marimo-export coordinates a Python producer, an optional live marimo session, and one or more consumers. Check the boundary that matches your workflow.

Python and marimo

ComponentContract
PythonThe package requires Python 3.10 or newer. Continuous integration tests Python 3.10 through 3.14 on Ubuntu and Windows.
marimoThe Python package metadata pins the exact supported marimo release.
marimo-exportA live capture client and the selected kernel must load the same package version and implementation identity.

Run the compatibility diagnostic in the producer environment:

bash
uv run marimo-export doctor

doctor reports the Python executable, package version, effective repository, and marimo adapter status. A failed marimo check means the environment cannot construct the supported marimo adapter. Install the supported version before a producer operation that needs notebook inspection or execution. Exact repository reuse and consumer readers can complete without constructing that adapter.

Browser package

@marimo-team/marimo-export uses ECMAScript modules, the browser-native JavaScript module format, and targets ES2022. Opening and verifying an export require standard web APIs including fetch, URL, an optional AbortSignal, and Web Crypto.

Loading and mounting add representation-specific browser requirements:

RepresentationAdditional dependency or browser capability
JSON, scalar, text, HTML, NumPy, marimo snapshotsNone beyond the browser package
ImageDocument Object Model, Blob, and object URL APIs
Apache Arrow@uwdata/flechette and lz4js
Parquethyparquet
Vega-Litevega-embed
AnyWidget@anywidget/types for TypeScript types, plus embedded, data, HTTP, or HTTPS widget modules

See Output representations for install commands and loader contracts. Browser mounts, Blob URLs, canvas rendering, dynamic imports, and widget styles belong in a client-side boundary when the application also uses server rendering.

Protocol versions

marimo-export validates its closed public protocols by exact schema or codec identifier. Custom BlobAsset representations use extensible, syntactically validated media types.

BoundaryCurrent identifier
Export specificationmarimo-export.spec.v2
State spacemarimo-export.states.v1
Notebook exportmarimo-export.export.v1
Prepared manifestmarimo-export.prepared.v1
Native output envelopeVersioned codec listed in Output representations

A reader rejects an unknown closed schema or codec before exposing the affected object. Update the producer and consumer together when one of those protocols changes. Version a custom media type when its payload changes incompatibly.

Release coordination

The Python package, browser package, and portable JSON package use coordinated release versions. Keep package versions aligned when one application produces and consumes the same export. The export itself records the producer versions and implementation identity for inspection and diagnostics.

Released under the Apache 2.0 License.