Merge pull request #26 from abhijitnathwani/add-env-variable-for-media-dir

Add support for media dir environment variable

Author: initialcommit-io

README.md

@@ -339,6 +339,14 @@ Customize the output image/video directory location:
 $ git-sim --media-dir=path/to/output status
 ```
 
+Optionally, set the environment variable `git_sim_media_dir` to set a global default media directory, to be used if no `--media-dir` is provided. Simulated output images/videos will be placed in this location, in subfolders named with the corresponding repo's name.
+
+```console
+$ export git_sim_media_dir=path/to/media/directory
+$ git-sim status
+```
+Note: `--media-dir` takes precedence over the environment variable. If you set the environment and still provide the argument, you'll find the media in the path provided by `--media-dir`.
+
 Generate output video in low quality to speed up rendering time (useful for repeated testing, must include `--animate`):
 
 ```console

git_sim/__main__.py

@@ -4,6 +4,7 @@
 import pathlib
 import time, datetime
 import cv2
+import git
 from manim import config, WHITE
 from manim.utils.file_ops import open_file as open_media_file
 
@@ -76,9 +77,18 @@ def main():
 
     args = parser.parse_args()
 
+    if sys.platform == 'linux' or sys.platform == 'darwin':
+        repo_name = git.Repo(search_parent_directories=True).working_tree_dir.split('/')[-1]
+    elif sys.platform == 'win32':
+        repo_name = git.Repo(search_parent_directories=True).working_tree_dir.split('\\')[-1]
+
     config.media_dir = os.path.join(os.path.expanduser(args.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 args.media_dir == '.':
+        config.media_dir = os.path.join(os.path.expanduser(os.getenv('git_sim_media_dir')), "git-sim_media", repo_name)
+
     if ( args.low_quality ):
         config.quality = "low_quality"