Fora API

The main module of fora.

Subpackages

• fora.connectors ‒ Contains all standard conectors to register them by default.

• fora.operations ‒ This package contains all standard operation modules.

Submodules

• fora.utils ‒ Provides utility functions.

• fora.version ‒ No description.

• fora.main ‒ Provides the top-level logic of fora such as the CLI interface and main script dispatching.

• fora.remote_settings ‒ Provides a class that represents execution defaults for a remote host.

• fora.loader ‒ Provides the dynamic module loading utilities.

• fora.inventory_wrapper ‒ Provides the inventory wrapper for all inventory related functionality.

• fora.connection ‒ Provides a class to manage a remote connection via the host's connector.

• fora.types ‒ Provides a mockup of loadable module types.

• fora.logger ‒ Provides logging utilities.

• fora.example_deploys ‒ Provides example deploys, which can be used as a starting point.

Attributes

attr fora.args

fora.args: argparse.Namespace = cast(argparse.Namespace, None)

The global logger. Should be used for all user-facing information logging to ensure that this information is displayed in a proper format and according to the user's verbosity preferences.

attr fora.inventory

fora.inventory: InventoryWrapper = cast('InventoryWrapper', None)

The inventory module we are operating on. This is loaded from the inventory definition file.

attr fora.group

fora.group: GroupWrapper = cast('GroupWrapper', None)

This variable wraps the currently loaded group module. It must not be accessed anywhere else but inside the definition (source) of the actual group module.

attr fora.host

fora.host: HostWrapper = cast('HostWrapper', None)

This variable wraps the currently loaded hosts module (in case a host is just being defined), or the currently active host while executing a script. It must not be used anywhere else but inside the definition (source) of the actual module or inside of a script.

attr fora.script

fora.script: ScriptWrapper = cast('ScriptWrapper', None)

This variable wraps the currently executed script module (if any).