Add --stdout option to write image data directly to stdout while suppressing other output

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

Author: initialcommit-io

README.md

@@ -92,7 +92,8 @@ The `[global options]` apply to the overarching `git-sim` simulation itself, inc
 `--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.  
 `--disable-auto-open, -d`: Disable the automatic opening of the image/video file after generation.  
 `--reverse, -r`: Display commit history in the reverse direction.  
-`--img-format`: Output format for the image file, i.e. `jpg` or `png`. Default output format is `jpg`.
+`--img-format`: Output format for the image file, i.e. `jpg` or `png`. Default output format is `jpg`.  
+`--stdout`: Write raw image data to stdout while suppressing all other program output.
 
 Animation-only global options (to be used in conjunction with `--animate`):
 

git_sim/__main__.py

@@ -97,6 +97,10 @@ def main(
         help="Output format for the animation files.",
         case_sensitive=False,
     ),
+    stdout: bool = typer.Option(
+        settings.stdout,
+        help="Write raw image data to stdout while suppressing all other program output",
+    ),
 ):
     settings.animate = animate
     settings.auto_open = auto_open
@@ -115,6 +119,7 @@ def main(
     settings.speed = speed
     settings.title = title
     settings.video_format = video_format
+    settings.stdout = stdout
 
 
 app.command()(git_sim.add.add)

git_sim/add.py

@@ -29,9 +29,10 @@ def __init__(self, files: list[str]):
                 sys.exit()
 
     def construct(self):
-        print(
-            f"{settings.INFO_STRING} {type(self).__name__.lower()} {' '.join(self.files)}"
-        )
+        if not settings.stdout:
+            print(
+                f"{settings.INFO_STRING} {type(self).__name__.lower()} {' '.join(self.files)}"
+            )
 
         self.show_intro()
         self.get_commits()

git_sim/animations.py

@@ -68,11 +68,14 @@ def handle_animations(scene: Scene) -> None:
                 os.path.join(config.media_dir, "images"), image_file_name
             )
             cv2.imwrite(image_file_path, image)
-            print("Output image location:", image_file_path)
+            if not settings.stdout:
+                print("Output image location:", image_file_path)
+            if settings.stdout:
+                sys.stdout.buffer.write(cv2.imencode(".jpg", image)[1].tobytes())
     else:
         print("Output video location:", scene.renderer.file_writer.movie_file_path)
 
-    if settings.auto_open:
+    if settings.auto_open and not settings.stdout:
         try:
             if not settings.animate:
                 open_file(image_file_path)

git_sim/branch.py

@@ -12,7 +12,8 @@ def __init__(self, name: str):
         self.name = name
 
     def construct(self):
-        print(f"{settings.INFO_STRING} {type(self).__name__.lower()} {self.name}")
+        if not settings.stdout:
+            print(f"{settings.INFO_STRING} {type(self).__name__.lower()} {self.name}")
 
         self.show_intro()
         self.get_commits()

git_sim/cherrypick.py

@@ -34,10 +34,11 @@ def __init__(self, commit: str, edit: str):
             pass
 
     def construct(self):
-        print(
-            f"{settings.INFO_STRING} cherry-pick {self.commit}"
-            + ((' -e "' + self.edit + '"') if self.edit else "")
-        )
+        if not settings.stdout:
+            print(
+                f"{settings.INFO_STRING} cherry-pick {self.commit}"
+                + ((' -e "' + self.edit + '"') if self.edit else "")
+            )
 
         if self.repo.active_branch.name in self.repo.git.branch(
             "--contains", self.commit

git_sim/commit.py

@@ -31,12 +31,13 @@ def __init__(self, message: str, amend: bool):
             sys.exit(1)
 
     def construct(self):
-        print(
-            f"{settings.INFO_STRING } {type(self).__name__.lower()} {'--amend ' if self.amend else ''}"
-            + '-m "'
-            + self.message
-            + '"'
-        )
+        if not settings.stdout:
+            print(
+                f"{settings.INFO_STRING } {type(self).__name__.lower()} {'--amend ' if self.amend else ''}"
+                + '-m "'
+                + self.message
+                + '"'
+            )
 
         self.show_intro()
         self.get_commits()

git_sim/log.py

@@ -16,7 +16,8 @@ def __init__(self, commits: int):
             pass
 
     def construct(self):
-        print(f"{settings.INFO_STRING} {type(self).__name__.lower()}")
+        if not settings.stdout:
+            print(f"{settings.INFO_STRING} {type(self).__name__.lower()}")
         self.show_intro()
         self.get_commits()
         self.parse_commits(self.commits[0])

git_sim/merge.py

@@ -37,9 +37,10 @@ def __init__(self, branch: str, no_ff: bool):
             pass
 
     def construct(self):
-        print(
-            f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch} {'--no-ff' if self.no_ff else ''}"
-        )
+        if not settings.stdout:
+            print(
+                f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch} {'--no-ff' if self.no_ff else ''}"
+            )
 
         if self.repo.active_branch.name in self.repo.git.branch(
             "--contains", self.branch

git_sim/rebase.py

@@ -34,7 +34,10 @@ def __init__(self, branch: str):
             pass
 
     def construct(self):
-        print(f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch}")
+        if not settings.stdout:
+            print(
+                f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch}"
+            )
 
         if self.branch in self.repo.git.branch(
             "--contains", self.repo.active_branch.name