githubtakeout 0.1.17__tar.gz → 0.1.19__tar.gz

{githubtakeout-0.1.17/src/githubtakeout.egg-info → githubtakeout-0.1.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.17
+Version: 0.1.19
 Summary: Backup and archive Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg

{githubtakeout-0.1.17 → githubtakeout-0.1.19}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "githubtakeout"
-version = "0.1.17"
+version = "0.1.19"
 description = "Backup and archive Git Repos and Gists from GitHub"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -73,14 +73,15 @@ respect-gitignore = true
 target-version = "py312"
 
 [tool.ruff.lint]
+fixable = ["ALL"]
 select = [
-    "D", "E", "F", "I", "PT", "RUF", "TID", "W"
+    "D", "E", "F", "I", "N", "FURB", "PT",
+    "RUF", "TID", "UP", "W"
 ]
 extend-ignore = [
-    "D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107", "D203",
-    "D205", "D211", "D213", "D400", "D401", "RUF012"
+    "D100", "D101", "D102", "D103", "D105",
+    "D107", "D203", "D213", "RUF012"
 ]
-fixable = ["ALL"]
 
 [tool.ruff.format]
 docstring-code-format = true
@@ -89,6 +90,4 @@ docstring-code-line-length = 88
 [tool.refurb]
 python_version = "3.12"
 enable_all = true
-disable = [
-    "FURB104", "FURB107", "FURB147", "FURB173", "FURB183", "FURB184"
-]
+disable = []

{githubtakeout-0.1.17 → githubtakeout-0.1.19/src/githubtakeout.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.17
+Version: 0.1.19
 Summary: Backup and archive Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg

{githubtakeout-0.1.17 → githubtakeout-0.1.19}/src/githubtakeout.py

@@ -15,6 +15,7 @@ import sys
 import tarfile
 import urllib
 import zipfile
+from contextlib import suppress
 from pathlib import Path
 from timeit import default_timer
 
@@ -51,27 +52,27 @@ def add_creds(url, username, token):
     return new_url
 
 
-def archive(local_repo_dir, archive_format="zip", is_gist=False):
+def archive(local_repo_dir, archive_format="zip", archive_basename=None):
     if archive_format not in ARCHIVE_FORMATS:
         raise ValueError(f"{archive_format} is not a valid archive format")
     if archive_format == "none":
         return None
-    base_name = os.path.basename(local_repo_dir)
+    basename = local_repo_dir.stem
     extension = "tar.gz" if archive_format == "tar" else archive_format
-    archive_name = f"{base_name}.{extension}"
-    if is_gist:
-        archive_name = f"gist-{archive_name}"
-    parent_dir = os.path.dirname(local_repo_dir)
-    archive_path = os.path.join(parent_dir, archive_name)
+    if archive_basename is None:
+        archive_name = f"{basename}.{extension}"
+    else:
+        archive_name = f"{archive_basename}.{extension}"
+    archive_path = local_repo_dir.parent / archive_name
     logger.info(f"creating archive: {archive_path}")
     if archive_format == "tar":
         with tarfile.open(archive_path, "w:gz") as tar_archive:
-            tar_archive.add(local_repo_dir, arcname=base_name)
+            tar_archive.add(local_repo_dir, arcname=basename)
     elif archive_format == "zip":
         with zipfile.ZipFile(archive_path, "w", zipfile.ZIP_DEFLATED) as zip_archive:
             repo_path = Path(local_repo_dir)
             for entry in repo_path.rglob("*"):
-                path = os.path.join(base_name, entry.relative_to(repo_path))
+                path = basename / entry.relative_to(repo_path)
                 zip_archive.write(entry, arcname=path)
     return archive_path
 
@@ -97,12 +98,10 @@ def clone(repo_url, local_repo_dir, include_history):
         logger.error(e)
         sys.exit("error: failed cloning repo")
     finally:
-        try:
+        # `UnboundLocalError` can occur if we catch a signal while cloning
+        with suppress(UnboundLocalError):
             # release resources
             repo.close()
-        except UnboundLocalError:
-            # this occurs if we catch a signal while cloning
-            pass
 
 
 def pull(local_repo_dir):
@@ -115,16 +114,14 @@ def pull(local_repo_dir):
         logger.error(e)
         sys.exit("error: failed pulling changes in repo")
     finally:
-        try:
+        # `UnboundLocalError` can occur if we catch a signal while pulling
+        with suppress(UnboundLocalError):
             # release resources
             repo.close()
-        except UnboundLocalError:
-            # this occurs if we catch a signal while pulling
-            pass
 
 
 def get_and_archive_repo(
-    repo_url, local_repo_dir, archive_format, include_history, keep, is_gist=False
+    repo_url, local_repo_dir, archive_format, include_history, keep, description=None
 ):
     def remove_readonly(func, path, _):
         # This is necessary so rmtree() doesn't fail if there are any readonly
@@ -145,10 +142,8 @@ def get_and_archive_repo(
         needs_clone = False
     else:
         needs_clone = True
-        try:
+        with suppress(FileNotFoundError):
             shutil.rmtree(local_repo_dir, onexc=remove_readonly)
-        except FileNotFoundError:
-            pass
     start = default_timer()
     if needs_clone:
         logger.info(f"cloning repo: {repo_name} to: {local_repo_dir}")
@@ -158,25 +153,30 @@ def get_and_archive_repo(
         pull(local_repo_dir)
     if not include_history:
         # delete the .git directory if we are not saving history
-        try:
-            git_dir = Path(local_repo_dir, ".git")
+        git_dir = Path(local_repo_dir, ".git")
+        with suppress(FileNotFoundError):
             shutil.rmtree(git_dir, onexc=remove_readonly)
-        except FileNotFoundError:
-            pass
-    archive_path = archive(local_repo_dir, archive_format, is_gist)
+    if description:
+        # clean unsafe chars and truncate description to create a useable file name
+        clean_name = re.sub(r"[/\\?%*:|\"<>\x7F\x00-\x1F]", "-", description)[:255]
+        archive_basename = f"gist - {clean_name}"
+    else:
+        archive_basename = None
+    archive_path = archive(
+        local_repo_dir, archive_format, archive_basename=archive_basename
+    )
     if archive_path:
-        size = convert_size(os.path.getsize(archive_path))
+        size = convert_size(archive_path.stat().st_size)
         logger.info(f"archive size: {size}")
         if not keep:
+            # delete repo after archive is created
             logger.info("deleting repo")
-            try:
-                # delete repo after archive is created
+            with suppress(FileNotFoundError):
                 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")
+    logger.info(
+        f"successfully backed up '{local_repo_dir.stem}' repo in {elapsed:.3f} secs\n"
+    )
 
 
 def get_repos(username, token, include_gists):
@@ -246,7 +246,7 @@ def run(
     list_only,
     prompt_for_token,
 ):
-    working_dir = os.path.join(base_dir, "backups")
+    working_dir = base_dir / "backups"
     token = get_token(prompt_for_token)
 
     all_repos, gists = get_repos(username, token, include_gists)
@@ -262,7 +262,7 @@ def run(
         logger.info(f"creating archives in: {working_dir}\n")
     logger.info(f"found {num_repos} repos for user '{username}':\n")
     for repo in repos:
-        local_repo_dir = os.path.join(working_dir, repo.name)
+        local_repo_dir = working_dir / repo.name
         url = add_creds(repo.clone_url, username, token)
         if list_only:
             logger.info(f"{username}/{repo.name}")
@@ -274,7 +274,7 @@ def run(
         logger.info("")
         logger.info(f"found {num_gists} gists for user '{username}':\n")
         for gist in gists:
-            local_repo_dir = os.path.join(working_dir, gist.id)
+            local_repo_dir = working_dir / gist.id
             url = add_creds(gist.git_pull_url, username, token)
             if list_only:
                 logger.info(f"{username}/{gist.id}\n  - {gist.description}")
@@ -285,14 +285,11 @@ def run(
                     archive_format,
                     include_history,
                     keep,
-                    is_gist=True,
+                    description=gist.description,
                 )
 
 
 def main():
-    if sys.version_info < (3, 12):
-        sys.exit("sorry, this program requires Python 3.12+")
-
     def formatter(prog):
         return argparse.HelpFormatter(prog, max_help_position=30)
 
@@ -300,7 +297,7 @@ def main():
     parser.add_argument("username", help="github username")
     parser.add_argument(
         "--dir",
-        default=os.getcwd(),
+        default=Path.cwd(),
         help="output directory (default: .)",
     )
     parser.add_argument(
@@ -347,7 +344,7 @@ def main():
     try:
         run(
             username=args.username,
-            base_dir=args.dir,
+            base_dir=Path(args.dir),
             pattern=args.pattern,
             skip_pattern=args.skip_pattern,
             archive_format=args.format,