124 lines
3.6 KiB
Executable File

#!/usr/bin/env python
Authors: Anthony Gargiulo (
Steffen Vogel (
Created: Fri Jun 15 2012
from pygithub3 import Github
from argparse import ArgumentParser
import subprocess
import os
def main():
parser = init_parser()
args = parser.parse_args()
# Process args
if args.cron:
# Make the connection to Github here.
config = { 'user': args.username }
args.backupdir = args.backupdir.rstrip("/")
if (args.token):
config['token'] = args.token
if (args.password):
config['password'] = args.password
config['login'] = args.username
gh = Github(**config)
# Get all of the given user's repos
if args.organization:
user_repos = gh.repos.list_by_org(args.organization).all()
user_repos = gh.repos.list().all()
for repo in user_repos:
repo.user = gh.users.get(repo.owner.login)
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.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("-m", "--mirror", help="Create a bare mirror", action="store_true")
parser.add_argument("-S", "--ssh", help="Use SSH protocol", 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="")
parser.add_argument("-P", "--prefix", help="Add prefix to repository directory names", default="")
parser.add_argument("-p", "--password", help="Authenticate with Github API")
parser.add_argument("-t", "--token", help="OAuth token for authentification")
parser.add_argument("-o", "--organization", help="Backup Organizational repositories", metavar="ORG")
return parser
def process_repo(repo, args):
if not args.cron:
print("Processing repo: %s"%(repo.full_name))
dir = "%s/%s"%(args.backupdir, args.prefix + + args.suffix)
config = "%s/%s"%(dir, "config" if args.mirror else ".git/config")
if not os.access(config, os.F_OK):
if not args.cron: print("Repo doesn't exists, lets clone it")
clone_repo(repo, dir, args)
if not args.cron: print("Repo already exists, let's try to update it instead")
update_repo(repo, dir, args)
def clone_repo(repo, dir, args):
params = [repo.repo.ssh_url if args.ssh else repo.git_url, dir]
if args.mirror:
params.insert(0, ["--mirror"])
git("clone", params, args.git, dir)
def update_repo(repo, dir, args):
# GitHub => Local
# TODO: use subprocess package and fork git into background (major performance boost expected)
if args.mirror:
git("fetch", ["--prune"], args.git, dir)
git("pull", gargs=args.git, gdir=dir)
# Fetch description and owner (useful for gitweb, cgit etc.)
git("config", ["--local", "gitweb.description", repo.description], gdir=dir)
git("config", ["--local", "gitweb.owner", "%s <%s>"%(,"utf-8"))], gdir=dir)
git("config", ["--local", "",], gdir=dir)
git("config", ["--local", "cgit.defbranch", repo.default_branch], gdir=dir)
git("config", ["--local", "cgit.clone-url", repo.clone_url], gdir=dir)
def git(gcmd, args=[], gargs=[], gdir=""):
cmd = ["git"]
if (gdir):
if __name__ == "__main__":