Add --output-only-path global flag to suppress all output except the media file output path

Signed-off-by: Jacob Stopak <[email protected]>

Author: initialcommit-io

README.md

@@ -139,7 +139,8 @@ The `[global options]` apply to the overarching `git-sim` simulation itself, inc
 `-d`: Disable the automatic opening of the image/video file after generation. Useful to avoid errors in console mode with no GUI.  
 `--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`.  
-`--stdout`: Write raw image data to stdout while suppressing all other program output.
+`--stdout`: Write raw image data to stdout while suppressing all other program output.  
+`--output-only-path`: Only output the path to the generated media file to stdout. Useful for other programs to ingest.
 
 Animation-only global options (to be used in conjunction with `--animate`):
 

git_sim/__main__.py

@@ -107,6 +107,10 @@ def main(
         settings.stdout,
         help="Write raw image data to stdout while suppressing all other program output",
     ),
+    output_only_path: bool = typer.Option(
+        settings.output_only_path,
+        help="Only output the path to the generated media file to stdout (useful for other programs to ingest)",
+    ),
 ):
     settings.animate = animate
     settings.auto_open = auto_open
@@ -126,6 +130,7 @@ def main(
     settings.title = title
     settings.video_format = video_format
     settings.stdout = stdout
+    settings.output_only_path = output_only_path
 
     if sys.platform == "linux" or sys.platform == "darwin":
         repo_name = git.repo.Repo(

git_sim/add.py

@@ -30,7 +30,7 @@ def __init__(self, files: List[str]):
                 sys.exit()
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING} {type(self).__name__.lower()} {' '.join(self.files)}"
             )

git_sim/animations.py

@@ -47,12 +47,17 @@ def handle_animations(scene: Scene) -> None:
                 os.path.join(settings.media_dir, "images"), image_file_name
             )
             cv2.imwrite(image_file_path, image)
-            if not settings.stdout:
+            if not settings.stdout and not settings.output_only_path:
                 print("Output image location:", image_file_path)
+            elif not settings.stdout and settings.output_only_path:
+                print(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 not settings.stdout and not settings.output_only_path:
+            print("Output video location:", scene.renderer.file_writer.movie_file_path)
+        elif not settings.stdout and settings.output_only_path:
+            print(scene.renderer.file_writer.movie_file_path)
 
     if settings.auto_open and not settings.stdout:
         try:

git_sim/branch.py

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

git_sim/cherrypick.py

@@ -34,7 +34,7 @@ def __init__(self, commit: str, edit: str):
             pass
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING} cherry-pick {self.commit}"
                 + ((' -e "' + self.edit + '"') if self.edit else "")

git_sim/commit.py

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

git_sim/log.py

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

git_sim/merge.py

@@ -37,7 +37,7 @@ def __init__(self, branch: str, no_ff: bool):
             pass
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch} {'--no-ff' if self.no_ff else ''}"
             )

git_sim/rebase.py

@@ -34,7 +34,7 @@ def __init__(self, branch: str):
             pass
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.branch}"
             )

git_sim/reset.py

@@ -49,7 +49,7 @@ def __init__(
             self.mode = ResetMode.SOFT
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()}{' --' + self.mode.value if self.mode != ResetMode.DEFAULT else ''} {self.commit}",
             )

git_sim/restore.py

@@ -28,7 +28,7 @@ def __init__(self, files: List[str]):
                 sys.exit()
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {' '.join(self.files)}"
             )

git_sim/revert.py

@@ -36,7 +36,7 @@ def __init__(self, commit: str):
             pass
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.commit}"
             )

git_sim/settings.py

@@ -39,6 +39,7 @@ class Settings(BaseSettings):
     title = "Git-Sim, by initialcommit.com"
     video_format: VideoFormat = VideoFormat.mp4
     stdout = False
+    output_only_path = False
 
     class Config:
         env_prefix = "git_sim_"

git_sim/stash.py

@@ -44,13 +44,13 @@ def __init__(self, files: List[str], command: StashSubCommand):
                     y.a_path for y in self.repo.index.diff("HEAD")
                 ]
         elif self.files:
-            if not settings.stdout:
+            if not settings.stdout and not settings.output_only_path:
                 print(
                     "Files are not required in apply/pop subcommand. Ignoring the file list....."
                 )
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {self.command.value if self.command else ''} {' '.join(self.files) if not self.no_files else ''}"
             )

git_sim/status.py

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

git_sim/tag.py

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