Merge pull request #39 from python-ellar/cli_version

CLI Version Option

Author: eadwinCode

ellar_cli/main.py

@@ -3,6 +3,7 @@
 import typing as t
 
 import click
+import ellar
 import typer
 from ellar.common.commands import EllarTyper
 from ellar.common.constants import CALLABLE_COMMAND_INFO, MODULE_METADATA
@@ -11,6 +12,7 @@
 from ellar.core.services import Reflector
 from typer.models import CommandInfo
 
+import ellar_cli
 from ellar_cli.constants import ELLAR_META
 
 from .manage_commands import create_module, create_project, new_command, runserver
@@ -27,17 +29,33 @@
 _typer.command(name="create-module")(create_module)
 
 
+def version_callback(value: bool) -> None:
+    if value:
+        click.echo("===========================================================")
+        click.echo(f"Ellar CLI Version: {ellar_cli.__version__}")
+        click.echo("-----------------------------------------------------------")
+        click.echo(f"Ellar Version: {ellar.__version__}")
+        click.echo("===========================================================")
+        raise typer.Exit(0)
+
+
 @_typer.callback()
 def typer_callback(
     ctx: typer.Context,
-    project: t.Optional[str] = typer.Option(
-        None,
-        "-p",
+    project: str = typer.Option(
+        "default",
         "--project",
         show_default=True,
         exists=True,
         help="Run Specific Command on a specific project",
     ),
+    version: t.Optional[bool] = typer.Option(
+        False,
+        "--version",
+        callback=version_callback,
+        help="CLI Version",
+        show_default=False,
+    ),
 ) -> None:
     meta_: t.Optional[EllarCLIService] = EllarCLIService.import_project_meta(project)
     ctx.meta[ELLAR_META] = meta_
@@ -49,11 +67,11 @@ def build_typers() -> t.Any:  # pragma: no cover
         argv = list(sys.argv)
         options, args = getopt.getopt(
             argv[1:],
-            "hp:",
-            ["project=", "help"],
+            "",
+            ["project=", "help", "version"],
         )
         for k, v in options:
-            if k in ["-p", "--project"] and v:
+            if k in ["--project"] and v:
                 app_name = v
     except Exception as ex:
         click.echo(ex)

tests/test_build_typers.py

@@ -22,7 +22,7 @@ def test_build_typers_command_works_for_default_project(cli_runner):
 def test_build_typers_ellar_typer_for_specific_project_works():
     os.chdir(sample_app_path)
     result = subprocess.run(
-        ["ellar", "-p", "example_project_2", "db", "create-migration"],
+        ["ellar", "--project", "example_project_2", "db", "create-migration"],
         stdout=subprocess.PIPE,
     )
     assert result.returncode == 0
@@ -40,14 +40,14 @@ def test_build_typers_command_for_specific_project_works():
     os.chdir(sample_app_path)
 
     result = subprocess.run(
-        ["ellar", "-p", "example_project", "whatever-you-want"],
+        ["ellar", "--project", "example_project", "whatever-you-want"],
         stdout=subprocess.PIPE,
     )
     assert result.returncode == 0
     assert result.stdout == b"Whatever you want command\n"
 
     result = subprocess.run(
-        ["ellar", "-p", "example_project_2", "whatever-you-want"],
+        ["ellar", "--project", "example_project_2", "whatever-you-want"],
         stdout=subprocess.PIPE,
     )
     assert result.returncode == 0
@@ -60,12 +60,12 @@ def test_help_command(cli_runner):
     assert result.returncode == 0
 
     result = subprocess.run(
-        ["ellar", "-p", "example_project", "--help"], stdout=subprocess.PIPE
+        ["ellar", "--project", "example_project", "--help"], stdout=subprocess.PIPE
     )
     assert result.returncode == 0
 
     result = subprocess.run(
-        ["ellar", "-p", "example_project_2", "--help"], stdout=subprocess.PIPE
+        ["ellar", "--project", "example_project_2", "--help"], stdout=subprocess.PIPE
     )
     assert result.returncode == 0
 

tests/test_ellar_cli_service.py

@@ -170,3 +170,13 @@ def test_import_root_module_works(write_empty_py_project, process_runner):
     root_module = ellar_cli_service.import_root_module()
 
     assert issubclass(root_module, ModuleBase)
+
+
+def test_version_works(write_empty_py_project, process_runner):
+    result = process_runner(["ellar", "--version"])
+    assert result.returncode == 0
+
+    assert (
+        result.stdout
+        == b"===========================================================\nEllar CLI Version: 0.2.2\n-----------------------------------------------------------\nEllar Version: 0.4.7\n===========================================================\n"
+    )