Snakepit.EnvDoctor (Snakepit v0.6.10)

Environment diagnostics for the Python bridge.

Provides both a Mix task integration (mix snakepit.doctor) and runtime guardrails via ensure_python!/1.

Summary

check_result()

Ensure the Python runtime is ready. Raises if any critical check fails.

run(opts \\ [])

Run the full doctor suite. Returns {:ok, results} or {:error, results}.

@type check_result() :: %{
  name: atom(),
  status: :ok | :warning | :error,
  message: String.t()
}

@spec ensure_python!(Keyword.t()) :: :ok | no_return()

Ensure the Python runtime is ready. Raises if any critical check fails.

@spec run(Keyword.t()) :: {:ok, [check_result()]} | {:error, [check_result()]}

Run the full doctor suite. Returns {:ok, results} or {:error, results}.