quickstart.prompts#

Interactive prompts for quickstart configuration.

Module Contents#

Functions#

detect_registry_auth_type

Detect what type of authentication an image registry requires.

prompt_for_configuration

Interactive configuration wizard using prompt_toolkit.

prompt_for_registry_credentials

Prompt for registry credentials after a pull failure.

Data#

BULLET

CHECK

CROSS

REGISTRIES_REQUIRING_AUTH

WARN

console

API#

quickstart.prompts.BULLET#

‘•’

quickstart.prompts.CHECK#

‘[green]✓[/green]’

quickstart.prompts.CROSS#

‘[red]✗[/red]’

quickstart.prompts.REGISTRIES_REQUIRING_AUTH#

(‘ghcr.io’, ‘docker.io’, ‘registry.gitlab.com’, ‘nvidia.com’)

quickstart.prompts.WARN#

‘[yellow]![/yellow]’

quickstart.prompts.console#

‘Console(…)’

quickstart.prompts.detect_registry_auth_type(
image: str,
) → Literal[ngc, user_pass, none]#

Detect what type of authentication an image registry requires.

Parameters:

image – Container image name (e.g., “nvcr.io/nvidia/nemo:latest”)

Returns:

“ngc” for nvcr.io (uses NGC API key with $oauthtoken) “user_pass” for GitHub, Docker Hub, GitLab registries “none” for other registries (assume already logged in)

quickstart.prompts.prompt_for_configuration(
config: quickstart.config.QuickstartConfig,
) → quickstart.config.QuickstartConfig#

Interactive configuration wizard using prompt_toolkit.

Parameters:

config – Existing configuration to use as defaults.

Returns:

Updated QuickstartConfig with user input.

quickstart.prompts.prompt_for_registry_credentials(
image: str,
*,
default_registry: str | None = None,
) → tuple[str, str, pydantic.SecretStr]#

Prompt for registry credentials after a pull failure.

Parameters:

  • image – Container image name (e.g., “registry.example.com/repo/image:tag”).

  • default_registry – Optional default registry host value.

Returns:

Tuple of (registry, username, password).