Skip to main content

anywidget for embedding metaframe URLs in Jupyter and marimo notebooks

Project description

metaframe-widget

An anywidget for embedding metaframe URLs in Jupyter and marimo notebooks.

Install

pip install metaframe-widget

With environment extras:

pip install "metaframe-widget[jupyter]"   # includes jupyterlab
pip install "metaframe-widget[marimo]"    # includes marimo

Quick start

Jupyter

from metaframe_widget import MetaframeWidget

w = MetaframeWidget(url="https://js.mtfm.io/#?js=...", height="300px")
w

marimo

import marimo as mo
from metaframe_widget import MetaframeWidget

w = MetaframeWidget(url="https://js.mtfm.io/#?js=...", height="300px")
mo.ui.anywidget(w)

Create from inline JavaScript

w = MetaframeWidget.from_code("""
  setOutput("result", getInput("data") * 2);
""", height="300px")

API reference

Parameter Type Default Description
url str "" Full metaframe URL (including hash params)
inputs dict {} Dict of inputs to push to the metaframe
outputs dict {} Dict of outputs received from the metaframe (read-only)
width str "100%" CSS width for the widget container
height str "400px" CSS height for the widget container
allow str "" iframe allow attribute (e.g. "camera; microphone")

Methods

  • set_inputs(d) — merge a dict into current inputs
  • set_input(key, value) — set a single input key
  • on_outputs_change(callback) — register a callback for output changes
  • from_code(js_code, **kwargs) — class method to create a widget from inline JS
  • pipe_to(target, output_key, input_key=None) — connect an output to another widget's input

Piping widgets

source = MetaframeWidget(url="...")
sink = MetaframeWidget(url="...")
source.pipe_to(sink, output_key="result", input_key="data")

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metaframe_widget-0.1.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metaframe_widget-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file metaframe_widget-0.1.0.tar.gz.

File metadata

  • Download URL: metaframe_widget-0.1.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for metaframe_widget-0.1.0.tar.gz
Algorithm Hash digest
SHA256 13ddf64f84565ee87d4cdfa85fc313a465c40d37e0336af3b65f477cff141635
MD5 5f9a1c42d671134cdcf00e110e1794c7
BLAKE2b-256 511d99a801e56586ebe874e5fcff074dd917eaf8bf77b8f91a5488b7760e7d2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaframe_widget-0.1.0.tar.gz:

Publisher: publish-python.yml on metapages/metaframe-js

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file metaframe_widget-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for metaframe_widget-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 493e463529cf91461e458707882beb1b5987681f09186fb808dd62d9ad368a78
MD5 f2777f172c157f17848d32de50163053
BLAKE2b-256 78dd2fc0664b40a39e6f6260160200093a60891d8ee91f53b1756d2afc826dcf

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaframe_widget-0.1.0-py3-none-any.whl:

Publisher: publish-python.yml on metapages/metaframe-js

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page