apigee package

Subpackages

Submodules

apigee.auth module

apigee.auth.attach_is_token_option(func, profile)

apigee.auth.attach_mfa_secret_option(func, profile)

apigee.auth.attach_org_option(func, profile)

apigee.auth.attach_password_option(func, profile)

apigee.auth.attach_username_option(func, profile)

apigee.auth.attach_zonename_option(func, profile)

apigee.auth.common_auth_options(func)

apigee.auth.generate_authentication(username=None, password=None, mfa_secret=None, token=None, zonename=None)

apigee.auth.generate_authentication_error_message(e)

apigee.auth.get_access_token(auth, username, password, session, passcode)

apigee.auth.get_access_token_for_mfa(auth, username, password, session)

apigee.auth.get_access_token_for_sso(auth, session, passcode)

apigee.auth.get_access_token_for_token(auth, username, password, session)

apigee.auth.get_config_value(section, key)

apigee.auth.get_sso_temporary_authentication_code(url)

apigee.auth.retrieve_access_token(authentication, passcode=None)

apigee.auth.set_authentication_headers(authentication_object, custom_headers=None)

apigee.auth.validate_access_token(authentication_object)

apigee.auth.validate_jwt_token(authentication_object, file_name, username_field)

apigee.auth.validate_refresh_token(authentication_object)

apigee.cls module

class apigee.cls.AliasedGroup(name: str | None = None, commands: MutableMapping[str, Command] | Sequence[Command] | None = None, **attrs: Any)

Bases: Group

get_command(ctx, cmd_name): Given a context and a command name, this returns a Command object if it exists or returns None.

apigee.console module

class apigee.console.EchoOptions(exit_status: int | None = None, silent: bool = False, verbosity: int = 0, level: int = 0, end: str = '\n', flush: bool = False)

Bases: object

end: str

exit_status: int | None

flush: bool

level: int

silent: bool

verbosity: int

apigee.console.echo(*msg, options: EchoOptions | None = None, **kwargs)

apigee.encryption_utils module

apigee.encryption_utils.decrypt_with_gpg(secret, message, encoded=True)

apigee.encryption_utils.encrypt_with_gpg(secret, message, encoded=True)

apigee.encryption_utils.has_encrypted_header(message)

apigee.exceptions module

exception apigee.exceptions.InvalidApisError: Bases: Exception

apigee.exceptions.configure_root_logger(log_file)

apigee.exceptions.log_and_echo_http_error(error, append_message='')

apigee.exceptions.wrap_with_exception_handling(func)

apigee.prefix module

apigee.prefix.common_prefix_options(func)

apigee.request module

apigee.request.delete(uri, auth_object, headers=None, verify=False, **kwargs)

apigee.request.get(uri, auth_object, params=None, headers=None, verify=False, **kwargs)

apigee.request.head(uri, auth_object, headers=None, verify=False, **kwargs)

apigee.request.options(uri, auth_object, headers=None, verify=False, **kwargs)

apigee.request.patch(uri, auth_object, data=None, headers=None, verify=False, **kwargs)

apigee.request.post(uri, auth_object, data=None, json=None, headers=None, verify=False, **kwargs)

apigee.request.put(uri, auth_object, data=None, headers=None, verify=False, **kwargs)

apigee.request.request(method, uri, auth_object, headers=None, raise_exception=True, **kwargs)

apigee.silent module

apigee.silent.common_silent_options(func)

apigee.types module

class apigee.types.Struct(**entries): Bases: object

apigee.types.empty_snapshot()

apigee.utils module

apigee.utils.apply(iterable, func, state_op='append', args=(), kwargs=None)

apigee.utils.as_set(iterable)

apigee.utils.check_all_exist(files)

apigee.utils.check_exists(file)

apigee.utils.drop_last(lst, count=0)

apigee.utils.extract_zip(source, dest)

apigee.utils.filter_empty(d)

apigee.utils.for_each_file(directory, func, glob='**/*', args=(), kwargs=None)

apigee.utils.is_dir(path)

apigee.utils.is_file(path)

apigee.utils.load_plugins(init_file, commands)

apigee.utils.merge_values(source, target=None)

apigee.utils.mkdir(path)

apigee.utils.progress_opts(desc)

apigee.utils.read_file(file, type='text')

apigee.utils.remove_if_large(file, size_kb=100)

apigee.utils.resolve_dir(target=None)

apigee.utils.touch(path)

apigee.utils.write_file(content, path, write=True, indentation=None, append_eof=True)

apigee.utils.write_zip(file, content)

apigee.utils_init module

apigee.utils_init.is_truthy(value)

apigee.utils_init.join_path(*components)

apigee.verbose module

apigee.verbose.common_verbose_options(func)