panel.io.convert module#

panel.io.convert.convert_apps(apps: str | PathLike | Sequence[str | PathLike], dest_path: str | PathLike | None = None, title: str | None = None, runtime: Literal['pyodide', 'pyscript', 'pyodide-worker', 'pyscript-worker'] = 'pyodide-worker', requirements: list[str] | Literal['auto'] | PathLike = 'auto', prerender: bool = True, build_index: bool = True, build_pwa: bool = True, pwa_config: dict[Any, Any] = {}, max_workers: int = 4, panel_version: Literal['auto', 'local'] | str = 'auto', local_prefix: str = './', http_patch: bool = True, inline: bool = False, compiled: bool = False, verbose: bool = True)[source]#

Parameters:

apps: str | List[str]

The filename(s) of the Panel/Bokeh application(s) to convert.

dest_path: str | pathlib.Path

The directory to write the converted application(s) to.

title: str | None

A title for the application(s). Also used to generate unique name for the application cache to ensure.

runtime: ‘pyodide’ | ‘pyscript’ | ‘pyodide-worker’

The runtime to use for running Python in the browser.

The list of requirements to include (in addition to Panel). By default automatically infers dependencies from imports in the application. May also provide path to a requirements.txt

prerender: bool

Whether to pre-render the components so the page loads.

build_index: bool

Whether to write an index page (if there are multiple apps).

build_pwa: bool

Whether to write files to define a progressive web app (PWA) including a manifest and a service worker that caches the application locally

pwa_config: Dict[Any, Any]

Configuration for the PWA including (see https://developer.mozilla.org/en-US/docs/Web/Manifest)

display: Display options (‘fullscreen’, ‘standalone’, ‘minimal-ui’ ‘browser’)

orientation: Preferred orientation

background_color: The background color of the splash screen

theme_color: The theme color of the application

max_workers: int

The maximum number of parallel workers

panel_version: ‘auto’ | ‘local’] | str

‘ The panel version to include.

local_prefix: str: Prefix for the path to serve local wheel files from.
http_patch: bool: Whether to patch the HTTP request stack with the pyodide-http library to allow urllib3 and requests to work.
inline: bool: Whether to inline resources.
compiled: bool: Whether to use the compiled and faster version of Pyodide.

panel.io.convert.script_to_html(filename: str | PathLike | IO, requirements: list[str] | Literal['auto'] | PathLike = 'auto', js_resources: Literal['auto'] | list[str] = 'auto', css_resources: Literal['auto'] | list[str] | None = 'auto', runtime: Literal['pyodide', 'pyscript', 'pyodide-worker', 'pyscript-worker'] = 'pyodide', prerender: bool = True, panel_version: Literal['auto', 'local'] | str = 'auto', local_prefix: str = './', manifest: str | None = None, http_patch: bool = True, inline: bool = False, compiled: bool = True) → tuple[str, str | None][source]#

Converts a Panel or Bokeh script to a standalone WASM Python application.

Parameters:

filename: str | Path | IO: The filename of the Panel/Bokeh application to convert.
requirements: ‘auto’ | List[str] | os.PathLike: The list of requirements to include (in addition to Panel).
js_resources: ‘auto’ | List[str]: The list of JS resources to include in the exported HTML.
css_resources: ‘auto’ | List[str] | None: The list of CSS resources to include in the exported HTML.
runtime: ‘pyodide’ | ‘pyscript’: The runtime to use for running Python in the browser.
prerender: bool: Whether to pre-render the components so the page loads.
panel_version: ‘auto’ | str: The panel release version to use in the exported HTML.
local_prefix: str: Prefix for the path to serve local wheel files from.
http_patch: bool: Whether to patch the HTTP request stack with the pyodide-http library to allow urllib3 and requests to work.
inline: bool: Whether to inline resources.
compiled: bool: Whether to use pre-compiled pyodide bundles.