facio.vcs

class facio.vcs.BaseVCS(path)

Base Version Control System Class all VCS related classes should extend from, provides common API.

clone()

This class should be overridden in VCS subclass, if not a FacioException will be raised.

error(message)

Print error that does not result in an exit (Red)

Parameters:message (str) – Message to print to user

gather(message)

Common message prompting for gathering input form the end user.

Parameters:message (str) – Message to print to user

get_temp_directory()

Create a temporary directory to clone the template to.

Returns:str – Temp directory path

out(message, color=<function blue at 0x7f9c287a5848>)

Print message information to user (Blue)

Parameters:message (str) – Message to print to user

** Optional Key Word Arguments **

Parameters:color – Clint color function to use Type:function – default blue

remove_tmp_dir(origin, destination)

Template.copy callback function to remove created temp directory.

success(message)

Print a success message (Green)

Parameters:message (str) – Message to print to user

warning(message)

Print a warning message (Yellow)

Parameters:message (str) – Message to print to user

class facio.vcs.GitVCS(path)

Git Version Control System for cloning git repositories.

clone()

Clone the git repository into a temporary directory.

error(message)

Print error that does not result in an exit (Red)

Parameters:message (str) – Message to print to user

gather(message)

Common message prompting for gathering input form the end user.

Parameters:message (str) – Message to print to user

get_temp_directory()

Create a temporary directory to clone the template to.

Returns:str – Temp directory path

out(message, color=<function blue at 0x7f9c287a5848>)

Print message information to user (Blue)

Parameters:message (str) – Message to print to user

** Optional Key Word Arguments **

Parameters:color – Clint color function to use Type:function – default blue

remove_tmp_dir(origin, destination)

Template.copy callback function to remove created temp directory.

success(message)

Print a success message (Green)

Parameters:message (str) – Message to print to user

warning(message)

Print a warning message (Yellow)

Parameters:message (str) – Message to print to user

class facio.vcs.MercurialVCS(path)

Mercurial Version Control System for cloning hg repositories.

clone()

Clone the hg repository into a temporary directory.

error(message)

Print error that does not result in an exit (Red)

Parameters:message (str) – Message to print to user

gather(message)

Common message prompting for gathering input form the end user.

Parameters:message (str) – Message to print to user

get_temp_directory()

Create a temporary directory to clone the template to.

Returns:str – Temp directory path

out(message, color=<function blue at 0x7f9c287a5848>)

Print message information to user (Blue)

Parameters:message (str) – Message to print to user

** Optional Key Word Arguments **

Parameters:color – Clint color function to use Type:function – default blue

remove_tmp_dir(origin, destination)

Template.copy callback function to remove created temp directory.

success(message)

Print a success message (Green)

Parameters:message (str) – Message to print to user

warning(message)

Print a warning message (Yellow)

Parameters:message (str) – Message to print to user