gen_buildinfo.py

# Generates build information for LaTeX
#
# @author Connor Henley, @thatging3rkid
import datetime
import subprocess

def sanitize(s):
    """
    Sanitize a given string for use in LaTeX

    :param: s the string to sanitize
    :returns: a LaTeX-safe string
    """
    s = s.replace("_", "\\_")
    return s

def main():
    # first, print some debugging infro
    print("%%% buildinfo.tex\n%%%\n%%% Generated by gen_buildinfo.py on " + str(datetime.datetime.now()) + "\n")

    # next, get the current git state
    git_describe = "*error\\_getting\\_version*"
    git_branch = "*branch\\_error*"
    try:
        git_describe = subprocess.check_output(["git", "describe", "--tags", "--long"]).strip().decode("utf-8")
        git_branch = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"]).strip().decode("utf-8")
    except:
        pass

    # we need to sanitize the inputs
    git_describe = sanitize(git_describe)
    git_branch = sanitize(git_branch)

    # finally, print the footers
    footer = "version: \\texttt{"+ git_describe +"}";
    if git_branch != "master":
        footer += " on branch \\texttt{"+ git_branch +"}"
    print("\\lfoot{" + footer + "}")

if __name__ == "__main__":
    main()