githubtakeout 0.1.15__tar.gz → 0.1.17__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.15
+Version: 0.1.17
 Summary: Backup and archive Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -21,6 +21,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: GitPython==3.1.45
 Requires-Dist: PyGithub==2.8.1
+Requires-Dist: python-dotenv==1.2.1
 Requires-Dist: rich==14.2.0
 Dynamic: license-file
 
@@ -57,6 +58,10 @@ Archives are saved in compressed zip format (`.zip`) by default. You can also
 save as tarballs (`.tar.gz`) using the `--format=tar` option, or skip archiving
 using the `--format=none` option.
 
+If a repo with history exists from a previous run, it will pull new changes.
+Otherwise, it will clone the repo. Use the `--keep` if you don't want repos
+deleted after an archive is created.
+
 ## Requirements:
 
 - Python 3.12+
@@ -83,13 +88,24 @@ can set the `GITHUB_TOKEN` environment variable:
 $ export GITHUB_TOKEN=<access token>
 ```
 
+You can also set this in an `.env` file in the current directory. It should
+contain:
+
+```
+GITHUB_TOKEN=<access token>
+```
+
 If you prefer to be prompted for your token each time you run the program, use
 the `--token` argument.
 
 ## CLI Options:
 
 ```
-usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--format {tar,zip,none}] [--gists] [--history] [--list] [--token] username
+$ githubtakeout --help
+usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--skip_pattern PATTERN]
+                     [--format {tar,zip,none}] [--gists] [--history]
+                     [--skip_forks] [--keep] [--list] [--token]
+                     username
 
 positional arguments:
   username                 github username
@@ -97,10 +113,13 @@ positional arguments:
 options:
   -h, --help               show this help message and exit
   --dir DIR                output directory (default: .)
-  --pattern PATTERN        regex matching repo names (default: .*)
+  --pattern PATTERN        regex matching repo names to include
+  --skip_pattern PATTERN   regex matching repo names to skip
   --format {tar,zip,none}  archive format (default: zip)
   --gists                  include gists
   --history                include commit history and branches (.git directory)
+  --skip_forks             skip repos that are forks
+  --keep                   keep repos after archiving
   --list                   list repos only
   --token                  prompt for auth token
 ```

{githubtakeout-0.1.15 → githubtakeout-0.1.17}/README.md

@@ -31,6 +31,10 @@ Archives are saved in compressed zip format (`.zip`) by default. You can also
 save as tarballs (`.tar.gz`) using the `--format=tar` option, or skip archiving
 using the `--format=none` option.
 
+If a repo with history exists from a previous run, it will pull new changes.
+Otherwise, it will clone the repo. Use the `--keep` if you don't want repos
+deleted after an archive is created.
+
 ## Requirements:
 
 - Python 3.12+
@@ -57,13 +61,24 @@ can set the `GITHUB_TOKEN` environment variable:
 $ export GITHUB_TOKEN=<access token>
 ```
 
+You can also set this in an `.env` file in the current directory. It should
+contain:
+
+```
+GITHUB_TOKEN=<access token>
+```
+
 If you prefer to be prompted for your token each time you run the program, use
 the `--token` argument.
 
 ## CLI Options:
 
 ```
-usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--format {tar,zip,none}] [--gists] [--history] [--list] [--token] username
+$ githubtakeout --help
+usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--skip_pattern PATTERN]
+                     [--format {tar,zip,none}] [--gists] [--history]
+                     [--skip_forks] [--keep] [--list] [--token]
+                     username
 
 positional arguments:
   username                 github username
@@ -71,10 +86,13 @@ positional arguments:
 options:
   -h, --help               show this help message and exit
   --dir DIR                output directory (default: .)
-  --pattern PATTERN        regex matching repo names (default: .*)
+  --pattern PATTERN        regex matching repo names to include
+  --skip_pattern PATTERN   regex matching repo names to skip
   --format {tar,zip,none}  archive format (default: zip)
   --gists                  include gists
   --history                include commit history and branches (.git directory)
+  --skip_forks             skip repos that are forks
+  --keep                   keep repos after archiving
   --list                   list repos only
   --token                  prompt for auth token
 ```

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "githubtakeout"
-version = "0.1.15"
+version = "0.1.17"
 description = "Backup and archive Git Repos and Gists from GitHub"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -25,6 +25,7 @@ classifiers = [
 dependencies = [
     "GitPython==3.1.45",
     "PyGithub==2.8.1",
+    "python-dotenv==1.2.1",
     "rich==14.2.0",
 ]
 
@@ -45,6 +46,9 @@ lint = [
     "refurb",
     "ruff",
 ]
+test = [
+    "pytest",
+]
 validate = [
     "packaging",
     "validate-pyproject",
@@ -53,14 +57,18 @@ validate = [
 [tool.setuptools]
 package-dir = {"" = "src"}
 
+[tool.pytest.ini_options]
+addopts = "-vv" # extra verbose
+tmp_path_retention_policy = "none"
+
 [tool.black]
-line-length = 120
+line-length = 88
 target-version = [
     "py312", "py313", "py314"
 ]
 
 [tool.ruff]
-line-length = 120
+line-length = 88
 respect-gitignore = true
 target-version = "py312"
 
@@ -76,10 +84,10 @@ fixable = ["ALL"]
 
 [tool.ruff.format]
 docstring-code-format = true
-docstring-code-line-length = 120
+docstring-code-line-length = 88
 
 [tool.refurb]
-python_version = "3.9"
+python_version = "3.12"
 enable_all = true
 disable = [
     "FURB104", "FURB107", "FURB147", "FURB173", "FURB183", "FURB184"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: githubtakeout
-Version: 0.1.15
+Version: 0.1.17
 Summary: Backup and archive Git Repos and Gists from GitHub
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -21,6 +21,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: GitPython==3.1.45
 Requires-Dist: PyGithub==2.8.1
+Requires-Dist: python-dotenv==1.2.1
 Requires-Dist: rich==14.2.0
 Dynamic: license-file
 
@@ -57,6 +58,10 @@ Archives are saved in compressed zip format (`.zip`) by default. You can also
 save as tarballs (`.tar.gz`) using the `--format=tar` option, or skip archiving
 using the `--format=none` option.
 
+If a repo with history exists from a previous run, it will pull new changes.
+Otherwise, it will clone the repo. Use the `--keep` if you don't want repos
+deleted after an archive is created.
+
 ## Requirements:
 
 - Python 3.12+
@@ -83,13 +88,24 @@ can set the `GITHUB_TOKEN` environment variable:
 $ export GITHUB_TOKEN=<access token>
 ```
 
+You can also set this in an `.env` file in the current directory. It should
+contain:
+
+```
+GITHUB_TOKEN=<access token>
+```
+
 If you prefer to be prompted for your token each time you run the program, use
 the `--token` argument.
 
 ## CLI Options:
 
 ```
-usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--format {tar,zip,none}] [--gists] [--history] [--list] [--token] username
+$ githubtakeout --help
+usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--skip_pattern PATTERN]
+                     [--format {tar,zip,none}] [--gists] [--history]
+                     [--skip_forks] [--keep] [--list] [--token]
+                     username
 
 positional arguments:
   username                 github username
@@ -97,10 +113,13 @@ positional arguments:
 options:
   -h, --help               show this help message and exit
   --dir DIR                output directory (default: .)
-  --pattern PATTERN        regex matching repo names (default: .*)
+  --pattern PATTERN        regex matching repo names to include
+  --skip_pattern PATTERN   regex matching repo names to skip
   --format {tar,zip,none}  archive format (default: zip)
   --gists                  include gists
   --history                include commit history and branches (.git directory)
+  --skip_forks             skip repos that are forks
+  --keep                   keep repos after archiving
   --list                   list repos only
   --token                  prompt for auth token
 ```

{githubtakeout-0.1.15 → githubtakeout-0.1.17}/src/githubtakeout.egg-info/SOURCES.txt

@@ -8,4 +8,5 @@ src/githubtakeout.egg-info/SOURCES.txt
 src/githubtakeout.egg-info/dependency_links.txt
 src/githubtakeout.egg-info/entry_points.txt
 src/githubtakeout.egg-info/requires.txt
-src/githubtakeout.egg-info/top_level.txt
+src/githubtakeout.egg-info/top_level.txt
+tests/test_githubtakeout.py

{githubtakeout-0.1.15 → githubtakeout-0.1.17}/src/githubtakeout.egg-info/requires.txt

@@ -1,3 +1,4 @@
 GitPython==3.1.45
 PyGithub==2.8.1
+python-dotenv==1.2.1
 rich==14.2.0

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

@@ -20,6 +20,7 @@ from timeit import default_timer
 
 import git
 import github
+from dotenv import load_dotenv
 
 from progress import GitProgress
 
@@ -89,7 +90,7 @@ def clone(repo_url, local_repo_dir, include_history):
             repo = git.Repo.clone_from(
                 url=repo_url,
                 to_path=local_repo_dir,
-                multi_options=["--single-branch", "--depth=1"],
+                multi_options=["--depth=1"],
                 progress=GitProgress(),
             )
     except git.GitCommandError as e:
@@ -104,7 +105,27 @@ def clone(repo_url, local_repo_dir, include_history):
             pass
 
 
-def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_history, is_gist=False):
+def pull(local_repo_dir):
+    try:
+        repo = git.Repo(local_repo_dir)
+        origin = repo.remotes.origin
+        origin.fetch()
+        origin.pull(progress=GitProgress())
+    except git.GitCommandError as e:
+        logger.error(e)
+        sys.exit("error: failed pulling changes in repo")
+    finally:
+        try:
+            # 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
+):
     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
@@ -118,19 +139,27 @@ def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_his
         # 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}")
+    # we can only pull if the local repo exists and has a .git directory
+    if Path(local_repo_dir, ".git").exists():
+        needs_clone = False
+    else:
+        needs_clone = True
+        try:
+            shutil.rmtree(local_repo_dir, onexc=remove_readonly)
+        except FileNotFoundError:
+            pass
     start = default_timer()
-    clone(repo_url, local_repo_dir, include_history)
+    if needs_clone:
+        logger.info(f"cloning repo: {repo_name} to: {local_repo_dir}")
+        clone(repo_url, local_repo_dir, include_history)
+    else:
+        logger.info(f"pulling changes from repo: {repo_name} to: {local_repo_dir}")
+        pull(local_repo_dir)
     if not include_history:
         # delete the .git directory if we are not saving history
         try:
-            git_dir = os.path.join(local_repo_dir, ".git")
+            git_dir = Path(local_repo_dir, ".git")
             shutil.rmtree(git_dir, onexc=remove_readonly)
         except FileNotFoundError:
             pass
@@ -138,12 +167,13 @@ def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_his
     if archive_path:
         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
+        if not keep:
+            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")
@@ -178,16 +208,27 @@ def get_repos(username, token, include_gists):
     if include_gists:
         gists = user.get_gists()
     else:
-        gists = None
+        gists = []
     return repos, gists
 
 
+def filter_repos(repos, pattern, skip_pattern, skip_forks):
+    repos = (repo for repo in repos if re.match(pattern, repo.name))
+    if skip_pattern:
+        repos = (repo for repo in repos if not re.match(skip_pattern, repo.name))
+    if skip_forks:
+        repos = (repo for repo in repos if not repo.fork)
+    return repos
+
+
 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:
+        # populate environment variable via .env file if it exists
+        load_dotenv()
         token = os.getenv("GITHUB_TOKEN")
     return token
 
@@ -196,39 +237,56 @@ def run(
     username,
     base_dir,
     pattern,
+    skip_pattern,
     archive_format,
     include_gists,
     include_history,
+    skip_forks,
+    keep,
     list_only,
     prompt_for_token,
 ):
     working_dir = os.path.join(base_dir, "backups")
     token = get_token(prompt_for_token)
-    repos, gists = get_repos(username, token, include_gists)
-    num_repos = len([repo for repo in repos if re.match(pattern, repo.name)])
+
+    all_repos, gists = get_repos(username, token, include_gists)
+    repos = filter_repos(all_repos, pattern, skip_pattern, skip_forks)
+    num_repos = sum(1 for repo in repos)
+    num_gists = sum(1 for gist in gists)
+
+    # we have to fetch the repos again because we exhaust the generator
+    # when counting repos above
+    all_repos, gists = get_repos(username, token, include_gists)
+    repos = filter_repos(all_repos, pattern, skip_pattern, skip_forks)
     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:
-        if re.match(pattern, repo.name):
-            local_repo_dir = os.path.join(working_dir, repo.name)
-            url = add_creds(repo.clone_url, username, token)
-            if list_only:
-                logger.info(f"{username}/{repo.name}")
-            else:
-                clone_and_archive_repo(url, local_repo_dir, archive_format, include_history)
-    if gists is not None:
-        num_gists = len([gist for gist in gists if re.match(pattern, gist.id)])
+        local_repo_dir = os.path.join(working_dir, repo.name)
+        url = add_creds(repo.clone_url, username, token)
+        if list_only:
+            logger.info(f"{username}/{repo.name}")
+        else:
+            get_and_archive_repo(
+                url, local_repo_dir, archive_format, include_history, keep
+            )
+    if include_gists:
         logger.info("")
         logger.info(f"found {num_gists} gists for user '{username}':\n")
         for gist in gists:
-            if re.match(pattern, gist.id):
-                local_repo_dir = os.path.join(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}")
-                else:
-                    clone_and_archive_repo(url, local_repo_dir, archive_format, include_history, is_gist=True)
+            local_repo_dir = os.path.join(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}")
+            else:
+                get_and_archive_repo(
+                    url,
+                    local_repo_dir,
+                    archive_format,
+                    include_history,
+                    keep,
+                    is_gist=True,
+                )
 
 
 def main():
@@ -248,7 +306,12 @@ def main():
     parser.add_argument(
         "--pattern",
         default=".*",
-        help="regex matching repo names (default: .*)",
+        help="regex matching repo names to include",
+    )
+    parser.add_argument(
+        "--skip_pattern",
+        metavar="PATTERN",
+        help="regex matching repo names to skip",
     )
     parser.add_argument(
         "--format",
@@ -256,24 +319,42 @@ 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(
+        "--skip_forks",
+        action="store_true",
+        default=False,
+        help="skip repos that are forks",
+    )
+    parser.add_argument(
+        "--keep", action="store_true", default=False, help="keep repos after archiving"
+    )
+    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(
             username=args.username,
             base_dir=args.dir,
             pattern=args.pattern,
+            skip_pattern=args.skip_pattern,
             archive_format=args.format,
             include_gists=args.gists,
             include_history=args.history,
+            skip_forks=args.skip_forks,
+            keep=args.keep,
             list_only=args.list,
             prompt_for_token=args.token,
         )

{githubtakeout-0.1.15 → githubtakeout-0.1.17}/src/progress.py

@@ -20,7 +20,9 @@ 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__()

githubtakeout-0.1.17/tests/test_githubtakeout.py

@@ -0,0 +1,262 @@
+import os
+import re
+from pathlib import Path
+
+import pytest
+from dotenv import load_dotenv
+
+import githubtakeout
+
+USER = "cgoldberg"
+
+
+@pytest.fixture(autouse=True, scope="session")
+def require_token():
+    load_dotenv()
+    required = "GITHUB_TOKEN"
+    if not os.getenv(required):
+        pytest.skip(
+            reason=f"{required} environment variable or .env file is "
+            "required to avoid rate limiting"
+        )
+
+
+@pytest.mark.skipif(
+    os.getenv("GITHUB_TOKEN"), reason="GITHUB_TOKEN required to avoid rate limiting"
+)
+def test_run_list_1_match(tmp_path, caplog):
+    caplog.set_level("INFO")
+    repo = "githubtakeout"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=False,
+        include_history=False,
+        skip_forks=False,
+        keep=False,
+        list_only=True,
+        prompt_for_token=False,
+    )
+    assert "creating archives" not in caplog.text
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert not re.search(r"found \d* gists", caplog.text)
+    assert f"{USER}/{repo}" in caplog.text
+    assert not Path(tmp_path / "backups" / repo).exists()
+
+
+def test_run_list_0_match(tmp_path, caplog):
+    caplog.set_level("INFO")
+    repo = "this_repo_does_not_exist"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=False,
+        include_history=False,
+        skip_forks=False,
+        keep=False,
+        list_only=True,
+        prompt_for_token=False,
+    )
+    assert "creating archives" not in caplog.text
+    assert "found 0 repos" in caplog.text
+    assert not re.search(r"found \d* gists", caplog.text)
+    assert not Path(tmp_path / "backups" / repo).exists()
+
+
+def test_run_list_0_match_with_gists(tmp_path, caplog):
+    caplog.set_level("INFO")
+    repo = "this_repo_does_not_exist"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=True,
+        include_history=False,
+        skip_forks=False,
+        keep=False,
+        list_only=True,
+        prompt_for_token=False,
+    )
+    assert "creating archives" not in caplog.text
+    assert "found 0 repos" in caplog.text
+    assert re.search(r"found \d* gists", caplog.text)
+    assert not Path(tmp_path / "backups" / repo).exists()
+
+
+def test_run_list_skip_all(tmp_path, caplog):
+    caplog.set_level("INFO")
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=".*",
+        skip_pattern=".*",
+        archive_format="none",
+        include_gists=False,
+        include_history=False,
+        skip_forks=False,
+        keep=False,
+        list_only=True,
+        prompt_for_token=False,
+    )
+    assert "creating archives" not in caplog.text
+    assert "found 0 repos" in caplog.text
+
+
+@pytest.mark.parametrize("archive_format", ["zip", "tar"])
+def test_run_archive_1_match(archive_format, tmp_path, caplog):
+    caplog.set_level("INFO")
+    backup_dir = "backups"
+    repo = "githubtakeout"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format=archive_format,
+        include_gists=False,
+        include_history=False,
+        skip_forks=False,
+        keep=False,
+        list_only=False,
+        prompt_for_token=False,
+    )
+    assert re.search(f"creating archives in: .*{backup_dir}", caplog.text)
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert "gists" not in caplog.text
+    assert re.search(f"cloning repo: {USER}/{repo}.git to: .*{backup_dir}", caplog.text)
+    assert "creating archive:" in caplog.text
+    assert "archive size:" in caplog.text
+    assert "deleting repo" in caplog.text
+    assert f"successfully backed up '{repo}' repo" in caplog.text
+    assert not Path(tmp_path / backup_dir / repo).exists()
+    if archive_format == "tar":
+        extension = "tar.gz"
+    else:
+        extension = archive_format
+    assert Path(tmp_path / backup_dir / f"{repo}.{extension}").exists()
+
+
+def test_run_no_archive_1_match_with_history(tmp_path, caplog):
+    caplog.set_level("INFO")
+    backup_dir = "backups"
+    repo = "githubtakeout"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=False,
+        include_history=True,
+        skip_forks=False,
+        keep=False,
+        list_only=False,
+        prompt_for_token=False,
+    )
+    assert re.search(f"creating archives in: .*{backup_dir}", caplog.text)
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert "gists" not in caplog.text
+    assert re.search(f"cloning repo: {USER}/{repo}.git to: .*{backup_dir}", caplog.text)
+    assert "creating archive:" not in caplog.text
+    assert "archive size:" not in caplog.text
+    assert "deleting repo" not in caplog.text
+    assert f"successfully backed up '{repo}' repo" in caplog.text
+    assert Path(tmp_path / backup_dir / repo).exists()
+    assert Path(tmp_path / backup_dir / repo / ".git").exists()
+    for extension in ("tar.gz", "zip"):
+        assert not Path(tmp_path / backup_dir / f"{repo}.{extension}").exists()
+
+
+def test_run_no_archive_1_match_without_history(tmp_path, caplog):
+    caplog.set_level("INFO")
+    backup_dir = "backups"
+    repo = "githubtakeout"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=False,
+        include_history=False,
+        skip_forks=False,
+        keep=False,  # this doesn't matter when archive_format is "none"
+        list_only=False,
+        prompt_for_token=False,
+    )
+    assert re.search("creating archives in: .*backups", caplog.text)
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert "gists" not in caplog.text
+    assert re.search(f"cloning repo: {USER}/{repo}.git to: .*backups", caplog.text)
+    assert "creating archive:" not in caplog.text
+    assert "archive size:" not in caplog.text
+    assert "deleting repo" not in caplog.text
+    assert f"successfully backed up '{repo}' repo" in caplog.text
+    assert Path(tmp_path / backup_dir / repo).exists()
+    assert not Path(tmp_path / backup_dir / repo / ".git").exists()
+    for extension in ("tar.gz", "zip"):
+        assert not Path(tmp_path / backup_dir / f"{repo}.{extension}").exists()
+
+
+def test_run_archive_1_match_with_history_pull_with_keep(tmp_path, caplog):
+    caplog.set_level("INFO")
+    backup_dir = "backups"
+    repo = "githubtakeout"
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="none",
+        include_gists=False,
+        include_history=True,
+        skip_forks=False,
+        keep=True,
+        list_only=False,
+        prompt_for_token=False,
+    )
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert "gists" not in caplog.text
+    assert re.search(f"cloning repo: {USER}/{repo}.git to: .*backups", caplog.text)
+    assert "pulling changes" not in caplog.text
+    assert "creating archive:" not in caplog.text
+    assert "archive size:" not in caplog.text
+    assert "deleting repo" not in caplog.text
+    assert f"successfully backed up '{repo}' repo" in caplog.text
+    assert Path(tmp_path / backup_dir / repo).exists()
+    assert Path(tmp_path / backup_dir / repo / ".git").exists()
+    caplog.clear()
+    githubtakeout.run(
+        username=USER,
+        base_dir=tmp_path,
+        pattern=repo,
+        skip_pattern=None,
+        archive_format="zip",
+        include_gists=False,
+        include_history=True,
+        skip_forks=False,
+        keep=True,
+        list_only=False,
+        prompt_for_token=False,
+    )
+    assert f"found 1 repos for user '{USER}'" in caplog.text
+    assert "gists" not in caplog.text
+    assert not re.search(f"cloning repo: {USER}/{repo}.git to: .*backups", caplog.text)
+    assert re.search(
+        f"pulling changes from repo: {USER}/{repo}.git to: .*backups", caplog.text
+    )
+    assert "creating archive:" in caplog.text
+    assert "archive size:" in caplog.text
+    assert "deleting repo" not in caplog.text
+    assert f"successfully backed up '{repo}' repo" in caplog.text
+    assert Path(tmp_path / backup_dir / repo).exists()
+    assert Path(tmp_path / backup_dir / repo / ".git").exists()
+    assert Path(tmp_path / backup_dir / f"{repo}.zip").exists()