tapis_cli.clients.services.taccapis.v2 package¶
Submodules¶
tapis_cli.clients.services.taccapis.v2.api_keysecret module¶
-
class
tapis_cli.clients.services.taccapis.v2.api_keysecret.
TaccApisKeySecretPassword
¶ Bases:
tapis_cli.clients.services.taccapis.v2.base.TaccApisCommandBase
Parameterize Tapis API commands that accept API key/secret + password
-
add_common_parser_arguments
(parser)¶
-
-
class
tapis_cli.clients.services.taccapis.v2.api_keysecret.
TaccApisKeySecretUsernamePassword
¶ Bases:
tapis_cli.clients.services.taccapis.v2.api_keysecret.TaccApisKeySecretPassword
Parameterize Tapis API commands that accept API key/secret + username/password and/or token_username
-
add_common_parser_arguments
(parser)¶
-
tapis_cli.clients.services.taccapis.v2.apiclient module¶
-
class
tapis_cli.clients.services.taccapis.v2.apiclient.
TaccApiClient
¶ Bases:
object
-
PROPS
= [('token', 'access_token', 'access_token'), ('refresh_token', 'refresh_token', 'refresh_token'), ('api_key', 'api_key', 'api_key'), ('api_secret', 'api_secret', 'api_secret'), ('api_server', 'baseurl', 'api_server'), ('tenant_id', 'tenantid', 'tenant_id'), ('username', 'username', 'username'), ('token_username', 'token_username', 'token_username'), ('password', 'password', 'password'), ('created_at', 'created_at', 'created_at'), ('expires_in', 'expires_in', 'expires_in'), ('expires_at', 'expires_at', 'expires_at')]¶
-
TIMEZONE
= None¶
-
init_clients
(passed_args=None)¶
-
key_values
()¶ Returns Tapis variable/value pairs for templating
-
post_payload
= {}¶
-
render_value
(value)¶ Renders a value based on current display format
Each field value in a response can be passed through this function to implement format-specific rendering
-
tapis_cli.clients.services.taccapis.v2.base module¶
-
class
tapis_cli.clients.services.taccapis.v2.base.
TaccApisCommandBase
¶ Bases:
tapis_cli.clients.services.taccapis.v2.apiclient.TaccApiClient
A base class for building Tapis API client commands
-
add_common_parser_arguments
(parser)¶
-
client_extra_args
= {}¶
-
constants
= <module 'tapis_cli.constants' from '/home/docs/checkouts/readthedocs.org/user_builds/tapis-cli/envs/stable/lib/python3.7/site-packages/tapis_cli/constants.py'>¶
-
get_parser
(prog_name)¶
-
post_payload
= {}¶
-
take_action
(parsed_args)¶
-
update_payload
(parsed_args)¶
-
tapis_cli.clients.services.taccapis.v2.basic module¶
-
class
tapis_cli.clients.services.taccapis.v2.basic.
TaccApisOnlyBasic
¶ Bases:
tapis_cli.clients.services.taccapis.v2.base.TaccApisCommandBase
Base class for Tapis API commands accepting only HTTP Basic Authentication
-
add_common_parser_arguments
(parser)¶
-
tapis_cli.clients.services.taccapis.v2.bearer module¶
-
class
tapis_cli.clients.services.taccapis.v2.bearer.
TaccApisBearer
¶ Bases:
tapis_cli.clients.services.taccapis.v2.base.TaccApisCommandBase
-
ACCEPT_ACCESS_TOKEN
= True¶
-
ACCEPT_NONCE
= False¶
-
ACCEPT_REFRESH_TOKEN
= False¶
-
ALLOW_NO_VERIFY
= True¶
-
add_common_parser_arguments
(parser)¶
-
init_clients
(parsed_args)¶ Override CommandBase to set up client with passed token
-
-
class
tapis_cli.clients.services.taccapis.v2.bearer.
TaccApisNoBearer
¶ Bases:
tapis_cli.clients.services.taccapis.v2.base.TaccApisCommandBase
Base class for Tapis API commands that accept only an access token
-
add_common_parser_arguments
(parser)¶
-
tapis_cli.clients.services.taccapis.v2.bearer_refresh module¶
-
class
tapis_cli.clients.services.taccapis.v2.bearer_refresh.
TaccApisBearerRefresh
¶ Bases:
tapis_cli.clients.services.taccapis.v2.bearer.TaccApisBearer
Base class for Tapis API commands both an access token and a refresh token
-
add_common_parser_arguments
(parser)¶
-
tapis_cli.clients.services.taccapis.v2.direct module¶
-
class
tapis_cli.clients.services.taccapis.v2.direct.
TaccApiDirectClient
(agave_client)¶ Bases:
object
Requests client bootstrapped from a Tapis API client
The intended use is to implement methods not expressed by the current Swagger spec and which are thus not accessible in AgavePy. Examples include the ‘search’ function, which relies on encoding a POST form of search terms into a GET request. The web request is made directly using the
requests
library. Configuration for SSL verification is inherited from theverify
property of the passed Agave client to enforce consistent communications behavior between the two kinds of HTTP client.-
build_url
(*args)¶
-
delete
(path=None)¶
-
get
(path=None)¶
-
get_bytes
(path=None)¶
-
get_data
(path=None, params={})¶
-
post
(path=None, data=None, content_type=None, json=None, params=None)¶
-
post_data_basic
(data=None, auth=None, path=None, content_type=None)¶
-
setup
(service_name, service_version, api_path=None)¶
-
tapis_cli.clients.services.taccapis.v2.format_many module¶
-
class
tapis_cli.clients.services.taccapis.v2.format_many.
TaccApisFormatManyUnlimited
(app, app_args, cmd_name=None)¶ Bases:
tapis_cli.clients.services.mixins.LegacyCommmandHelp
,tapis_cli.clients.services.mixins.JsonVerbose
,tapis_cli.clients.http.HTTPFormatMany
,tapis_cli.clients.services.taccapis.v2.bearer.TaccApisBearer
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
preprocess_args
(parsed_args)¶
-
-
class
tapis_cli.clients.services.taccapis.v2.format_many.
TaccApisFormatMany
(app, app_args, cmd_name=None)¶ Bases:
tapis_cli.clients.services.taccapis.v2.format_many.TaccApisFormatManyUnlimited
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
preprocess_args
(parsed_args)¶
-
update_payload
(parsed_args)¶
-
tapis_cli.clients.services.taccapis.v2.format_one module¶
-
class
tapis_cli.clients.services.taccapis.v2.format_one.
TaccApisFormatOne
(app, app_args, cmd_name=None)¶ Bases:
tapis_cli.clients.services.mixins.LegacyCommmandHelp
,tapis_cli.clients.services.mixins.JsonVerbose
,tapis_cli.clients.http.HTTPFormatOne
,tapis_cli.clients.services.taccapis.v2.bearer.TaccApisBearer
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
preprocess_args
(parsed_args)¶
-
update_payload
(parsed_args)¶
-
-
class
tapis_cli.clients.services.taccapis.v2.format_one.
TaccApisFormatOneNoBearer
(app, app_args, cmd_name=None)¶ Bases:
tapis_cli.clients.services.mixins.LegacyCommmandHelp
,tapis_cli.clients.services.mixins.JsonVerbose
,tapis_cli.clients.http.HTTPFormatOne
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
preprocess_args
(parsed_args)¶
-
update_payload
(parsed_args)¶
-