run.run_shiny_app

run.run_shiny_app(
    app_file,
    *,
    start_attempts=3,
    port=0,
    cwd=None,
    wait_for_start=True,
    timeout_secs=30,
    bufsize=64 * 1024,
    env=None,
)

Run a Shiny app in a subprocess.

Parameters

Name	Type	Description	Default
app_file	Union[str, PurePath]	The path to the Shiny app file.	required
start_attempts	int	Number of attempts to try and start the Shiny app. If the random port is already in use, a new random port will be chosen and another attempt will be made. If all attempts have been made, an error will be raised.	3
port	int	The port to run the app on. If 0, a random port will be chosen.	0
cwd	Optional[str]	The working directory to run the app in.	None
wait_for_start	bool	If True, wait for the app to become ready before returning.	True
timeout_secs	float	The maximum number of seconds to wait for the app to become ready.	30
bufsize	int	The buffer size to use for stdout and stderr.	64 * 1024
env	dict[str, str] | None	Extra environment variables for the app subprocess, merged over the parent environment (supplied values win). When None (the default), the parent environment is inherited unchanged.	None

Returns

Name	Type	Description
	ShinyAppProc	A shiny.run.ShinyAppProc object representing the running Shiny app process.