githubtakeout 0.1.2__tar.gz → 0.1.4__tar.gz

{githubtakeout-0.1.2 → githubtakeout-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.2
+Version: 0.1.4
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg

{githubtakeout-0.1.2 → githubtakeout-0.1.4}/githubtakeout.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.2
+Version: 0.1.4
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg

{githubtakeout-0.1.2 → githubtakeout-0.1.4}/githubtakeout.py

@@ -56,37 +56,63 @@ def archive(local_repo_dir, archive_format='zip', is_gist=False):
     return archive_path
 
 
+def clone(repo_url, local_repo_dir, include_history):
+    try:
+        if include_history:
+            # full clone
+            repo = git.Repo.clone_from(repo_url, local_repo_dir)
+        else:
+            # shallow clone (no commit history or branches)
+            repo = git.Repo.clone_from(repo_url, local_repo_dir, multi_options=['--depth=1'])
+    except git.GitCommandError as e:
+        logger.error(e)
+        sys.exit('Error: failed cloning repo')
+    finally:
+        try:
+            # release resources
+            repo.close()
+        except UnboundLocalError:
+            # this occurs if we catch a signal while cloning
+            pass
+
+
+
 def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_history, is_gist=False):
     def remove_readonly(func, path, _):
-        # clear the readonly bit and reattempt removal
+        # This is necessary so rmtree() doesn't fail if there are any readonly
+        # dirs/files when trying to delete. This seems to happen after cloning on
+        # Windows. When any error occurs during deletion, we change the permissions
+        # and and reattempt removal.
+        #
+        # give read permissions
+        os.chmod(path, stat.S_IREAD)
+        # give write permissions
         os.chmod(path, stat.S_IWRITE)
+        # try again
         func(path)
     try:
+        # delete repo if it already exists
         shutil.rmtree(local_repo_dir, onexc=remove_readonly)
     except FileNotFoundError:
         pass
-    repo_path = urllib.parse.urlparse(repo_url).path
-    logger.info(f'cloning repo: {repo_path} to {local_repo_dir}')
+    repo_name = urllib.parse.urlparse(repo_url).path.lstrip('/')
+    logger.info(f'cloning repo: {repo_name} to {local_repo_dir}')
     start = default_timer()
-    try:
-        if include_history:
-            git.Repo.clone_from(repo_url, local_repo_dir)
-        else:
-            # shallow clone (no commit history or branches)
-            git.Repo.clone_from(repo_url, local_repo_dir, multi_options=['--depth=1'])
-            try:
-                shutil.rmtree(os.path.join(local_repo_dir, '.git'), onexc=remove_readonly)
-            except FileNotFoundError:
-                pass
-    except git.GitCommandError as e:
-        logger.error(e)
-        return
+    clone(repo_url, local_repo_dir, include_history)
+    if not include_history:
+        # delete the .git directory if we are not saving history
+        try:
+            git_dir = os.path.join(local_repo_dir, '.git')
+            shutil.rmtree(git_dir, onexc=remove_readonly)
+        except FileNotFoundError:
+            pass
     archive_path = archive(local_repo_dir, archive_format, is_gist)
     size_kb = os.path.getsize(archive_path) / 1024
     logger.info(f'archive size: {size_kb:.2f} KB')
     logger.info('deleting repo')
     try:
-        shutil.rmtree(local_repo_dir)
+        # delete repo after archive is created
+        shutil.rmtree(local_repo_dir, onexc=remove_readonly)
     except FileNotFoundError:
         pass
     elapsed = default_timer() - start
@@ -174,11 +200,11 @@ def run(username, base_dir, archive_format, include_gists, include_history, list
 
 def main():
     if sys.version_info < (3, 12):
-        sys.exit('Sorry, this program requires Python 3.12+')
+        sys.exit('sorry, this program requires Python 3.12+')
     parser = argparse.ArgumentParser()
     parser.add_argument(
         'username',
-        help='GitHub username'
+        help='github username'
     )
     parser.add_argument(
         '--dir',
@@ -192,38 +218,41 @@ def main():
     )
     parser.add_argument(
         '--gists',
-        default=False,
         action='store_true',
+        default=False,
         help='include gists'
     )
     parser.add_argument(
         '--history',
-        default=False,
         action='store_true',
+        default=False,
         help='include commit history and branches (.git directory)'
     )
     parser.add_argument(
         '--list',
-        default=False,
         action='store_true',
+        default=False,
         help='list repos only'
     )
     parser.add_argument(
         '--token',
-        default=False,
         action='store_true',
+        default=False,
         help='prompt for auth token'
     )
     args = parser.parse_args()
-    run(
-        username=args.username,
-        base_dir=args.dir,
-        archive_format=args.format,
-        include_gists=args.gists,
-        include_history=args.history,
-        list_only=args.list,
-        prompt_token=args.token
-    )
+    try:
+        run(
+            username=args.username,
+            base_dir=args.dir,
+            archive_format=args.format,
+            include_gists=args.gists,
+            include_history=args.history,
+            list_only=args.list,
+            prompt_token=args.token
+        )
+    except KeyboardInterrupt:
+        sys.exit('\nexiting program ...')
 
 
 if __name__ == '__main__':

{githubtakeout-0.1.2 → githubtakeout-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "githubtakeout"
-version = "0.1.2"
+version = "0.1.4"
 description = "Archive public Git Repos and Gists from GitHub"
 license = "MIT"
 license-files = ["LICENSE"]