git_helper

git_helper.get_commandline_output(command_list)

Takes a command line entry separated into list entries, and returns the output from the command line as a string

Parameters:command_list (list of strings) – list of strings that when combined form a coherent command to input into the command line Returns:output – the output result of running the command Return type:string

git_helper.get_gitdict()

Get the git dictionary that was created by setup.py and/or during pip install and was stored in a json file

Returns:git_dict – A dictionary containing git information with keywords: describe, date, branch Return type:dictionary

git_helper.make_gitdict()

Makes a dictionary containing key git information about the repo by running specific commands on the command line

Returns:git_dict – A dictionary containing git information with keywords: describe, date, branch Return type:dictionary

git_helper.print_version_info(script_loc)

Takes the location of the script calling this function, and prints out useful git information

Parameters:script_loc (string) – Absolute path of the file calling this function

git_helper.write_git_header(outfile)

Takes a textfile and writes a git summary at the top, commented with #

Parameters:outfile (text file instance) – Text file that gets useful version information appended to it