Skip to content

dp3.bin.shcmd.health

Health commands for the shell-oriented DP3 CLI.

handle_health 

handle_health(client, _args) -> int

Check whether the API root responds successfully.

Source code in dp3/bin/shcmd/health.py 
7
8
9
def handle_health(client, _args) -> int:
    """Check whether the API root responds successfully."""
    return print_response_json(client.request("GET", "/"))

register_parser 

register_parser(commands) -> None

Register health commands on the root parser.

Source code in dp3/bin/shcmd/health.py 
12
13
14
15
def register_parser(commands) -> None:
    """Register health commands on the root parser."""
    health_parser = commands.add_parser("health", help="Check whether the API is reachable.")
    health_parser.set_defaults(handler=handle_health)