earthkit.data.sources.prompt¶

Attributes¶

`HTML_ASK`
`HTML_MESSAGE`
`MESSAGE`
`RC_MESSAGE_BASE`
`RC_MESSAGE_EXT`

Classes¶

`APIKeyPrompt`
`Markdown`
`Prompt`
`RegexValidate`
`Text`

Module Contents¶

class earthkit.data.sources.prompt.APIKeyPrompt¶

ask_user()¶

ask_user_and_save()¶

check(load=False)¶

config_env = []¶

existing_rcfile_path()¶

has_api_config()¶

has_config_env()¶

load(file)¶

rcfile_env = None¶

rcfile_name()¶

save(input, file)¶

validate(input)¶

earthkit.data.sources.prompt.HTML_ASK = Multiline-String¶

Show Value

"""
<div style='border: 1px solid gray; color: black;
     background-color: rgb(230, 230, 230);
     margin: 0.2em; padding: 0.2em; font-weight: bold;'>
{message}
</div>
"""

earthkit.data.sources.prompt.HTML_MESSAGE = Multiline-String¶

Show Value

"""
<div style='border: 1px solid orange; color: black;
     background-color: rgb(255, 214, 0);
     margin: 0.5em; padding: 0.5em; font-weight: bold;'>
{message}
</div>
"""

earthkit.data.sources.prompt.MESSAGE = Multiline-String¶

Show Value

"""
An API key is needed to access this dataset. Please visit
{register_or_sign_in_url} to register or sign-in
then visit {retrieve_api_key_url} to retrieve you API key.
"""

class earthkit.data.sources.prompt.Markdown(owner)¶

Bases: Prompt

ask(p, method)¶

ask_user()¶

owner¶

print_message()¶

class earthkit.data.sources.prompt.Prompt(owner)¶

ask_user()¶

owner¶

earthkit.data.sources.prompt.RC_MESSAGE_BASE = Multiline-String¶

Show Value

"""
You can store the credentials in {rcfile}; if you follow the
instructions below it will be automatically done for you.
"""

earthkit.data.sources.prompt.RC_MESSAGE_EXT = Multiline-String¶

Show Value

"""
You can store the credentials in {rcfile} or in the file
pointed by the {rcfile_env} environment variable. If you follow
the instructions below {rcfile} will be automatically created
for you.
"""

class earthkit.data.sources.prompt.RegexValidate(pattern)¶

pattern¶

class earthkit.data.sources.prompt.Text(owner)¶

Bases: Prompt

ask(p, method)¶

ask_user()¶

owner¶

print_message()¶