pyfebiopt.monitoring.webapp

FastAPI web UI for monitoring optimization runs.

Attributes

logger
TEMPLATE
STATIC_ASSETS
RouteHandler

Functions

render_home_page(→ str)	Render the static HTML shell for the monitor dashboard.
create_app(→ fastapi.FastAPI)	Build a FastAPI application exposing the monitor endpoints.
parse_args(→ argparse.Namespace)	Parse CLI arguments for the monitoring web app.
main(→ int)	Run the monitoring web app CLI using parsed options.

Module Contents

pyfebiopt.monitoring.webapp.logger

pyfebiopt.monitoring.webapp.TEMPLATE

pyfebiopt.monitoring.webapp.STATIC_ASSETS

pyfebiopt.monitoring.webapp.RouteHandler

pyfebiopt.monitoring.webapp.render_home_page() → str

Render the static HTML shell for the monitor dashboard.

Returns:

Rendered HTML page.

Return type:

str

pyfebiopt.monitoring.webapp.create_app(service: pyfebiopt.monitoring.monitoring_service.MonitoringService) → fastapi.FastAPI

Build a FastAPI application exposing the monitor endpoints.

Returns:

Configured monitoring app.

Return type:

FastAPI

pyfebiopt.monitoring.webapp.parse_args(argv: collections.abc.Sequence[str] | None = None) → argparse.Namespace

Parse CLI arguments for the monitoring web app.

Returns:

Parsed arguments.

Return type:

argparse.Namespace

pyfebiopt.monitoring.webapp.main(argv: collections.abc.Iterable[str] | None = None) → int

Run the monitoring web app CLI using parsed options.

Returns:

Process exit code.

Return type:

int