freckles.frecklet package¶
Submodules¶
freckles.frecklet.arguments module¶
-
class
freckles.frecklet.arguments.
CliArgumentsAttribute
(target_attr_name='cli_arguments', source_attr_name='vars_frecklet')[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
CLICK_CEREBUS_ARG_MAP
= {'boolean': <class 'bool'>, 'dict': <frutils.parameters.VarsTypeSimple object>, 'float': <class 'float'>, 'integer': <class 'int'>, 'password': <class 'str'>, 'string': <class 'str'>}¶
-
DEFAULT_CLI_SCHEMA
= {'param_type': 'option', 'show_default': True}¶
-
-
class
freckles.frecklet.arguments.
VariablesAttribute
(target_attr_name='vars_frecklet', default_argument_description=None)[source]¶ Bases:
ting.ting_attributes.TingAttribute
freckles.frecklet.describe module¶
freckles.frecklet.doc module¶
freckles.frecklet.frecklet module¶
-
class
freckles.frecklet.frecklet.
FreckletAugmentMetadataAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
FreckletExplodedAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
FreckletHtmlAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
FreckletMarkdownAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
FreckletMetaAttribute
[source]¶ Bases:
ting.ting_attributes.ValueAttribute
-
class
freckles.frecklet.frecklet.
FreckletValidAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
FreckletsTemplateKeysAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
PagelingContentAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
-
class
freckles.frecklet.frecklet.
PagelingMetadataAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
Bases:
ting.ting_attributes.TingAttribute
Return a list of attributes this object will add to a Ting.
Return an list of attributes this object requires to be able to augment the Ting.
freckles.frecklet.tasks module¶
-
class
freckles.frecklet.tasks.
AddRootFreckletProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
-
class
freckles.frecklet.tasks.
CleanupFreckletProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
-
class
freckles.frecklet.tasks.
CommandNameProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
Adds potential missing command/name keys.
-
class
freckles.frecklet.tasks.
DirectParentArgsProcessor
(**init_params)[source]¶ 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.
-
class
freckles.frecklet.tasks.
ExplodedArgsProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
Sets the exploded args property.
-
class
freckles.frecklet.tasks.
FreckletsAttribute
[source]¶ Bases:
ting.ting_attributes.ValueAttribute
-
class
freckles.frecklet.tasks.
MoveEmbeddedTaskKeysProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
Moves keys that start with __task__ from the vars to the task sub-dict.
-
class
freckles.frecklet.tasks.
SpecialCaseProcessor
(**init_params)[source]¶ Bases:
frkl.processors.ConfigProcessor
Makes sure that no keywords are in vars.
-
class
freckles.frecklet.tasks.
TaskListDetailedAttribute
[source]¶ 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}¶
-
-
class
freckles.frecklet.tasks.
TaskListResolvedAttribute
[source]¶ Bases:
ting.ting_attributes.TingAttribute
freckles.frecklet.vars module¶
-
class
freckles.frecklet.vars.
VarCast
(prefix)[source]¶ Bases:
ting.ting_cast.TingCast
-
VAR_ATTRS
= []¶
-