Skip to content
v0.1.3

Doctor Module API Reference

This section documents the internals of the doctor module in Bijux CLI.

bijux_cli.services.doctor

Provides the concrete implementation of the CLI health check service.

This module defines the Doctor class, which implements the DoctorProtocol. It is responsible for performing diagnostic health checks on the application and its environment.

Doctor

Bases: DoctorProtocol

An implementation of the health check service.

This class provides a simple health check method that can be extended in the future to verify dependencies, such as database connections or external API reachability.

check_health 

check_health() -> str

Performs a basic health check on the application.

Returns:

  • str ( str ) –

    A string indicating the health status. Currently always returns "healthy".

Source code in src/bijux_cli/services/doctor.py 
24
25
26
27
28
29
30
31
def check_health(self) -> str:
    """Performs a basic health check on the application.

    Returns:
        str: A string indicating the health status. Currently always
            returns "healthy".
    """
    return "healthy"