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

apigee.console.echo(*message, exit_status=None, make_silent=False, current_verbosity=0, expected_verbosity=0, line_ending='\n', should_flush=False)

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_global_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_function_on_iterable(iterable, func, state_op='append', args=(), kwargs=None)
apigee.utils.check_file_exists(file)
apigee.utils.check_files_exist(files)
apigee.utils.create_directory(path)
apigee.utils.create_empty_file(path)
apigee.utils.ensure_set(iterable)
apigee.utils.execute_function_on_directory_files(directory, func, glob='**/*', args=(), kwargs=None)
apigee.utils.extract_zip_file(source, dest)
apigee.utils.filter_out_empty_values(data)
apigee.utils.get_progress_kwargs(desc)
apigee.utils.get_resolved_directory_path(target=None)
apigee.utils.import_plugins_from_directory(init_file, commands)
apigee.utils.is_directory(path)
apigee.utils.is_regular_file(path)
apigee.utils.merge_dict_values(source, target=None)
apigee.utils.read_file_content(file, type='text')
apigee.utils.remove_file_if_above_size(file, size_kb=100)
apigee.utils.remove_last_elements(items, count=0)
apigee.utils.show_message(msg)
apigee.utils.split_path_by_delimiter(path, delimiter='[/\\\\\\\\]')
apigee.utils.write_content_to_file(content, path, write=True, indentation=None, append_eof=True)
apigee.utils.write_content_to_zip(file, content)

apigee.utils_init module

apigee.utils_init.is_truthy_envvar(value)
apigee.utils_init.join_path_components(*components)

apigee.verbose module

apigee.verbose.common_verbose_options(func)

Module contents