Use Typer instead of argparse (#49)

Refactor codebase to swap CLI argument handling from argparse to Typer

- Migrate settings into new settings.py dataclass
- Migrate global arguments into animations.py
- Move subcommand arguments into respective modules
- Class name simplification
- Assorted code reformating and cleanup

Author: paketb0te

git_sim/__main__.py

@@ -0,0 +1,92 @@
+import datetime
+import inspect
+import os
+import pathlib
+import subprocess
+import sys
+import time
+
+import cv2
+import git.repo
+from manim import WHITE, Scene, config
+from manim.utils.file_ops import open_file
+
+from git_sim.settings import Settings
+
+
+def handle_animations(scene: Scene) -> None:
+    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]
+
+    config.media_dir = os.path.join(
+        os.path.expanduser(Settings.media_dir), "git-sim_media"
+    )
+    config.verbosity = "ERROR"
+
+    # If the env variable is set and no argument provided, use the env variable value
+    if os.getenv("git_sim_media_dir") and Settings.media_dir == ".":
+        config.media_dir = os.path.join(
+            os.path.expanduser(os.getenv("git_sim_media_dir")),
+            "git-sim_media",
+            repo_name,
+        )
+
+    if Settings.low_quality:
+        config.quality = "low_quality"
+
+    if Settings.light_mode:
+        config.background_color = WHITE
+
+    t = datetime.datetime.fromtimestamp(time.time()).strftime("%m-%d-%y_%H-%M-%S")
+    config.output_file = "git-sim-" + inspect.stack()[1].function + "_" + t + ".mp4"
+
+    scene.render()
+
+    if Settings.video_format == "webm":
+        webm_file_path = str(scene.renderer.file_writer.movie_file_path)[:-3] + "webm"
+        cmd = f"ffmpeg -y -i {scene.renderer.file_writer.movie_file_path} -hide_banner -loglevel error -c:v libvpx-vp9 -crf 50 -b:v 0 -b:a 128k -c:a libopus {webm_file_path}"
+        print("Converting video output to .webm format...")
+        # Start ffmpeg conversion
+        p = subprocess.Popen(cmd, shell=True)
+        p.wait()
+        # if the conversion is successful, delete the .mp4
+        if os.path.exists(webm_file_path):
+            os.remove(scene.renderer.file_writer.movie_file_path)
+            scene.renderer.file_writer.movie_file_path = webm_file_path
+
+    if not Settings.animate:
+        video = cv2.VideoCapture(str(scene.renderer.file_writer.movie_file_path))
+        success, image = video.read()
+        if success:
+            image_file_name = (
+                "git-sim-"
+                + inspect.stack()[1].function
+                + "_"
+                + t
+                + "."
+                + Settings.img_format
+            )
+            image_file_path = os.path.join(
+                os.path.join(config.media_dir, "images"), image_file_name
+            )
+            cv2.imwrite(image_file_path, image)
+            print("Output image location:", image_file_path)
+    else:
+        print("Output video location:", scene.renderer.file_writer.movie_file_path)
+
+    if Settings.auto_open:
+        try:
+            if not Settings.animate:
+                open_file(image_file_path)
+            else:
+                open_file(scene.renderer.file_writer.movie_file_path)
+        except FileNotFoundError:
+            print(
+                "Error automatically opening media, please manually open the image or video file to view."
+            )

git_sim/animations.py

@@ -1,35 +1,35 @@
 import sys
-from argparse import Namespace
 
 import git
 import manim as m
+import typer
 
+from git_sim.animations import handle_animations
 from git_sim.git_sim_base_command import GitSimBaseCommand
+from git_sim.settings import Settings
 
 
-class GitSimAdd(GitSimBaseCommand):
-    def __init__(self, args: Namespace):
-        super().__init__(args=args)
-        self.maxrefs = 2
+class Add(GitSimBaseCommand):
+    def __init__(self, files: list[str]):
+        super().__init__()
         self.hide_first_tag = True
         self.allow_no_commits = True
+        self.files = files
 
         try:
             self.selected_branches.append(self.repo.active_branch.name)
         except TypeError:
             pass
 
-        for name in self.args.name:
-            if name not in [x.a_path for x in self.repo.index.diff(None)] + [
+        for file in self.files:
+            if file not in [x.a_path for x in self.repo.index.diff(None)] + [
                 z for z in self.repo.untracked_files
             ]:
-                print("git-sim error: No modified file with name: '" + name + "'")
+                print(f"git-sim error: No modified file with name: '{file}'")
                 sys.exit()
 
     def construct(self):
-        print(
-            "Simulating: git " + self.args.subcommand + " " + " ".join(self.args.name)
-        )
+        print(Settings.INFO_STRING + "add " + " ".join(self.files))
 
         self.show_intro()
         self.get_commits()
@@ -49,12 +49,11 @@ def populate_zones(
         firstColumnArrowMap,
         secondColumnArrowMap,
     ):
-
         for x in self.repo.index.diff(None):
             if "git-sim_media" not in x.a_path:
                 secondColumnFileNames.add(x.a_path)
-                for name in self.args.name:
-                    if name == x.a_path:
+                for file in self.files:
+                    if file == x.a_path:
                         thirdColumnFileNames.add(x.a_path)
                         secondColumnArrowMap[x.a_path] = m.Arrow(
                             stroke_width=3, color=self.fontColor
@@ -71,9 +70,19 @@ def populate_zones(
         for z in self.repo.untracked_files:
             if "git-sim_media" not in z:
                 firstColumnFileNames.add(z)
-                for name in self.args.name:
-                    if name == z:
+                for file in self.files:
+                    if file == z:
                         thirdColumnFileNames.add(z)
                         firstColumnArrowMap[z] = m.Arrow(
                             stroke_width=3, color=self.fontColor
                         )
+
+
+def add(
+    files: list[str] = typer.Argument(
+        default=None,
+        help="The names of one or more files to add to Git's staging area",
+    )
+):
+    scene = Add(files=files)
+    handle_animations(scene=scene)