caelus.scripts – CLI App Utilities¶
Basic CLI Interface¶
Defines the base classes that are used to build the CLI scripts.
-
class
caelus.scripts.core.
CaelusScriptBase
(name=None, args=None)[source]¶ Bases:
object
Base class for all Caelus CLI applications.
Defines the common functionality for simple scripts and scripts with sub-commands that are used to access functionality from the library without writing additional python scripts.
Parameters: -
setup_logging
(log_to_file=True, log_file=None, verbose_level=0, quiet=False)[source]¶ Setup logging for the script.
Parameters:
-
args
= None¶ Arugments provided by user at the command line
-
description
= 'Caelus CLI Application'¶ Description of the CLI app used in help messages
-
epilog
= 'Caelus Python Library (CPL) v0.1.1'¶ Epilog for help messages
-
name
= None¶ Custom name when invoked from a python interface instead of command line
-
parser
= None¶ Instance of the ArgumentParser used to parse command line arguments
-