Fix: Address remaining Pyscaffold linting check/errors

Signed-off-by: Matthew Watkins <[email protected]>

.github/workflows/tooling.yaml

@@ -106,7 +106,7 @@ jobs:
               echo "Adding new file: $1"
               cp "$DEVOPS_DIR/$1" "$1"
               git add "$1"
-            elif !(cmp "$DEVOPS_DIR/$1" "$1" > /dev/null 2>&1); then
+            elif ! (cmp "$DEVOPS_DIR/$1" "$1" > /dev/null 2>&1); then
               echo "Updating existing file: $1"
               cp "$DEVOPS_DIR/$1" "$1"
               git add "$1"
@@ -195,7 +195,7 @@ jobs:
             source /tmp/python-venv/bin/activate
             cd "$REPO_NAME" || change_dir_error
             echo "Installing PDM command..."
-            if !(pip install pdm setuptools > /dev/null 2>&1); then
+            if ! (pip install pdm setuptools > /dev/null 2>&1); then
               echo "PDM installation failed"; exit 1
             fi
             echo -n "Validating PDM version: "
@@ -215,7 +215,7 @@ jobs:
           bootstrap_new_repo() {
             echo "Bootstrapping new repository"
             echo "Installing pyscaffold..."
-            if !(pip install pyscaffold > /dev/null 2>&1); then
+            if ! (pip install pyscaffold > /dev/null 2>&1); then
               echo "PyScaffold installation failed"; exit 1
             fi
             # Search and replace pyscaffold configuration file
@@ -236,7 +236,7 @@ jobs:
           CURRENT_DIR=$(pwd)
           if [ "$REPO_DIR" != "$CURRENT_DIR" ]; then
               echo "Changing directory to: $REPO_DIR"
-              if !(cd "$REPO_DIR"); then
+              if ! (cd "$REPO_DIR"); then
                   echo "Error: unable to change directory"; exit 1
               fi
           fi

src/osc_physrisk_financial/__init__.py

@@ -1,5 +1,8 @@
+"""Instance method to initialize a newly created object."""
+
 import sys
 
+
 if sys.version_info[:2] >= (3, 8):
     # TODO: Import directly (no need for conditional) when `python_requires = >= 3.8`
     from importlib.metadata import PackageNotFoundError, version  # pragma: no cover

src/osc_physrisk_financial/skeleton.py

@@ -1,6 +1,7 @@
 """
-This is a skeleton file that can serve as a starting point for a Python
-console script. To run this script uncomment the following lines in the
+Sample file as starting point for a Python console script.
+
+To run this script uncomment the following lines in the
 ``[options.entry_points]`` section in ``setup.cfg``::
 
     console_scripts =
@@ -41,7 +42,7 @@
 
 
 def fib(n):
-    """Fibonacci example function
+    """Fibonacci example function.
 
     Args:
       n (int): integer
@@ -63,7 +64,7 @@ def fib(n):
 
 
 def parse_args(args):
-    """Parse command line parameters
+    """Parse command line parameters.
 
     Args:
       args (List[str]): command line parameters as list of strings
@@ -99,7 +100,7 @@ def parse_args(args):
 
 
 def setup_logging(loglevel):
-    """Setup basic logging
+    """Set up basic logging.
 
     Args:
       loglevel (int): minimum loglevel for emitting messages
@@ -111,7 +112,7 @@ def setup_logging(loglevel):
 
 
 def main(args):
-    """Wrapper allowing :func:`fib` to be called with string arguments in a CLI fashion
+    """Allow :func:`fib` to be called with string arguments.
 
     Instead of returning the value from :func:`fib`, it prints the result to the
     ``stdout`` in a nicely formatted message.
@@ -128,9 +129,9 @@ def main(args):
 
 
 def run():
-    """Calls :func:`main` passing the CLI arguments extracted from :obj:`sys.argv`
+    """Create console script entry point with setuptools.
 
-    This function can be used as entry point to create console scripts with setuptools.
+    Calls :func:`main` passing the CLI arguments extracted from :obj:`sys.argv`
     """
     main(sys.argv[1:])