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://framejs.io/#?js=...", height="300px")
w

marimo

import marimo as mo
from metaframe_widget import MetaframeWidget

w = MetaframeWidget(url="https://framejs.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.7.tar.gz (6.7 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.7-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: metaframe_widget-0.3.7.tar.gz
  • Upload date:
  • Size: 6.7 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.7.tar.gz
Algorithm Hash digest
SHA256 72abb25e69c06446163a3ecd3d20d0a1df7d5d31c1720d8edd22eb6b55148f0f
MD5 89e1ee9b8aaeea421392705e6f906df0
BLAKE2b-256 eab5b049fb7057f0ea3c82b8ca912bd6e13ce95a6fe7c91202ea2781b80e2b0e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for metaframe_widget-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1a2f54d1ccd9aebe2cedeb53bf80971edd7447a5d95662abe1e7bedc5bccb826
MD5 6d804746d65ecf7ece717bb7a0a38cba
BLAKE2b-256 13df4f4f789b3b6614d174db86c83090d47a4721f39a9344bb7219a143631dfd

See more details on using hashes here.

Provenance

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