diff --git a/README.markdown b/README.markdown index 42e1d4e..64a252e 100644 --- a/README.markdown +++ b/README.markdown @@ -10,6 +10,15 @@ Description GitHub-Backup makes a local backup copy of all of a github user's (or github organization's) repositories. +Dependencies +---- + +GitHub-Backup requires `pygithub3` a Python library for the GitHub API v3. + +Installation is simple with + + pip install pygithub3 + Usage ----- ./github-backup.py USERNAME BACKUPDIR [-c|--cron] [-h|--help] diff --git a/github-backup.py b/github-backup.py index 2b36a6d..a6ccec3 100755 --- a/github-backup.py +++ b/github-backup.py @@ -1,18 +1,25 @@ #!/usr/bin/env python -# Author: Anthony Gargiulo (anthony@agargiulo.com) -# Created Fri Jun 15 2012 +""" +Authors: Anthony Gargiulo (anthony@agargiulo.com) + Steffen Vogel (post@steffenvogel.de) + +Created: Fri Jun 15 2012 +""" from pygithub3 import Github from argparse import ArgumentParser import os + def main(): - # A sane way to handle command line args. - # Now actually store the args parser = init_parser() args = parser.parse_args() + # Process args + if args.cron: + args.git += "--quiet" + # Make the connection to Github here. gh = Github() @@ -21,35 +28,58 @@ def main(): for repo in user_repos: process_repo(repo, args) + def init_parser(): """ set up the argument parser """ - parser = ArgumentParser( - description="makes a backup of all of a github user's repositories") + + parser = ArgumentParser(description="makes a backup of all of a github user's repositories") + parser.add_argument("username", help="A Github username") - parser.add_argument("backupdir", - help="The folder where you want your backups to go") - parser.add_argument("-c","--cron", help="Use this when running from a cron job", - action="store_true") + parser.add_argument("backupdir", help="The folder where you want your backups to go") + parser.add_argument("-c","--cron", help="Use this when running from a cron job", action="store_true") + parser.add_argument("-m","--mirror", help="Create a bare mirror", action="store_true") + parser.add_argument("-g","--git", help="Pass extra arguments to git", default="", metavar="ARGS") + parser.add_argument("-s", "--suffix", help="Add suffix to repository directory names", default="") + return parser def process_repo(repo, args): - if args.cron: - git_args = "-q" - else: - git_args = "" - if not args.cron: print("Processing repo: %s"%(repo.full_name)) - if os.access('%s/%s/.git'%(args.backupdir,repo.name),os.F_OK): + dir = "%s/%s"%(args.backupdir, repo.name + args.suffix) + config = "%s/%s"%(dir, "config" if args.mirror else ".git/config") + + if os.access(config, os.F_OK): if not args.cron: print("Repo already exists, let's try to update it instead") - os.system('cd %s/%s;git pull %s'%(args.backupdir, repo.name, git_args)) - else: # Repo doesn't exist, let's clone it - os.system('git clone %s %s %s/%s'%(git_args, repo.git_url, args.backupdir, repo.name)) + update_repo(repo, dir, args) + else: + if not args.cron: + print("Repo doesn't exists, lets clone it") + clone_repo(repo, dir, args) + + +def clone_repo(repo, dir, args): + if args.mirror: + args.git += " --mirror" + + os.system('git clone %s %s %s'%(args.git, repo.git_url, dir)) + + +def update_repo(repo, dir, args): + os.system("cd %s"%(dir,)) + + # GitHub => Local + if args.mirror: + args.git += " --prune" + os.system("git fetch %s"%(args.git,)) + else: + os.system("git pull %s"%(args.git,)) + if __name__ == "__main__": main()