docker_launch.ssh

get_default_key_path(allow_locked=False)[source]
Parameters

allow_locked (bool) –

Return type

Optional[Path]

is_locked(key_path)[source]
Parameters

key_path (Path) –

Return type

bool

ssh_copy_id(pubkey_path, address, *, username=None)[source]
Parameters
  • pubkey_path (Union[PathLike, str]) –

  • address (str) –

  • username (Optional[str]) –

Return type

int

generate_default_key(comment='generated-by-docker-launch')[source]
Parameters

comment (str) –

Return type

Path

get_ssh_error(address, *, username=None, port=22, timeout=3.0)[source]
Parameters
  • address (str) –

  • username (Optional[str]) –

  • port (int) –

  • timeout (float) –

Return type

Optional[Type[Exception]]