freckles.frecklet package

Submodules

freckles.frecklet.arguments module

class freckles.frecklet.arguments.CliArgumentsAttribute(target_attr_name='cli_arguments', source_attr_name='vars')

Bases: ting.ting_attributes.TingAttribute

DEFAULT_CLI_SCHEMA = {'param_type': 'option', 'show_default': True}

create_parameter(var_name, var)

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.arguments.VariablesAttribute(target_attr_name='vars_frecklet', default_argument_description=None)

Bases: ting.ting_attributes.TingAttribute

consolidate_vars(vars_tree, ting)

create_new_args_map(parent_var, key, available_args, arg)

get_attribute(ting, attribute_name=None)

get_vars_from_path(path_to_leaf, tree, ting)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

resolve_vars(current_args, rest_path, last_node, tree, ting, is_root_level)

class freckles.frecklet.arguments.VariablesFilterAttribute(source_attr_name='vars', target_attr_name='vars_required', required=True)

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.arguments.VarsAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

freckles.frecklet.describe module

freckles.frecklet.describe.create_auto_vars(params, existing_vars={}, frecklet=None)

freckles.frecklet.describe.describe_frecklet(context, frecklet, vars, auto_vars=False)

freckles.frecklet.describe.print_task_descriptions(task_desc_list)

freckles.frecklet.doc module

class freckles.frecklet.doc.FreckletDocRenderMixin(*args, **kwargs)

Bases: object

render_doc(template_name)

freckles.frecklet.doc.create_doc_jinja_env(name, template_dir, template_filters=None)

freckles.frecklet.doc.render_html(frecklet)

freckles.frecklet.doc.render_markdown(frecklet)

freckles.frecklet.doc.to_cli_help_string_filter(frecklet)

freckles.frecklet.doc.to_code_block_filter(obj, format=None)

freckles.frecklet.doc.to_repo_alias_filter(frecklet)

freckles.frecklet.doc.to_yaml_filter(obj, empty_string=None, indent=0)

freckles.frecklet.doc.vars_markdown_table(vars, vars_optional=None)

freckles.frecklet.frecklet module

class freckles.frecklet.frecklet.FreckletAugmentMetadataAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletClassNameAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletConstArgsAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletConstAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletExplodedAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletHtmlAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletMarkdownAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletMetaAttribute(default=None)

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletSrcAttribute(template_name, target_attr=None)

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletValidAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.FreckletsTemplateKeysAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.PagelingContentAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.PagelingMetadataAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.PagelingNavPathAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.frecklet.PrettyPrintFrecklet

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

freckles.frecklet.frecklet.get_src_template(template_name)

freckles.frecklet.tasks module

class freckles.frecklet.tasks.AddRootFreckletProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.CleanupFreckletProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.CommandNameProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Adds potential missing command/name keys.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.DirectParentArgsProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Adds arguments for ‘direct’ parents.

For example if a frecklet has something like:

• user-exists:

  name: “{{:: name ::}}”

Where the variable name stays the same, and no filter is involved, the args will be inherited directly.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.ExplodedArgsProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Sets the exploded args property.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.FreckletsAttribute

Bases: ting.ting_attributes.ValueAttribute

get_attribute(ting, attribute_name=None)

class freckles.frecklet.tasks.MoveEmbeddedTaskKeysProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Moves keys that start with __task__ from the vars to the task sub-dict.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.NodeCounter

Bases: object

current_count

up()

class freckles.frecklet.tasks.SpecialCaseProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Makes sure that no keywords are in vars.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

class freckles.frecklet.tasks.TaskListAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.tasks.TaskListDetailedAttribute

Bases: ting.ting_attributes.TingAttribute

FRECKLET_FORMAT = {'child_marker': 'frecklets', 'default_leaf': 'frecklet', 'default_leaf_key': 'name', 'key_move_map': {'*': ('vars', 'default')}, 'other_keys': ['args', 'doc', 'meta', 'frecklet', 'task'], 'use_context': False}

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.tasks.TaskListResolvedAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.tasks.TaskTreeAttribute

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.tasks.TaskTypePrefixProcessor(**init_params)

Bases: frkl.processors.ConfigProcessor

Adds a ‘become’: True key/value pair if the task name is all uppercase.

process_current_config()

Processes the config url or content.

Returns:processed config url or content Return type:object

freckles.frecklet.tasks.fill_defaults(task_item)

freckles.frecklet.tasks.prettyfiy_task(task_detailed, arg_map)

freckles.frecklet.vars module

class freckles.frecklet.vars.AskVarAdapter

Bases: freckles.frecklet.vars.VarAdapter

A var-adapter that asks the user to enter the value for this variable interactively.

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.FreckletDirVarAdapter

Bases: freckles.frecklet.vars.VarAdapter

An adapter that returns the path to the parent directory of the frecklet that is currently executed.

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.FreckletPathVarAdapter

Bases: freckles.frecklet.vars.VarAdapter

An adapter that returns the path to the frecklet that is currently executed.

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.Inventory

Bases: object

get_vars(hide_secrets=False, **task_context)

retrieve_value(var_name, **task_context)

secret_keys(**task_context)

set_value(var_name, new_value, is_secret=False, **task_context)

class freckles.frecklet.vars.PwdVarAdapter

Bases: freckles.frecklet.vars.VarAdapter

An adapter that returns the current directory on the machine where freckles is executed.

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.RandomPasswordVarAdapter

Bases: freckles.frecklet.vars.VarAdapter

A variable adapter that returns a random password string.

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.VarAdapter

Bases: object

retrieve_value(key_name, arg, root_arg, frecklet, is_secret=False, profile_names=None)

class freckles.frecklet.vars.VarCast(prefix)

Bases: ting.ting_cast.TingCast

VAR_ATTRS = []

class freckles.frecklet.vars.VarPathAttribute(prefix)

Bases: ting.ting_attributes.TingAttribute

get_attribute(ting, attribute_name=None)

provides()

Return a list of attributes this object will add to a Ting.

requires()

Return an list of attributes this object requires to be able to augment the Ting.

class freckles.frecklet.vars.VarsInventory(vars=None, secret_keys=None)

Bases: freckles.frecklet.vars.Inventory

retrieve_value(var_name, **task_context)

secret_keys(**task_context)

set_value(var_name, new_value, is_secret=False, **task_context)

freckles.frecklet.vars.get_resolved_var_adapter_object(value, key, arg, root_arg=True, frecklet=None, is_secret=None, inventory=None)

Replaces string in object recursively, non-jinja-termplate version.

Parameters:

• value – the object
• key – the string to be replaced
• repl – the replacement string

Returns:

the replaced object, and a boolean that indicates whether there was any change or not

Return type:

tuple

freckles.frecklet.vars.get_value_from_var_adapter(var_adapter_name, key, arg, root_arg, frecklet=None, is_secret=None, inventory=None)

freckles.frecklet.vars.get_value_from_var_adapter_string(value, key, arg, root_arg=True, frecklet=None, is_secret=None, inventory=None)

freckles.frecklet.vars.is_var_adapter(value)

freckles.frecklet.vars.load_var_adapters()

Loading a dictlet finder extension.

Returns:the extension manager holding the extensions Return type:ExtensionManager

Module contents