Update CLI structure and logging; remove unused skeleton file

Author: sgbaird

.gitignore

@@ -52,3 +52,4 @@ MANIFEST
 .venv*/
 .conda*/
 .python-version
+src/lifter_state.json

setup.cfg

@@ -80,7 +80,7 @@ testing =
 # pyscaffold.cli =
 #     awesome = pyscaffoldext.awesome.extension:AwesomeExtension
 console_scripts =
-    progressive_automations_python = progressive_automations_python.cli:main
+    progressive_automations_python = progressive_automations_python.cli:run
 
 [tool:pytest]
 # Specify command line options as you would do when invoking pytest directly.

src/progressive_automations_python/cli.py

@@ -3,8 +3,24 @@
 """
 
 import argparse
+import logging
 import sys
 
+from progressive_automations_python import __version__
+
+__author__ = "Sterling G. Baird"
+__copyright__ = "Sterling G. Baird"
+__license__ = "MIT"
+
+_logger = logging.getLogger(__name__)
+
+
+# ---- Python API ----
+# The functions defined in this section can be imported by users in their
+# Python scripts/interactive interpreter, e.g. via
+# `from progressive_automations_python.skeleton import fib`,
+# when using this Python module as a library.
+
 
 def test_movement(direction: str):
     """Test UP or DOWN movement for 2 seconds"""
@@ -55,17 +71,22 @@ def show_status():
         return 1
 
 
+# ---- CLI ----
+# The functions defined in this section are wrappers around the main Python
+# API allowing them to be called directly from the terminal as a CLI
+# executable/script.
 
 
+def parse_args(args):
+    """Parse command line parameters
 
+    Args:
+      args (List[str]): command line parameters as list of strings
+          (for example  ``["--help"]``).
 
-
-
-
-
-
-def main():
-    """Main CLI entry point"""
+    Returns:
+      :obj:`argparse.Namespace`: command line parameters namespace
+    """
     parser = argparse.ArgumentParser(
         description="Progressive Automations Desk Lifter Control",
         formatter_class=argparse.RawDescriptionHelpFormatter,
@@ -76,7 +97,11 @@ def main():
   progressive_automations_python --status
         """
     )
-    
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"progressive-automations-python {__version__}",
+    )
     parser.add_argument(
         "--test",
         type=str,
@@ -89,18 +114,78 @@ def main():
         action="store_true",
         help="Show current duty cycle status"
     )
-    
-    args = parser.parse_args()
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        dest="loglevel",
+        help="set loglevel to INFO",
+        action="store_const",
+        const=logging.INFO,
+    )
+    parser.add_argument(
+        "-vv",
+        "--very-verbose",
+        dest="loglevel",
+        help="set loglevel to DEBUG",
+        action="store_const",
+        const=logging.DEBUG,
+    )
+    return parser.parse_args(args)
+
+
+def setup_logging(loglevel):
+    """Setup basic logging
+
+    Args:
+      loglevel (int): minimum loglevel for emitting messages
+    """
+    logformat = "[%(asctime)s] %(levelname)s:%(name)s:%(message)s"
+    logging.basicConfig(
+        level=loglevel, stream=sys.stdout, format=logformat, datefmt="%Y-%m-%d %H:%M:%S"
+    )
+
+
+def main(args):
+    """Wrapper allowing CLI functions to be called with string arguments in a CLI fashion
+
+    Args:
+      args (List[str]): command line parameters as list of strings
+          (for example  ``["--verbose", "--test", "UP"]``).
+    """
+    args = parse_args(args)
+    setup_logging(args.loglevel)
+    _logger.debug("Starting desk lifter control...")
 
     # Handle commands
     if args.test:
-        return test_movement(args.test)
+        result = test_movement(args.test)
+        sys.exit(result)
     elif args.status:
-        return show_status()
+        result = show_status()
+        sys.exit(result)
     else:
-        parser.print_help()
-        return 0
+        # No command specified, print help
+        print("No command specified. Use --help for usage information.")
+        sys.exit(0)
+
+
+def run():
+    """Calls :func:`main` passing the CLI arguments extracted from :obj:`sys.argv`
+
+    This function can be used as entry point to create console scripts with setuptools.
+    """
+    main(sys.argv[1:])
 
 
 if __name__ == "__main__":
-    sys.exit(main())
+    # ^  This is a guard statement that will prevent the following code from
+    #    being executed in the case someone imports this file instead of
+    #    executing it as a script.
+    #    https://docs.python.org/3/library/__main__.html
+
+    # After installing your project with pip, users can also run your Python
+    # modules as scripts via the ``-m`` flag, as defined in PEP 338::
+    #
+    #     python -m progressive_automations_python.skeleton 42
+    #
+    run()