Release version 0.21.1

Mark options which are not included in --all

CHANGES.rst

@@ -1,6 +1,64 @@
 Changelog
 =========
 
+0.21.1 (2018-12-25)
+-------------------
+
+- Mark options which are not included in --all. [Bernd]
+
+  As discussed in Issue #100
+
+0.21.0 (2018-11-28)
+-------------------
+
+- Correctly download repos when user arg != authenticated user. [W.
+  Harrison Wright]
+
+0.20.1 (2018-09-29)
+-------------------
+
+- Clone the specified user's gists, not the authenticated user. [W.
+  Harrison Wright]
+
+- Clone the specified user's starred repos, not the authenticated user.
+  [W. Harrison Wright]
+
+0.20.0 (2018-03-24)
+-------------------
+
+- Chore: drop Python 2.6. [Jose Diaz-Gonzalez]
+
+- Feat: simplify release script. [Jose Diaz-Gonzalez]
+
+0.19.2 (2018-03-24)
+-------------------
+
+Fix
+~~~
+
+- Cleanup pep8 violations. [Jose Diaz-Gonzalez]
+
+0.19.0 (2018-03-24)
+-------------------
+
+- Add additional output for the current request. [Robin Gloster]
+
+  This is useful to have some progress indication for huge repositories.
+
+
+- Add option to backup additional PR details. [Robin Gloster]
+
+  Some payload is only included when requesting a single pull request
+
+
+- Mark string as binary in comparison for skip_existing. [Johannes
+  Bornhold]
+
+  Found out that the flag "--skip-existing" did not work out as expected on Python
+  3.6. Tracked it down to the comparison which has to be against a string of bytes
+  in Python3.
+
+
 0.18.0 (2018-02-22)
 -------------------
 

bin/github-backup

@@ -163,11 +163,11 @@ def parse_args():
     parser.add_argument('--all-starred',
                         action='store_true',
                         dest='all_starred',
-                        help='include starred repositories in backup')
+                        help='include starred repositories in backup [*]')
     parser.add_argument('--watched',
                         action='store_true',
                         dest='include_watched',
-                        help='include watched repositories in backup')
+                        help='include JSON output of watched repositories in backup')
     parser.add_argument('--followers',
                         action='store_true',
                         dest='include_followers',
@@ -179,7 +179,7 @@ def parse_args():
     parser.add_argument('--all',
                         action='store_true',
                         dest='include_everything',
-                        help='include everything in backup')
+                        help='include everything in backup (not including [*])')
     parser.add_argument('--issues',
                         action='store_true',
                         dest='include_issues',
@@ -204,6 +204,10 @@ def parse_args():
                         action='store_true',
                         dest='include_pull_commits',
                         help='include pull request commits in backup')
+    parser.add_argument('--pull-details',
+                        action='store_true',
+                        dest='include_pull_details',
+                        help='include more pull request details in backup [*]')
     parser.add_argument('--labels',
                         action='store_true',
                         dest='include_labels',
@@ -227,7 +231,7 @@ def parse_args():
     parser.add_argument('--lfs',
                         action='store_true',
                         dest='lfs_clone',
-                        help='clone LFS repositories (requires Git LFS to be installed, https://git-lfs.github.com)')
+                        help='clone LFS repositories (requires Git LFS to be installed, https://git-lfs.github.com) [*]')
     parser.add_argument('--wikis',
                         action='store_true',
                         dest='include_wiki',
@@ -235,11 +239,11 @@ def parse_args():
     parser.add_argument('--gists',
                         action='store_true',
                         dest='include_gists',
-                        help='include gists in backup')
+                        help='include gists in backup [*]')
     parser.add_argument('--starred-gists',
                         action='store_true',
                         dest='include_starred_gists',
-                        help='include starred gists in backup')
+                        help='include starred gists in backup [*]')
     parser.add_argument('--skip-existing',
                         action='store_true',
                         dest='skip_existing',
@@ -269,11 +273,11 @@ def parse_args():
     parser.add_argument('-P', '--private',
                         action='store_true',
                         dest='private',
-                        help='include private repositories')
+                        help='include private repositories [*]')
     parser.add_argument('-F', '--fork',
                         action='store_true',
                         dest='fork',
-                        help='include forked repositories')
+                        help='include forked repositories [*]')
     parser.add_argument('--prefer-ssh',
                         action='store_true',
                         help='Clone repositories using SSH instead of HTTPS')
@@ -450,6 +454,7 @@ def _construct_request(per_page, page, query_args, template, auth):
     request = Request(template + '?' + querystring)
     if auth is not None:
         request.add_header('Authorization', 'Basic '.encode('ascii') + auth)
+    log_info('Requesting {}?{}'.format(template, querystring))
     return request
 
 
@@ -498,6 +503,12 @@ def _request_url_error(template, retry_timeout):
     return False
 
 
+def get_authenticated_user(args):
+    template = 'https://{0}/user'.format(get_github_api_host(args))
+    data = retrieve_data(args, template, single_request=True)
+    return data[0]
+
+
 def check_git_lfs_install():
     exit_code = subprocess.call(['git', 'lfs', 'version'])
     if exit_code != 0:
@@ -505,11 +516,20 @@ def check_git_lfs_install():
         sys.exit(1)
 
 
-def retrieve_repositories(args):
+def retrieve_repositories(args, authenticated_user):
     log_info('Retrieving repositories')
     single_request = False
+    if args.user == authenticated_user['login']:
+        # we must use the /user/repos API to be able to access private repos
         template = 'https://{0}/user/repos'.format(
             get_github_api_host(args))
+    else:
+        if args.private:
+            log_error('Authenticated user is different from user being backed up, thus private repositories cannot be accessed')
+        template = 'https://{0}/users/{1}/repos'.format(
+            get_github_api_host(args),
+            args.user)
+
     if args.organization:
         template = 'https://{0}/orgs/{1}/repos'.format(
             get_github_api_host(args),
@@ -525,7 +545,7 @@ def retrieve_repositories(args):
     repos = retrieve_data(args, template, single_request=single_request)
 
     if args.all_starred:
-        starred_template = 'https://{0}/user/starred'.format(get_github_api_host(args))
+        starred_template = 'https://{0}/users/{1}/starred'.format(get_github_api_host(args), args.user)
         starred_repos = retrieve_data(args, starred_template, single_request=False)
         # flag each repo as starred for downstream processing
         for item in starred_repos:
@@ -533,7 +553,7 @@ def retrieve_repositories(args):
         repos.extend(starred_repos)
 
     if args.include_gists:
-        gists_template = 'https://{0}/gists'.format(get_github_api_host(args))
+        gists_template = 'https://{0}/users/{1}/gists'.format(get_github_api_host(args), args.user)
         gists = retrieve_data(args, gists_template, single_request=False)
         # flag each repo as a gist for downstream processing
         for item in gists:
@@ -725,16 +745,17 @@ def backup_pulls(args, repo_cwd, repository, repos_template):
     pulls = {}
     _pulls_template = '{0}/{1}/pulls'.format(repos_template,
                                              repository['full_name'])
-
-    pull_states = ['open', 'closed']
-    for pull_state in pull_states:
     query_args = {
         'filter': 'all',
-            'state': pull_state,
+        'state': 'all',
         'sort': 'updated',
         'direction': 'desc',
     }
 
+    if not args.include_pull_details:
+        pull_states = ['open', 'closed']
+        for pull_state in pull_states:
+            query_args['state'] = pull_state
             # It'd be nice to be able to apply the args.since filter here...
             _pulls = retrieve_data(args,
                                    _pulls_template,
@@ -742,6 +763,17 @@ def backup_pulls(args, repo_cwd, repository, repos_template):
             for pull in _pulls:
                 if not args.since or pull['updated_at'] >= args.since:
                     pulls[pull['number']] = pull
+    else:
+        _pulls = retrieve_data(args,
+                               _pulls_template,
+                               query_args=query_args)
+        for pull in _pulls:
+            if not args.since or pull['updated_at'] >= args.since:
+                pulls[pull['number']] = retrieve_data(
+                    args,
+                    _pulls_template + '/{}'.format(pull['number']),
+                    single_request=True
+                )
 
     log_info('Saving {0} pull requests to disk'.format(
         len(list(pulls.keys()))))
@@ -831,7 +863,7 @@ def fetch_repository(name,
             clone_exists = subprocess.check_output(['git',
                                                     'rev-parse',
                                                     '--is-bare-repository'],
-                                                   cwd=local_dir) == "true\n"
+                                                   cwd=local_dir) == b"true\n"
         else:
             clone_exists = False
     else:
@@ -964,7 +996,8 @@ def main():
 
     log_info('Backing up user {0} to {1}'.format(args.user, output_directory))
 
-    repositories = retrieve_repositories(args)
+    authenticated_user = get_authenticated_user(args)
+    repositories = retrieve_repositories(args, authenticated_user)
     repositories = filter_repositories(args, repositories)
     backup_repositories(args, output_directory, repositories)
     backup_account(args, output_directory)

github_backup/__init__.py

@@ -1 +1 @@
-__version__ = '0.18.0'
+__version__ = '0.21.1'

release

@@ -1,8 +1,13 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $RELEASE_TRACE ]] && set -x
 
-PACKAGE_NAME='github-backup'
+if [[ ! -f setup.py ]]; then
-INIT_PACKAGE_NAME='github_backup'
+  echo -e "${RED}WARNING: Missing setup.py${COLOR_OFF}\n"
+  exit 1
+fi
+
+PACKAGE_NAME="$(cat setup.py | grep "name='" | head | cut -d "'" -f2)"
+INIT_PACKAGE_NAME="$(echo "${PACKAGE_NAME//-/_}")"
 PUBLIC="true"
 
 # Colors

setup.py

@@ -37,7 +37,6 @@ setup(
         'Development Status :: 5 - Production/Stable',
         'Topic :: System :: Archiving :: Backup',
         'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',