githubtakeout 0.1.9__tar.gz → 0.1.11__tar.gz

{githubtakeout-0.1.9/src/githubtakeout.egg-info → githubtakeout-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.9
+Version: 0.1.11
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -21,7 +21,6 @@ License-File: LICENSE
 Requires-Dist: GitPython==3.1.45
 Requires-Dist: PyGithub==2.8.1
 Requires-Dist: rich==14.1.0
-Requires-Dist: tenacity==9.1.2
 Dynamic: license-file
 
 # githubtakeout

{githubtakeout-0.1.9 → githubtakeout-0.1.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "githubtakeout"
-version = "0.1.9"
+version = "0.1.11"
 description = "Archive public Git Repos and Gists from GitHub"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -25,7 +25,6 @@ dependencies = [
     "GitPython==3.1.45",
     "PyGithub==2.8.1",
     "rich==14.1.0",
-    "tenacity==9.1.2",
 ]
 
 [project.scripts]
@@ -40,18 +39,24 @@ download = "https://pypi.org/project/githubtakeout"
 package-dir = {"" = "src"}
 
 [tool.black]
-line-length = 88
+line-length = 120
 target-version = ["py39", "py310", "py311", "py312", "py313"]
 
 [tool.ruff]
-line-length = 88
+line-length = 120
 respect-gitignore = true
 target-version = "py312"
 
 [tool.ruff.lint]
-extend-select = ["E4", "E7", "E9", "F", "I", "E501", "RUF022"]
+select = [
+    "D", "E", "F", "I", "PT", "RUF", "TID", "W"
+]
+extend-ignore = [
+    "D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107", "D203",
+    "D205", "D211", "D213", "D400", "D401", "RUF012"
+]
 fixable = ["ALL"]
 
 [tool.ruff.format]
 docstring-code-format = true
-docstring-code-line-length = 88
+docstring-code-line-length = 120

{githubtakeout-0.1.9 → githubtakeout-0.1.11/src/githubtakeout.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.9
+Version: 0.1.11
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -21,7 +21,6 @@ License-File: LICENSE
 Requires-Dist: GitPython==3.1.45
 Requires-Dist: PyGithub==2.8.1
 Requires-Dist: rich==14.1.0
-Requires-Dist: tenacity==9.1.2
 Dynamic: license-file
 
 # githubtakeout

{githubtakeout-0.1.9 → githubtakeout-0.1.11}/src/githubtakeout.egg-info/requires.txt

@@ -1,4 +1,3 @@
 GitPython==3.1.45
 PyGithub==2.8.1
 rich==14.1.0
-tenacity==9.1.2

{githubtakeout-0.1.9 → githubtakeout-0.1.11}/src/githubtakeout.py

@@ -1,7 +1,7 @@
-# Corey Goldberg, 2025
+# Copyright (c) 2015-2025 Corey Goldberg
 # License: MIT
 
-"""Archive Git Repos and Gists from GitHub"""
+"""Archive Git Repos and Gists from GitHub."""
 
 import argparse
 import getpass
@@ -19,7 +19,6 @@ from timeit import default_timer
 
 import git
 import github
-from tenacity import retry, stop_after_attempt, wait_fixed
 
 from progress import GitProgress
 
@@ -33,7 +32,7 @@ def convert_size(size_bytes):
     if size_bytes == 0:
         return "0 B"
     size_name = ("B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB")
-    i = int(math.floor(math.log(size_bytes, 1024)))
+    i = math.floor(math.log(size_bytes, 1024))
     p = math.pow(1024, i)
     s = round(size_bytes / p, 2)
     return f"{s} {size_name[i]}"
@@ -50,52 +49,6 @@ def add_creds(url, username, token):
     return new_url
 
 
-def clone_and_archive_repo(
-    repo_url, local_repo_dir, archive_format, include_history, is_gist=False
-):
-    def remove_readonly(func, path, _):
-        # 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_name = urllib.parse.urlparse(repo_url).path.lstrip("/")
-    logger.info(f"cloning repo: {repo_name} to {local_repo_dir}")
-    start = default_timer()
-    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 = convert_size(os.path.getsize(archive_path))
-    logger.info(f"archive size: {size}")
-    logger.info("deleting repo")
-    try:
-        # delete repo after archive is created
-        shutil.rmtree(local_repo_dir, onexc=remove_readonly)
-    except FileNotFoundError:
-        pass
-    elapsed = default_timer() - start
-    base_name = os.path.basename(local_repo_dir)
-    logger.info(f"successfully backed up '{base_name}' repo in {elapsed:.3f} secs\n")
-
-
 def archive(local_repo_dir, archive_format="zip", is_gist=False):
     if archive_format not in ARCHIVE_FORMATS:
         raise ValueError(f"{archive_format} is not a valid archive format")
@@ -119,7 +72,6 @@ def archive(local_repo_dir, archive_format="zip", is_gist=False):
     return archive_path
 
 
-@retry(stop=stop_after_attempt(5), wait=wait_fixed(2))
 def clone(repo_url, local_repo_dir, include_history):
     try:
         if include_history:
@@ -149,27 +101,68 @@ def clone(repo_url, local_repo_dir, include_history):
             pass
 
 
-@retry(stop=stop_after_attempt(5), wait=wait_fixed(2))
-def count_repos(repos):
-    return repos.totalCount
+def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_history, is_gist=False):
+    def remove_readonly(func, path, _):
+        # 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_name = urllib.parse.urlparse(repo_url).path.lstrip("/")
+    logger.info(f"cloning repo: {repo_name} to {local_repo_dir}")
+    start = default_timer()
+    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 = convert_size(os.path.getsize(archive_path))
+    logger.info(f"archive size: {size}")
+    logger.info("deleting repo")
+    try:
+        # delete repo after archive is created
+        shutil.rmtree(local_repo_dir, onexc=remove_readonly)
+    except FileNotFoundError:
+        pass
+    elapsed = default_timer() - start
+    base_name = os.path.basename(local_repo_dir)
+    logger.info(f"successfully backed up '{base_name}' repo in {elapsed:.3f} secs\n")
 
 
-@retry(stop=stop_after_attempt(5), wait=wait_fixed(2))
-def get_user(username, prompt_token):
-    if prompt_token:
-        token = getpass.getpass("Token:")
-        if not token:
-            sys.exit("error: auth token cannot be empty")
+def get_repos(username, token, include_gists):
+    if token is not None:
+        # you need to be authenticated and then call the API
+        # with no username to get public and private repos
         auth = github.Auth.Token(token)
         gh = github.Github(auth=auth)
+        user = gh.get_user()
+        repos = user.get_repos(affiliation="owner")
+        try:
+            # this just makes an API request so we can exit if unauthorized
+            _ = repos.totalCount
+        except github.GithubException as e:
+            if e.data["status"] == "401":
+                sys.exit(f"error: invalid auth token for user '{username}'")
+            else:
+                raise e
     else:
-        token = os.getenv("GITHUB_TOKEN")
-        if token is not None:
-            auth = github.Auth.Token(token)
-            gh = github.Github(auth=auth)
-        else:
-            gh = github.Github()
-    if token is None:
+        gh = github.Github()
         try:
             user = gh.get_user(username)
         except github.GithubException as e:
@@ -178,21 +171,21 @@ def get_user(username, prompt_token):
             else:
                 raise e
         repos = user.get_repos()
+    if include_gists:
+        gists = user.get_gists()
     else:
-        # you need to be authenticated and then call the API
-        # with no username to get private repos
-        user = gh.get_user()
-        repos = user.get_repos(affiliation="owner")
-        try:
-            # this just makes an API request so we can exit if unauthorized
-            _ = count_repos(repos)
-        except github.GithubException as e:
-            if e.data["status"] == "401":
-                sys.exit(f"error: invalid auth token for user '{username}'")
-            else:
-                raise e
-    gists = user.get_gists()
-    return user, repos, gists, token
+        gists = None
+    return repos, gists
+
+
+def get_token(prompt_for_token):
+    if prompt_for_token:
+        token = getpass.getpass("Token:")
+        if not token:
+            sys.exit("error: auth token cannot be empty")
+    else:
+        token = os.getenv("GITHUB_TOKEN")
+    return token
 
 
 def run(
@@ -202,11 +195,12 @@ def run(
     include_gists,
     include_history,
     list_only,
-    prompt_token,
+    prompt_for_token,
 ):
     working_dir = os.path.join(base_dir, "backups")
-    user, repos, gists, token = get_user(username, prompt_token)
-    num_repos = count_repos(repos)
+    token = get_token(prompt_for_token)
+    repos, gists = get_repos(username, token, include_gists)
+    num_repos = repos.totalCount
     if not list_only:
         logger.info(f"creating archives in: {working_dir}\n")
     logger.info(f"found {num_repos} repos for user '{username}'\n")
@@ -217,8 +211,8 @@ def run(
             logger.info(url)
         else:
             clone_and_archive_repo(url, local_repo_dir, archive_format, include_history)
-    if include_gists:
-        num_gists = count_repos(gists)
+    if gists is not None:
+        num_gists = gists.totalCount
         logger.info("")
         logger.info(f"found {num_gists} gists for user '{username}'\n")
         for gist in gists:
@@ -227,9 +221,7 @@ def run(
             if list_only:
                 logger.info(url)
             else:
-                clone_and_archive_repo(
-                    url, local_repo_dir, archive_format, include_history, is_gist=True
-                )
+                clone_and_archive_repo(url, local_repo_dir, archive_format, include_history, is_gist=True)
 
 
 def main():
@@ -248,21 +240,15 @@ def main():
         default="zip",
         help="archive format (default: %(default)s)",
     )
-    parser.add_argument(
-        "--gists", action="store_true", default=False, help="include gists"
-    )
+    parser.add_argument("--gists", action="store_true", default=False, help="include gists")
     parser.add_argument(
         "--history",
         action="store_true",
         default=False,
         help="include commit history and branches (.git directory)",
     )
-    parser.add_argument(
-        "--list", action="store_true", default=False, help="list repos only"
-    )
-    parser.add_argument(
-        "--token", action="store_true", default=False, help="prompt for auth token"
-    )
+    parser.add_argument("--list", action="store_true", default=False, help="list repos only")
+    parser.add_argument("--token", action="store_true", default=False, help="prompt for auth token")
     args = parser.parse_args()
     try:
         run(
@@ -272,7 +258,7 @@ def main():
             include_gists=args.gists,
             include_history=args.history,
             list_only=args.list,
-            prompt_token=args.token,
+            prompt_for_token=args.token,
         )
     except KeyboardInterrupt:
         sys.exit("\nexiting program ...")

{githubtakeout-0.1.9 → githubtakeout-0.1.11}/src/progress.py

@@ -1,8 +1,12 @@
+# Copyright (c) 2025 Corey Goldberg
+# License: MIT
+# adapted from: https://stackoverflow.com/a/71285627/16148
+
+"""Progress bar for cloning Git repos."""
+
 import git
 from rich import console, progress
 
-# adapted from: https://stackoverflow.com/a/71285627/16148
-
 
 class GitProgress(git.RemoteProgress):
     OP_CODES = [
@@ -16,9 +20,7 @@ class GitProgress(git.RemoteProgress):
         "RESOLVING",
         "WRITING",
     ]
-    OP_CODE_MAP = {
-        getattr(git.RemoteProgress, _op_code): _op_code for _op_code in OP_CODES
-    }
+    OP_CODE_MAP = {getattr(git.RemoteProgress, _op_code): _op_code for _op_code in OP_CODES}
 
     def __init__(self):
         super().__init__()