Skip to main content

hedron-notebook

PyPI Python CI License: MIT

Server-side notebook preview helper for Hedron.

Run a normal Hedron ASGI app from an authoring notebook with inline iframe and external-link modes. Distinct from the browser-Python / JupyterLite sandbox in hedron-extras. Install as hedron-notebook or via hedron[notebook].

Package maturity: Experimental Alpha (0.1.x) · pin >=0.1.0,<0.2 and expect churn

Default guidance is localhost-only development. Hosted or publicly reachable hosts raise an explicit warning. This package is not a Supported production server.

Install

pip install "hedron-notebook>=0.1.0,<0.2"
# or
uv add "hedron-notebook>=0.1.0,<0.2"
# via flagship:
pip install "hedron[notebook]>=0.1.0,<0.2"

Requires Python 3.11–3.14.

Optional server extra (uvicorn):

pip install "hedron-notebook[server]>=0.1.0,<0.2"

Quick start

from hedron import Hedron, Page, Text
from hedron_notebook import start_preview

app = Hedron(
    title="Notebook demo",
    security="standard",
    session_secret="dev-only",
    explorer="off",
)


@app.page("/")
def home() -> Page:
    return Page(Text("Hello from a notebook preview"), title="Demo")


preview = start_preview(app)
print(preview.url)
# In a Jupyter cell:
# display HTML with preview.iframe_html()
preview.shutdown()

Public API

Symbol Role
start_preview(app) Start a local preview server for an ASGI app
NotebookPreview Handle with .url, .iframe_html(), .shutdown()

Links

License

MIT. See LICENSE.

Download files

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

Source Distribution

hedron_notebook-0.1.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

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

hedron_notebook-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hedron_notebook-0.1.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for hedron_notebook-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5067174422b30026692a5ef80c68a967beddc3df21c0ab251ed1903bd8541d48
MD5 1517b5e51dc50edcd1a55b3b0ff9371c
BLAKE2b-256 c7523e484fd50ca22fb1c8e8af06951156eaeb7e95995ffe521b25f0fc904aa8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hedron_notebook-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for hedron_notebook-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24ce99ae8d492cacca394e0ce269e6ab50110e0333466bd6a15f56b5e76ac02b
MD5 b9e7f3ee92415acb316e5c54f643cda1
BLAKE2b-256 1cec40b895d3d72281c62bfb0c5d6f6b2ab9885007bdf467023c4cd9e0bc0365

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.0

2 files

This release

0.1.0 This release

2 files

Supported by

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