cleanups (#19)

Author: rochacbruno

project_name/__init__.py

@@ -1,3 +0,0 @@
-from .base import BaseClass, base_function
-
-__all__ = ["BaseClass", "base_function"]

project_name/__main__.py

@@ -1,61 +1,6 @@
-import argparse  # pragma: no cover
-
-from . import BaseClass, base_function  # pragma: no cover
-
-
-def main() -> None:  # pragma: no cover
-    """
-    The main function executes on commands:
-    `python -m project_name` and `$ project_name `.
-
-    This is your program's entry point.
-
-    You can change this function to do whatever you want.
-    Examples:
-        * Run a test suite
-        * Run a server
-        * Do some other stuff
-        * Run a command line application (Click, Typer, ArgParse)
-        * List all available tasks
-        * Run an application (Flask, FastAPI, Django, etc.)
-    """
-    parser = argparse.ArgumentParser(
-        description="project_name.",
-        epilog="Enjoy the project_name functionality!",
-    )
-    # This is required positional argument
-    parser.add_argument(
-        "name",
-        type=str,
-        help="The username",
-        default="author_name",
-    )
-    # This is optional named argument
-    parser.add_argument(
-        "-m",
-        "--message",
-        type=str,
-        help="The Message",
-        default="Hello",
-        required=False,
-    )
-    parser.add_argument(
-        "-v",
-        "--verbose",
-        action="store_true",
-        help="Optionally adds verbosity",
-    )
-    args = parser.parse_args()
-    print(f"{args.message} {args.name}!")
-    if args.verbose:
-        print("Verbose mode is on.")
-
-    print("Executing main function")
-    base = BaseClass()
-    print(base.base_method())
-    print(base_function())
-    print("End of main function")
+"""Entry point for project_name."""
 
+from .cli import main  # pragma: no cover
 
 if __name__ == "__main__":  # pragma: no cover
     main()

project_name/base.py

@@ -13,20 +13,5 @@
 and then choose `flask` as template.
 """
 
-
-class BaseClass:
-    def base_method(self) -> str:
-        """
-        Base method.
-        """
-        return "hello from BaseClass"
-
-    def __call__(self) -> str:
-        return self.base_method()
-
-
-def base_function() -> str:
-    """
-    Base function.
-    """
-    return "hello from base function"
+# example constant variable
+NAME = "project_name"

project_name/cli.py

@@ -0,0 +1,28 @@
+"""CLI interface for project_name project.
+
+Be creative! do whatever you want!
+
+- Install click or typer and create a CLI app
+- Use builtin argparse
+- Start a web application
+- Import things from your .base module
+"""
+
+
+def main():  # pragma: no cover
+    """
+    The main function executes on commands:
+    `python -m project_name` and `$ project_name `.
+
+    This is your program's entry point.
+
+    You can change this function to do whatever you want.
+    Examples:
+        * Run a test suite
+        * Run a server
+        * Do some other stuff
+        * Run a command line application (Click, Typer, ArgParse)
+        * List all available tasks
+        * Run an application (Flask, FastAPI, Django, etc.)
+    """
+    print("This will do something")

tests/test_base.py

@@ -1,18 +1,5 @@
-import pytest
+from project_name.base import NAME
 
-from project_name import BaseClass, base_function
 
-given = pytest.mark.parametrize
-
-
-@given("fn", [BaseClass(), base_function])
-def test_parameterized(fn):
-    assert "hello from" in fn()
-
-
-def test_base_function():
-    assert base_function() == "hello from base function"
-
-
-def test_base_class():
-    assert BaseClass().base_method() == "hello from BaseClass"
+def test_base():
+    assert NAME == "project_name"