Introducing -v or --version command line argument to print version and exit.

Author: Prabhakar Kumar

matlab_proxy/app.py

@@ -846,15 +846,9 @@ def create_app(config_name=matlab_proxy.get_default_config_name()):
     return app
 
 
-def main():
-    """Starting point of the integration. Creates the web app and runs indefinitely."""
-
-    # The integration needs to be called with --config flag.
-    # Parse the passed cli arguments.
-    desired_configuration_name = util.parse_cli_args()["config"]
-
+def create_and_start_app(config_name):
     # Create, configure and start the app.
-    app = create_app(config_name=desired_configuration_name)
+    app = create_app(config_name)
     app = configure_and_start(app)
 
     loop = util.get_event_loop()
@@ -884,3 +878,25 @@ async def shutdown():
     logger.info("Finished shutting down. Thank you for using the MATLAB proxy.")
     loop.close()
     sys.exit(0)
+
+
+def print_version_and_exit():
+    """prints the version of the package and exits"""
+    from importlib.metadata import version
+
+    matlab_proxy_version = version("matlab-proxy")
+    print(f"{matlab_proxy_version}")
+    sys.exit(0)
+
+
+def main():
+    """Starting point of the integration. Creates the web app and runs indefinitely."""
+
+    if util.parse_cli_args()["version"]:
+        print_version_and_exit()
+
+    # The integration needs to be called with --config flag.
+    # Parse the passed cli arguments.
+    desired_configuration_name = util.parse_cli_args()["config"]
+
+    create_and_start_app(config_name=desired_configuration_name)

matlab_proxy/util/__init__.py

@@ -1,4 +1,5 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
+
 import argparse
 import os
 import socket
@@ -30,9 +31,18 @@ def parse_cli_args():
         help="A json file which stores the config specific to the environment.",
         default=matlab_proxy.get_default_config_name(),
     )
+
+    parser.add_argument(
+        "-v",
+        "--version",
+        help="prints the version of matlab-proxy.",
+        action="store_true",
+    )
+
     args = parser.parse_args()
 
     parsed_args["config"] = args.config
+    parsed_args["version"] = args.version
 
     return parsed_args
 

setup.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 import os
 from pathlib import Path
 from shutil import which