documentation.md

API Overview

Modules

• ansible: Main Ansible Module Builder.
• cli: common cli attributes.
• cli.subcommands: cli subcommands.
• cli.templates: Templates for creating new modules.
• environment: Environment variables, configuration and static filepaths.
• exceptions: Exceptions for application.
• hooks: base classes for hooks module.
• hooks.config: constants for module.
• hooks.dest_types
• hooks.dest_types.aws_api_gateway: Aws API Gateway Hook
• hooks.dest_types.executable: Executable type.
• hooks.dest_types.slack_webhook: Abstract method for other modules.
• hooks.dest_types.webhook_no_auth: Executable type.
• hooks.registry: response hook registry
• host
• host.intro: Introduction builder.
• host.main_intro_data: Question data interfaces.
• host.mods: Abstract method for other modules.
• host.nav: Navigation related utils.
• host.question_data: Question data interfaces.
• host.question_state: Abstract method for other modules.
• host.registry: Question data interfaces.
• host.userdata: Userdata / bootstrap module.
• host.xonsh: XenSH question interface.
• lib
• lib.yaml_util: Helper lib for yaml.

Classes

• ansible.Ansible: Ansible.
• cli.MainParser: MainParser.
• cli.ParserWrap: ParserWrap.
• subcommands.AssembleQuestions: AssembleQuestions.
• subcommands.Bootstrap: Bootstrap.
• subcommands.CreateNewModule: CreateNewModule.
• subcommands.Demo: Demo.
• subcommands.RunAllModules: RunAllModules.
• subcommands.RunModule: RunModule.
• subcommands.SaveUserData: SaveUserData.
• subcommands.TestQuestions: TestQuestions.
• environment.InterviewConfig: InterviewConfig.
• exceptions.ErrorBadConfig: Throw if the main configuration is bad.
• exceptions.PreCheckFail: Throw if Terraform precheck fails.
• hooks.Hook: BaseHookType.
• aws_api_gateway.WebHookAwsApiGw: WebHookNoAuth.
• executable.ExecutableDest: ExecutableDest.
• slack_webhook.SlackSend: Send slack messages to ops-interviews channel.
• slack_webhook.SlackWebhook: WebHookNoAuth.
• webhook_no_auth.WebHookNoAuth: WebHookNoAuth.
• registry.HookLoader: Loader.
• intro.Intro: Intro.
• main_intro_data.MainIntroCollection: MainIntroCollection.
• main_intro_data.MainIntroData: MainIntroData.
• mods.BaseModule: Module interface.
• mods.MainIntroModule
• mods.ModuleLoader
• mods.ModulesCollection: Collection of modules.
• mods.QuestionModule
• mods.SystemModule
• nav.NavFooter: NavFooter.
• nav.Navigation: Navigation.
• question_data.QuestionCollection: ModuleQuestions.
• question_data.QuestionData: QuestionModule.
• question_state.StateData: StateData.
• registry.DataInterface: Required Data interface for Registry.
• registry.RegistryBase: ModuleQuestions.
• userdata.UserDataScript: UserDataScript.
• xonsh.QuestionPrompt: QuestionPrompt.

Functions

• subcommands.yesno: Simple Yes/No Function.
• templates.copy_type: copy_type.
• intro.intro_export_b64: intro_export_b64.
• intro.intro_load_pickle_b64: intro_load_pickle_b64.
• intro.show_all_colors: show_all_colors.
• nav.color: color.
• xonsh.bash_filter: bash_filter.
• xonsh.cmd_event: cmd_event.
• xonsh.height: height.
• xonsh.twrap: twrap.
• xonsh.width: width.
• yaml_util.dump_to_file_open: dump_to_file_open.
• yaml_util.dump_to_text: dump_to_text.
• yaml_util.load_from_bytes: load_from_bytes.
• yaml_util.load_from_path: load_from_path.

---

This file was automatically generated via lazydocs.