Release version 0.8.0

Don't store issues which are actually pull requests

CHANGES.rst

@@ -1,6 +1,29 @@
 Changelog
 =========
 
+0.8.0 (2016-02-14)
+------------------
+
+- Don't store issues which are actually pull requests. [Enrico Tröger]
+
+  This prevents storing pull requests twice since the Github API returns
+  pull requests also as issues. Those issues will be skipped but only if
+  retrieving pull requests is requested as well.
+  Closes #23.
+
+
+0.7.0 (2016-02-02)
+------------------
+
+- Softly fail if not able to read hooks. [Albert Wang]
+
+- Add note about 2-factor auth. [Albert Wang]
+
+- Make user repository search go through endpoint capable of reading
+  private repositories. [Albert Wang]
+
+- Prompt for password if only username given. [Alex Hall]
+
 0.6.0 (2015-11-10)
 ------------------
 

README.rst

@@ -23,15 +23,14 @@ CLI Usage is as follows::
     Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN]
                      [-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all]
                      [--issues] [--issue-comments] [--issue-events] [--pulls]
-                     [--pull-comments] [--pull-commits] [--repositories]
-                     [--wikis] [--labels] [--hooks] [--skip-existing]
-                     [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX]
-                     [-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F]
-                     [--prefer-ssh] [-v]
+                     [--pull-comments] [--pull-commits] [--labels] [--hooks]
+                     [--milestones] [--repositories] [--wikis]
+                     [--skip-existing] [-L [LANGUAGES [LANGUAGES ...]]]
+                     [-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY]
+                     [-P] [-F] [--prefer-ssh] [-v]
                      USER
 
-
-    Backup a github users account
+    Backup a github account
 
     positional arguments:
       USER                  github username
@@ -41,7 +40,8 @@ CLI Usage is as follows::
       -u USERNAME, --username USERNAME
                             username for basic auth
       -p PASSWORD, --password PASSWORD
-                            password for basic auth
+                            password for basic auth. If a username is given but
+                            not a password, the password will be prompted for.
       -t TOKEN, --token TOKEN
                             personal access or OAuth token
       -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
@@ -55,10 +55,12 @@ CLI Usage is as follows::
       --pulls               include pull requests in backup
       --pull-comments       include pull request review comments in backup
       --pull-commits        include pull request commits in backup
+      --labels              include labels in backup
+      --hooks               include hooks in backup (works only when
+                            authenticated)
+      --milestones          include milestones in backup
       --repositories        include repository clone in backup
       --wikis               include wiki clone in backup
-      --labels              include labels in backup
-      --hooks               include web hooks in backup (works only when authenticated)
       --skip-existing       skip project if a backup directory exists
       -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
                             only allow these languages
@@ -66,7 +68,7 @@ CLI Usage is as follows::
                             python regex to match names against
       -H GITHUB_HOST, --github-host GITHUB_HOST
                             GitHub Enterprise hostname
-      -O, --organization    whether or not this is a query for an organization
+      -O, --organization    whether or not this is an organization user
       -R REPOSITORY, --repository REPOSITORY
                             name of repository to limit backup to
       -P, --private         include private repositories
@@ -76,3 +78,8 @@ CLI Usage is as follows::
 
 
 The package can be used to backup an *entire* organization or repository, including issues and wikis in the most appropriate format (clones for wikis, json files for issues).
+
+Authentication
+==============
+
+Note: Password-based authentication will fail if you have two-factor authentication enabled.

bin/github-backup

@@ -7,6 +7,7 @@ import base64
 import calendar
 import codecs
 import errno
+import getpass
 import json
 import logging
 import os
@@ -109,7 +110,9 @@ def parse_args():
     parser.add_argument('-p',
                         '--password',
                         dest='password',
-                        help='password for basic auth')
+                        help='password for basic auth. '
+                             'If a username is given but not a password, the '
+                             'password will be prompted for.')
     parser.add_argument('-t',
                         '--token',
                         dest='token',
@@ -219,17 +222,18 @@ def parse_args():
 
 
 def get_auth(args):
-    auth = None
     if args.token:
-        auth = base64.b64encode(args.token + ':' + 'x-oauth-basic')
-    elif args.username and args.password:
-        auth = base64.b64encode(args.username + ':' + args.password)
-    elif args.username and not args.password:
-        log_error('You must specify a password for basic auth')
-    elif args.password and not args.username:
+        return base64.b64encode(args.token + ':' + 'x-oauth-basic')
+
+    if args.username:
+        if not args.password:
+            args.password = getpass.getpass()
+        return base64.b64encode(args.username + ':' + args.password)
+
+    if args.password:
         log_error('You must specify a username for basic auth')
 
-    return auth
+    return None
 
 
 def get_github_api_host(args):
@@ -378,9 +382,8 @@ def _request_url_error(template, retry_timeout):
 def retrieve_repositories(args):
     log_info('Retrieving repositories')
     single_request = False
-    template = 'https://{0}/users/{1}/repos'.format(
-        get_github_api_host(args),
-        args.user)
+    template = 'https://{0}/user/repos'.format(
+        get_github_api_host(args))
     if args.organization:
         template = 'https://{0}/orgs/{1}/repos'.format(
             get_github_api_host(args),
@@ -398,6 +401,9 @@ def retrieve_repositories(args):
 
 def filter_repositories(args, repositories):
     log_info('Filtering repositories')
+
+    repositories = [r for r in repositories if r['owner']['login'] == args.user]
+
     name_regex = None
     if args.name_regex:
         name_regex = re.compile(args.name_regex)
@@ -471,6 +477,8 @@ def backup_issues(args, repo_cwd, repository, repos_template):
     mkdir_p(repo_cwd, issue_cwd)
 
     issues = {}
+    issues_skipped = 0
+    issues_skipped_message = ''
     _issue_template = '{0}/{1}/issues'.format(repos_template,
                                               repository['full_name'])
 
@@ -485,9 +493,17 @@ def backup_issues(args, repo_cwd, repository, repos_template):
                                 _issue_template,
                                 query_args=query_args)
         for issue in _issues:
+            # skip pull requests which are also returned as issues
+            # if retrieving pull requests is requested as well
+            if 'pull_request' in issue and (args.include_pulls or args.include_everything):
+                issues_skipped += 1
+                continue
+
             issues[issue['number']] = issue
 
-    log_info('Saving {0} issues to disk'.format(len(issues.keys())))
+    if issues_skipped:
+        issues_skipped_message = ' (skipped {0} pull requests)'.format(issues_skipped)
+    log_info('Saving {0} issues to disk{1}'.format(len(issues.keys()), issues_skipped_message))
     comments_template = _issue_template + '/{0}/comments'
     events_template = _issue_template + '/{0}/events'
     for number, issue in issues.iteritems():
@@ -594,11 +610,14 @@ def backup_hooks(args, repo_cwd, repository, repos_template):
     output_file = '{0}/hooks.json'.format(hook_cwd)
     template = '{0}/{1}/hooks'.format(repos_template,
                                        repository['full_name'])
-    _backup_data(args,
-                 'hooks',
-                 template,
-                 output_file,
-                 hook_cwd)
+    try:
+        _backup_data(args,
+                     'hooks',
+                     template,
+                     output_file,
+                     hook_cwd)
+    except SystemExit:
+        log_info("Unable to read hooks, skipping")
 
 
 def fetch_repository(name, remote_url, local_dir, skip_existing=False):

github_backup/__init__.py

@@ -1 +1 @@
-__version__ = '0.6.0'
+__version__ = '0.8.0'