Add clone subcommand

Signed-off-by: Jacob Stopak <jacob@initialcommit.io>

Author: initialcommit-io

README.md

@@ -26,7 +26,7 @@ Example: `$ git-sim merge <branch>`
 
 ## Features
 - Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo
-- Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`, `switch`, `checkout`, `fetch`, `pull`, `push`
+- Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`, `switch`, `checkout`, `fetch`, `pull`, `push`, `clone`
 - Generate an animated video (.mp4) instead of a static image using the `--animate` flag (note: significant performance slowdown, it is recommended to use `--low-quality` to speed up testing and remove when ready to generate presentation-quality video)
 - Color commits by parameter, such as author the `--color-by=author` option
 - Choose between dark mode (default) and light mode
@@ -126,7 +126,7 @@ $ git-sim <subcommand> -h
 * [Manim (Community version)](https://www.manim.community/)
 
 ## Commands
-Basic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including "log", "status", "add", "restore", "commit", "stash", "branch", "tag", "reset", "revert", "merge", "rebase", "cherry-pick", "switch", "checkout", "fetch", "pull", "push" along with corresponding options.
+Basic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including "log", "status", "add", "restore", "commit", "stash", "branch", "tag", "reset", "revert", "merge", "rebase", "cherry-pick", "switch", "checkout", "fetch", "pull", "push", "clone", along with corresponding options.
 
 ```console
 $ git-sim [global options] <subcommand> [subcommand options]
@@ -311,6 +311,12 @@ Usage: `git-sim push [<remote> <branch>]`
 - If `<remote>` and `<branch>` are not specified, the active branch is pushed to the default remote
 - If the push fails due to remote changes that don't exist in the local repo, a message is included telling the user to pull first, along with color coding which commits need to be pulled
 
+### git clone
+Usage: `git-sim clone <url>`
+
+- Clone the remote repo from `<url>` (web URL or filesystem path) to a new folder in the current directory
+- Output will report if clone operation is successful and show log of local clone
+
 ## Video animation examples
 ```console
 $ git-sim --animate reset HEAD^

git_sim/__main__.py

@@ -24,6 +24,7 @@
 import git_sim.fetch
 import git_sim.pull
 import git_sim.push
+import git_sim.clone
 
 from git_sim.settings import ImgFormat, VideoFormat, settings
 from manim import config, WHITE
@@ -171,14 +172,17 @@ def main(
     settings.all = all
     settings.color_by = color_by
 
-    if sys.platform == "linux" or sys.platform == "darwin":
-        repo_name = git.repo.Repo(
-            search_parent_directories=True
-        ).working_tree_dir.split("/")[-1]
-    elif sys.platform == "win32":
-        repo_name = git.repo.Repo(
-            search_parent_directories=True
-        ).working_tree_dir.split("\\")[-1]
+    try:
+        if sys.platform == "linux" or sys.platform == "darwin":
+            repo_name = git.repo.Repo(
+                search_parent_directories=True
+            ).working_tree_dir.split("/")[-1]
+        elif sys.platform == "win32":
+            repo_name = git.repo.Repo(
+                search_parent_directories=True
+            ).working_tree_dir.split("\\")[-1]
+    except git.InvalidGitRepositoryError as e:
+        repo_name = ""
 
     settings.media_dir = os.path.join(settings.media_dir, repo_name)
 
@@ -213,6 +217,7 @@ def main(
 app.command()(git_sim.fetch.fetch)
 app.command()(git_sim.pull.pull)
 app.command()(git_sim.push.push)
+app.command()(git_sim.clone.clone)
 
 
 if __name__ == "__main__":

git_sim/clone.py

@@ -0,0 +1,111 @@
+import sys
+import os
+from argparse import Namespace
+
+import git
+import manim as m
+import numpy
+import typer
+import tempfile
+import shutil
+import stat
+import re
+
+from git_sim.animations import handle_animations
+from git_sim.git_sim_base_command import GitSimBaseCommand
+from git_sim.settings import settings
+
+
+class Clone(GitSimBaseCommand):
+    # Override since 'clone' subcommand shouldn't require repo to exist
+    def init_repo(self):
+        pass
+
+    def __init__(self, url: str):
+        super().__init__()
+        self.url = url
+        settings.max_branches_per_commit = 2
+
+    def construct(self):
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
+            print(
+                f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.url}"
+            )
+
+        self.show_intro()
+        
+        # Configure paths to make local clone to run networked commands in
+        repo_name = re.search(r"/([^/]+)/?$", self.url)
+        if repo_name:
+            repo_name = repo_name.group(1)
+            if repo_name.endswith(".git"):
+                repo_name = repo_name[:-4]
+        else:
+            print(f"git-sim error: Invalid repo URL, please confirm repo URL and try again")
+            sys.exit(1)
+        new_dir = os.path.join(tempfile.gettempdir(), "git_sim", repo_name)
+
+        # Create local clone of local repo
+        try:
+            self.repo = git.Repo.clone_from(self.url, new_dir, no_hardlinks=True)
+        except git.GitCommandError as e:
+            print(f"git-sim error: Invalid repo URL, please confirm repo URL and try again")
+            sys.exit(1)
+
+        head_commit = self.get_commit()
+        self.parse_commits(head_commit)
+        self.recenter_frame()
+        self.scale_frame()
+        self.add_details(repo_name)
+        self.color_by()
+        self.fadeout()
+        self.show_outro()
+
+        # Unlink the program from the filesystem
+        self.repo.git.clear_cache()
+
+        # Delete the local clones
+        shutil.rmtree(new_dir, onerror=del_rw)
+
+    def add_details(self, repo_name):
+        text1 = m.Text(
+            f"Successfully cloned from {self.url} into ./{repo_name}", 
+            font="Monospace",
+            font_size=20,
+            color=self.fontColor,
+            weight=m.BOLD,
+        )
+        text1.move_to([self.camera.frame.get_center()[0], 4, 0])
+
+        text2 = m.Text(
+            f"Cloned repo log:",
+            font="Monospace",
+            font_size=20,
+            color=self.fontColor,
+            weight=m.BOLD,
+        )
+        text2.move_to(text1.get_center()).shift(m.DOWN / 2)
+
+        self.toFadeOut.add(text1)
+        self.toFadeOut.add(text2)
+        self.recenter_frame()
+        self.scale_frame()
+
+        if settings.animate:
+            self.play(m.AddTextLetterByLetter(text1), m.AddTextLetterByLetter(text2))
+        else:
+            self.add(text1, text2)
+
+
+def del_rw(action, name, exc):
+    os.chmod(name, stat.S_IWRITE)
+    os.remove(name)
+
+def clone(
+    url: str = typer.Argument(
+        ...,
+        help="The web URL or filesystem path of the Git repo to clone",
+    ),
+):
+    scene = Clone(url=url)
+    handle_animations(scene=scene)