githubtakeout 0.1.1__tar.gz → 0.1.3__tar.gz

{githubtakeout-0.1.1 → githubtakeout-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.1
+Version: 0.1.3
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -13,12 +13,9 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: GitPython==3.1.44
@@ -56,7 +53,7 @@ as tarballs (`.tar.gz`) using the `--format=tar` option.
 
 ## Requirements:
 
-- Python 3.9+
+- Python 3.12+
 - Git 1.7+
 - Python packages:
     - GitPython
@@ -105,6 +102,13 @@ options:
 
 ## Usage Examples:
 
+### Install from PyPI with pipx, Run:
+
+```
+pipx install githubtakeout
+githubtakeout <github username>
+```
+
 ### Create/Activate Virtual Environment, Install from PyPI, Run:
 
 ```

{githubtakeout-0.1.1 → githubtakeout-0.1.3}/README.md

@@ -29,7 +29,7 @@ as tarballs (`.tar.gz`) using the `--format=tar` option.
 
 ## Requirements:
 
-- Python 3.9+
+- Python 3.12+
 - Git 1.7+
 - Python packages:
     - GitPython
@@ -78,6 +78,13 @@ options:
 
 ## Usage Examples:
 
+### Install from PyPI with pipx, Run:
+
+```
+pipx install githubtakeout
+githubtakeout <github username>
+```
+
 ### Create/Activate Virtual Environment, Install from PyPI, Run:
 
 ```

{githubtakeout-0.1.1 → githubtakeout-0.1.3}/githubtakeout.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.1
+Version: 0.1.3
 Summary: Archive public Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -13,12 +13,9 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: GitPython==3.1.44
@@ -56,7 +53,7 @@ as tarballs (`.tar.gz`) using the `--format=tar` option.
 
 ## Requirements:
 
-- Python 3.9+
+- Python 3.12+
 - Git 1.7+
 - Python packages:
     - GitPython
@@ -105,6 +102,13 @@ options:
 
 ## Usage Examples:
 
+### Install from PyPI with pipx, Run:
+
+```
+pipx install githubtakeout
+githubtakeout <github username>
+```
+
 ### Create/Activate Virtual Environment, Install from PyPI, Run:
 
 ```

{githubtakeout-0.1.1 → githubtakeout-0.1.3}/githubtakeout.py

@@ -5,6 +5,8 @@ import getpass
 import logging
 import os
 import shutil
+import stat
+import sys
 import tarfile
 import urllib
 import zipfile
@@ -43,57 +45,86 @@ def archive(local_repo_dir, archive_format='zip', is_gist=False):
     archive_path = os.path.join(parent_dir, archive_name)
     logger.info(f'creating archive: {archive_path}')
     if archive_format == 'tar':
-        with tarfile.open(archive_path, 'w:gz') as tar:
-            tar.add(local_repo_dir, arcname=base_name)
+        with tarfile.open(archive_path, 'w:gz') as tar_archive:
+            tar_archive.add(local_repo_dir, arcname=base_name)
     elif archive_format == 'zip':
-        with zipfile.ZipFile(archive_path, 'w', zipfile.ZIP_DEFLATED) as 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))
-                zip.write(entry, arcname=path)
+                zip_archive.write(entry, arcname=path)
     return archive_path
 
 
-def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_history, is_gist=False):
-    try:
-        shutil.rmtree(local_repo_dir)
-    except FileNotFoundError:
-        pass
-    repo_path = urllib.parse.urlparse(repo_url).path
-    logger.info(f'cloning repo: {repo_path} to {local_repo_dir}')
-    start = default_timer()
+def clone(repo_url, local_repo_dir, include_history):
     try:
         if include_history:
-            git.Repo.clone_from(repo_url, local_repo_dir)
+            # full clone
+            repo = 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'))
-            except FileNotFoundError:
-                pass
+            repo = git.Repo.clone_from(repo_url, local_repo_dir, multi_options=['--depth=1'])
     except git.GitCommandError as e:
         logger.error(e)
-        return
-    elapsed = default_timer() - start
-    logger.info(f'elapsed time: {elapsed:.3f} secs')
+        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, _):
+        # 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_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
-    logger.info('')
+    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 get_user(username, prompt_token):
     if prompt_token:
         token = getpass.getpass('Token:')
         if not token:
-            print(f'Error: auth token cannot be empty')
-            exit(1)
+            sys.exit('Error: auth token cannot be empty')
         auth = github.Auth.Token(token)
         gh = github.Github(auth=auth)
     else:
@@ -108,10 +139,9 @@ def get_user(username, prompt_token):
             user = gh.get_user(username)
         except github.GithubException as e:
             if e.data['status'] == '404':
-                print(f'Error: user "{username}" not found on GitHub')
+                sys.exit(f'Error: user "{username}" not found on GitHub')
             else:
                 raise e
-            exit(1)
         repos = user.get_repos()
     else:
         # you need to be authenticated and then call the API
@@ -120,28 +150,27 @@ def get_user(username, prompt_token):
         repos = user.get_repos(affiliation='owner')
         try:
             # this just makes an API request so we can exit if unauthorized
-            repos.totalCount
+            _ = repos.totalCount
         except github.GithubException as e:
             if e.data['status'] == '401':
-                print(f'Error: invalid auth token for user "{username}" on GitHub')
+                sys.exit(f'Error: invalid auth token for user "{username}" on GitHub')
             else:
                 raise e
-            exit(1)
     gists = user.get_gists()
     return user, repos, gists, token
 
 
-def run(username, base_dir, archive_format, include_gists, include_history, list, prompt_token):
+def run(username, base_dir, archive_format, include_gists, include_history, list_only, prompt_token):
     working_dir = os.path.join(base_dir, 'backups')
     user, repos, gists, token = get_user(username, prompt_token)
     num_repos = repos.totalCount
-    if not list:
+    if not list_only:
         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)
         url = add_creds(repo.clone_url, username, token)
-        if list:
+        if list_only:
             logger.info(url)
         else:
             clone_and_archive_repo(
@@ -157,7 +186,7 @@ def run(username, base_dir, archive_format, include_gists, include_history, list
         for gist in gists:
             local_repo_dir = os.path.join(working_dir, gist.id)
             url = add_creds(gist.git_pull_url, username, token)
-            if list:
+            if list_only:
                 logger.info(url)
             else:
                 clone_and_archive_repo(
@@ -170,6 +199,8 @@ 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+')
     parser = argparse.ArgumentParser()
     parser.add_argument(
         'username',
@@ -210,15 +241,18 @@ def main():
         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=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.1 → githubtakeout-0.1.3}/pyproject.toml

@@ -4,23 +4,20 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "githubtakeout"
-version = "0.1.1"
+version = "0.1.3"
 description = "Archive public Git Repos and Gists from GitHub"
 license = "MIT"
 license-files = ["LICENSE"]
 authors = [{name = "Corey Goldberg"}]
 maintainers = [{name = "Corey Goldberg"}]
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">= 3.12"
 keywords = ["git", "github", "archive", "backup", "export", "takeout"]
 classifiers = [
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13"
 ]