preflight

Part of Reusable workflows in the Python API reference.

Related guidance: shipped-tooling.

Runnable examples: preflight.py.

from picogrid_ecn_client.workflows import preflight

Run the public, read-only ECN preflight checks.

async def preflight(client: ECNClient) -> PreflightResult

Parameters

Name	Type	Default	Description
client	ECNClient	—	Configured SDK client to diagnose.

Returns

Type	Description
PreflightResult	The typed preflight report result.

Raises

Exception	Description
ECNClientError	If a connectivity or authorization check cannot complete.

Source · workflows/diagnostics.py