Configuration file template object model.
-
class confab.conffiles.ConfFile(template, data)[source]
Bases: object
Encapsulation of a configuration file template.
-
diff(generated_dir, remotes_dir, output=False)[source]
Compute the diff between the generated and remote files.
If output is enabled, show the diffs nicely.
-
generate(generated_dir)[source]
Write the configuration file to the dest_dir.
-
pull(remotes_dir)[source]
Pull remote configuration file to local file.
-
push(generated_dir)[source]
Push the generated configuration file to the remote host.
-
class confab.conffiles.ConfFileDiff(remote_file_name, generated_file_name, conffile_name)[source]
Bases: object
Encapsulation of the differences between the (locally copied) remote and
generated versions of a configuration file.
-
show()[source]
Print the diff using pretty colors.
If confab is used on binary files, diffs are likely to render poorly.
-
class confab.conffiles.ConfFiles(environment_loader, data_loader)[source]
Bases: object
Encapsulation of a set of configuration files.
-
diff(generated_dir, remotes_dir)[source]
Show diffs for all configuration files.
-
generate(generated_dir)[source]
Write all configuration files to generated_dir.
-
pull(remotes_dir)[source]
Pull remote versions of files into remotes_dir.
-
push(generated_dir, remotes_dir)[source]
Push configuration files that have changes, given user confirmation.