Skip to main content

anywidget for embedding metaframe URLs in Jupyter and marimo notebooks

Project description

metaframe-widget

An anywidget for embedding metaframe and metapage 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.3.6.tar.gz (5.4 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.3.6-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: metaframe_widget-0.3.6.tar.gz
  • Upload date:
  • Size: 5.4 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.3.6.tar.gz
Algorithm Hash digest
SHA256 000f2b91150a4fed0b0161ed141cc57160f9d27153ffd026acef7d075adc6dd5
MD5 81474fe1a79cb4ec2cfec5125b5a33c1
BLAKE2b-256 817bdd8942f3cdb1f40e6a7e7298a276528c5592c35de2df9b533713c37af043

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaframe_widget-0.3.6.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.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for metaframe_widget-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1045049414cff0bf5ee2013dee5d26d5f8a3b3307fc4c9ed2cc5fff9a33fd3d4
MD5 eeca467b441c159ef71131dde370104a
BLAKE2b-256 d04e591108cc358eead80b07ac5f5b0b1fc59bdc92b4c17925510f5e58274a91

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaframe_widget-0.3.6-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