freckles package

Subpackages

• freckles.adapters package
  • Subpackages
    • freckles.adapters.freckles package
      • Submodules
      • freckles.adapters.freckles.freckles_adapter_freckles module
      • Module contents
    • freckles.adapters.shell package
      • Submodules
      • freckles.adapters.shell.freckles_adapter_shell module
      • freckles.adapters.shell.processors module
      • freckles.adapters.shell.shell_runner module
      • Module contents
  • Submodules
  • freckles.adapters.adapters module
  • Module contents
• freckles.context package
  • Submodules
  • freckles.context.config module
  • freckles.context.freckles_context module
  • Module contents
• freckles.frecklet package
  • Submodules
  • freckles.frecklet.arguments module
  • freckles.frecklet.describe module
  • freckles.frecklet.doc module
  • freckles.frecklet.frecklet module
  • freckles.frecklet.tasks module
  • freckles.frecklet.vars module
  • Module contents
• freckles.utils package
  • Submodules
  • freckles.utils.doc_utils module
  • freckles.utils.host_utils module
  • freckles.utils.profile module
  • freckles.utils.utils module
  • freckles.utils.versions module
  • Module contents

Submodules

freckles.defaults module

freckles.exceptions module

exception freckles.exceptions.FrecklesConfigException(keys=None, msg=None, solution=None, reason=None, references=None)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.FrecklesPermissionException(key=None, msg=None, solution=None, reason=None, addition_references=None)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.FrecklesUnlockException(message)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.FrecklesVarException(frecklet=None, var_name=None, message=None, errors=None, task_path=None, vars=None, task=None)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.FreckletBuildException(frecklet, msg, solution=None, reason=None, references=None)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.FreckletException(frecklet, parent_exception, frecklet_name)

Bases: frutils.exceptions.FrklException

exception freckles.exceptions.InvalidFreckletException(frecklet, parent_exception, frecklet_name=None)

Bases: frutils.exceptions.FrklException

freckles.frecklecutable module

class freckles.frecklecutable.Frecklecutable(frecklet, context)

Bases: object

check_become_pass(run_config, run_secrets, parent_task)

context

frecklet

process_tasks(inventory)

Calculates the tasklist for a given inventory.

run(inventory, run_config, run_vars=None, parent_task=None, elevated=None, env_dir=None)

class freckles.frecklecutable.FrecklecutableMixin(*args, **kwargs)

Bases: object

create_frecklecutable(context)

freckles.frecklecutable.ask_password(prompt)

freckles.frecklecutable.is_duplicate_task(new_task, idempotency_cache)

freckles.frecklecutable.remove_none_values(input)

freckles.freckles module

class freckles.freckles.Freckles(use_community=False, default_context_config=None, extra_repos=None)

Bases: object

create_context(context_name, context_config, set_current=False, extra_repos=None, use_community=False)

create_frecklecutable(frecklet_name, context_name=None)

current_context

frecklets

get_context(context_name=None)

get_frecklet(frecklet_name, context_name=None)

get_frecklet_index(context_name=None)

freckles.output_callback module

class freckles.output_callback.FrecklesResultCallback(result_strategy='merge')

Bases: object

Class to gather results of a frecklecute run.

Parameters:add_strategy –

add_result(overlay_dict)

finish_up()

class freckles.output_callback.FrecklesRun(run_id, adapter_name, task_list, run_vars, run_config, run_env, run_properties)

Bases: object

freckles.schemas module

Module contents

freckles.print_version(ctx, param, value)