feat: add cli and tests

Author: remarkablemark

README.md

@@ -6,22 +6,25 @@
 
 🐍 Python CLI Template
 
+## Prerequisites
+
+- [Python](https://www.python.org/)
+- [pipx](https://pipx.pypa.io/)
+
 ## Install
 
 [Python](https://pypi.org/project/python_cli_template/):
 
 ```sh
-pip install python_cli_template
+pipx install python_cli_template
 ```
 
 ## Usage
 
 Print greeting:
 
-```py
-from python_cli_template import template
-
-print(template.hello())
+```sh
+python_cli_template --name world
 ```
 
 ## License

pyproject.toml

@@ -15,6 +15,12 @@ license-files = ["LICEN[CS]E*"]
 dynamic = ["version"]
 dependencies = []
 
+[project.scripts]
+python_cli_template = "python_cli_template.cli:main"
+
+[project.entry-points."pipx.run"]
+python_cli_template = "python_cli_template.cli:main"
+
 [project.optional-dependencies]
 build = [
     "build==1.2.2.post1",

src/python_cli_template/__init__.py

@@ -1,3 +1,3 @@
-"""Python Package Template"""
+"""Python CLI Template"""
 
 __version__ = "0.0.0"

src/python_cli_template/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()

src/python_cli_template/cli.py

@@ -0,0 +1,38 @@
+from argparse import ArgumentParser
+
+from python_cli_template import __version__
+from python_cli_template.template import hello
+
+
+def main(argv: list[str] = None) -> None:
+    parser = ArgumentParser(description="Python CLI Template")
+
+    parser.add_argument(
+        "--version",
+        "-v",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    parser.add_argument(
+        "--name",
+        "-n",
+        default="World",
+        help="name to greet [default: World]",
+    )
+
+    parser.add_argument(
+        "--color",
+        "-c",
+        action="store_true",
+        help="colorize the text",
+    )
+
+    args = parser.parse_args(argv)
+
+    color = "\033[95m" if args.color else ""
+    print(f"{color}{hello(args.name)}")
+
+
+if __name__ == "__main__":
+    main()

tests/python_cli_template/test_cli.py

@@ -0,0 +1,21 @@
+import pytest
+
+from python_cli_template.cli import main
+
+
+def test_hello(capsys):
+    assert main() is None
+    captured = capsys.readouterr()
+    assert captured.out == "Hello, World!\n"
+
+
+def test_hello_world(capsys):
+    assert main(["--name", "world"]) is None
+    captured = capsys.readouterr()
+    assert captured.out == "Hello, world!\n"
+
+
+def test_invalid(capsys):
+    with pytest.raises(SystemExit) as exception:
+        main(["--invalid"])
+    assert exception.type is SystemExit