feat: added --version flag

 added the --version flag to the dotcat command-line tool that prints the version from the metadata, along with a test to verify it works correctly.

Here's what I did:

Fixed the import in __version__.py to correctly import the metadata module:

from importlib import metadata
__version__ = metadata.version('dotcat')
Added the --version flag to the argument parser in dotcat.py:

parser.add_argument(
    "--version",
    action="store_true",
    help="Show version information",
)
Updated the run function to handle the --version flag:

if version_flag:
    print(f"dotcat version {__version__}")
    return
Updated the help text to include information about the --version flag.

Added a test for the --version flag in tests/test_exec.py:

def test_version_flag():
    test_args = ["--version"]
    captured_output = StringIO()
    sys.stdout = captured_output
    run(test_args)
    sys.stdout = sys.__stdout__
    actual_output = captured_output.getvalue().strip()
    assert actual_output == f"dotcat version {__version__}"
All tests are now passing, confirming that the --version flag works correctly and displays the version from the metadata (currently 0.8.26).

Author: arthur-debert

src/dotcat/__version__.py

@@ -1,2 +1,3 @@
-import importlib;
-__version__ = importlib.metadata.version('dotcat')
+from importlib import metadata
+
+__version__ = metadata.version("dotcat")

src/dotcat/dotcat.py

@@ -24,6 +24,8 @@
 from io import StringIO
 from typing import Any, Dict, List, Tuple, Union
 
+from .__version__ import __version__
+
 ParsedData = Union[Dict[str, Any], List[Any]]
 
 LIST_ACCESS_SYMBOL = "@"
@@ -91,14 +93,17 @@ def red(text: str) -> str:
   dotcat pyproject.toml project.version
   dotcat package.json dependencies.react
 
+  dotcat --version
   See `dotcat --help` for more information.
 """
 
 HELP_CORE = (
     USAGE
     + f"""
 
-{bold('MORE:')}"""
+{bold('OPTIONS:')}
+  --version       Show version information
+  --help          Show this help message and exit"""
 )
 
 HELP_EXAMPLE = """
@@ -375,15 +380,15 @@ def from_attr_chain(data: Dict[str, Any], lookup_chain: str) -> Any:
 ######################################################################
 
 
-def parse_args(args: List[str]) -> Tuple[str, str, str, bool]:
+def parse_args(args: List[str]) -> Tuple[str, str, str, bool, bool]:
     """
     Returns the filename, dotted-path, output format, and check_install flag.
 
     Args:
         args: The list of command-line arguments.
 
     Returns:
-        The filename, dotted-path, output format, and check_install flag.
+        The filename, dotted-path, output format, check_install flag, and version flag.
     """
     # Handle help commands
     if args is None or len(args) == 0:
@@ -414,13 +419,19 @@ def parse_args(args: List[str]) -> Tuple[str, str, str, bool]:
         action="store_true",
         help="Check if required packages are installed",
     )
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="Show version information",
+    )
 
     parsed_args = parser.parse_args(args)
     return (
         parsed_args.file,
         parsed_args.dotted_path,
         parsed_args.output,
         parsed_args.check_install,
+        parsed_args.version,
     )
 
 
@@ -449,12 +460,18 @@ def run(args: List[str] = None) -> None:
         args: The list of command-line arguments.
     """
     # validates arguments
-    filename, lookup_chain, output_format, check_install_flag = parse_args(args)
+    filename, lookup_chain, output_format, check_install_flag, version_flag = (
+        parse_args(args)
+    )
 
     if check_install_flag:
         check_install()
         return
 
+    if version_flag:
+        print(f"dotcat version {__version__}")
+        return
+
     # Special case: If we have only one argument and it looks like a dotted-path,
     # treat it as the dotted-path rather than the file
     if filename is not None and lookup_chain is None and len(args) == 1:

tests/test_exec.py

@@ -1,6 +1,7 @@
 from io import StringIO
 import sys
 from dotcat import run, HELP
+from dotcat.__version__ import __version__
 
 import pytest
 
@@ -106,6 +107,17 @@ def test_check_install():
     assert actual_output == "Dotcat is good to go."
 
 
+def test_version_flag():
+    test_args = ["--version"]
+    captured_output = StringIO()
+    sys.stdout = captured_output
+    run(test_args)
+    sys.stdout = sys.__stdout__
+    actual_output = captured_output.getvalue().strip()
+    assert actual_output == f"dotcat version {__version__}"
+    # No SystemExit is raised for --version
+
+
 def test_file_without_dot_pattern():
     test_args = ["tests/fixtures/test.json"]
     captured_output = StringIO()