| title | Compatibility |
|---|---|
| description | Supported Python, marimo, browser, package, and protocol boundaries. |
marimo-export coordinates a Python producer, an optional live marimo session, and one or more consumers. Check the boundary that matches your workflow.
| Component | Contract |
|---|---|
| Python | The supported range and classifiers are declared in the package metadata. Continuous integration runs each declared version on Ubuntu and Windows. |
| marimo | The Python package metadata pins the exact supported marimo release. |
| marimo-export | A live capture client and the selected kernel must load the same package version and implementation identity. |
Run the compatibility diagnostic in the producer environment:
uv run marimo-export doctordoctor 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.
@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:
| Representation | Peer range or browser capability |
|---|---|
| JSON, scalar, text, HTML, NumPy, marimo snapshots | None beyond the browser package |
| Image | Document Object Model, Blob, and object URL APIs |
| Apache Arrow | @uwdata/flechette and lz4js, using the versions in the pnpm catalog |
| Parquet | hyparquet, using the version in the pnpm catalog |
| Vega-Lite | vega-embed, using the version in the pnpm catalog |
| AnyWidget | @anywidget/types, using the version in the pnpm catalog, for TypeScript types, plus embedded, data, HTTP, or HTTPS widget module support |
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.
marimo-export validates its closed public protocols by exact schema or codec identifier. Custom BlobAsset representations use extensible, syntactically validated media types.
| Boundary | Current identifier |
|---|---|
| Export specification | marimo-export.spec.v2 |
| State space | marimo-export.states.v1 |
| Notebook export | marimo-export.export.v1 |
| Prepared manifest | marimo-export.prepared.v1 |
| Native output envelope | Versioned 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.
The public marimo-export Python and browser packages use coordinated release
versions. Keep those package versions aligned when one application produces and
consumes the same export. The export records the producer versions and
implementation identity for inspection and diagnostics.
Portable JSON is a protocol and value contract within those public packages.
Browser applications import its TypeScript types from
@marimo-team/marimo-export. Python applications import conversion and
canonical-encoding functions from marimo_export.wire.