New feature: Added --version command line flag (#970)

* Add --version commandline flag

* Update __init__.py

* Update manim/_config/main_utils.py

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Fix Black Check

* Update poetry.lock

* Create test_version.py

* Make black happy

Running black locally didn't catch this for some reason..

* Review changes

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Author: WampyCakes

docs/source/tutorials/configuration.rst

@@ -437,6 +437,7 @@ A list of all CLI flags
      --custom_folders      Use the folders defined in the [custom_folders] section of the config file to define the output folder structure
      -v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                            Verbosity level. Also changes the ffmpeg log level unless the latter is specified in the config
+     --version             Print the current version of Manim you are using
      --progress_bar True/False
                            Display the progress bar
 

manim/__init__.py

@@ -90,3 +90,10 @@
 from .utils import unit
 
 from .plugins import *
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:
+    import importlib_metadata
+
+__version__ = importlib_metadata.version(__name__)

manim/_config/main_utils.py

@@ -3,7 +3,8 @@
 import os
 import argparse
 import typing
-from manim import constants
+import sys
+from manim import constants, __version__
 
 
 __all__ = ["parse_args"]
@@ -109,6 +110,9 @@ def parse_args(args: list) -> argparse.Namespace:
         return _parse_args_cfg_subcmd(args)
     elif subcmd == "plugins":
         return _parse_args_plugins(args)
+    elif args[1] == "--version":
+        print(f"Manim Community Edition v{ __version__ }")
+        sys.exit()
     # elif subcmd == some_other_future_subcmd:
     #     return _parse_args_some_other_subcmd(args)
     elif subcmd is None:
@@ -445,6 +449,12 @@ def _parse_args_no_subcmd(args: list) -> argparse.Namespace:
         choices=constants.VERBOSITY_CHOICES,
     )
 
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="Print the current version of Manim you are using",
+    )
+
     # Specify if the progress bar should be displayed
     parser.add_argument(
         "--progress_bar",

poetry.lock

@@ -39,6 +39,7 @@ grpcio =  { version = "1.33.*", optional = true }
 grpcio-tools = { version = "1.33.*", optional = true }
 watchdog = { version = "*", optional = true }
 networkx = "^2.5"
+importlib-metadata = {version = "^1.0", python = "<3.8"}
 
 [tool.poetry.extras]
 js_renderer = ["grpcio","grpcio-tools","watchdog"]

pyproject.toml

@@ -0,0 +1,6 @@
+from manim import __version__
+import pkg_resources
+
+
+def test_version():
+    assert __version__ == pkg_resources.get_distribution("manim").version