Updates to readme and lint fixes

Author: mwhahaha

README.rst

@@ -5,3 +5,38 @@ rhos-bootstrap
 
 .. |CI Status| image:: https://github.com/mwhahaha/rhos-bootstrap/actions/workflows/py-tox.yml/badge.svg
    :target: https://github.com/mwhahaha/rhos-bootstrap/actions
+
+A bootstrap tool used to handle repository, dnf module configuration, and
+tripleoclient installation in preparation for a Red Hat OpenStack installation.
+
+Usage
+~~~~~
+
+::
+
+    usage: rhos-bootstrap [-h] [--skip-validation] [--skip-repos]
+                          [--skip-ceph-install] [--skip-modules]
+                          [--update-packages] [--skip-client-install] [--debug]
+                          version
+
+    Perform basic bootstrap related functions when installing, updating, or
+    upgrading OpenStack on Red Hat based systems. This tool can manage RPM
+    repository and dnf module configurations. This tool can also be used to
+    install tripleoclient and perform repository validations for the target
+    version
+
+    positional arguments:
+      version               The target OpenStack version to configure this system
+                            to use when fetching packages.
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --skip-validation     Skip version validation
+      --skip-repos          Skip repository configuration related actions
+      --skip-ceph-install   Skip ceph related configuration actions
+      --skip-modules        Skip module configuration related actions
+      --update-packages     Perform a system update after configuring the system
+                            repositories and modules configuration.
+      --skip-client-install
+                            Skip tripleoclient installation
+      --debug               Enable debug logging

contrib/rhos-bootstrap.spec

@@ -27,7 +27,8 @@ Requires:       python3-requests
 %{?python_provide:%python_provide python3-%{name}}
 
 %description
-Red Hat OpenStack bootstrap utility
+A bootstrap tool used to handle repository, dnf module configuration, and
+tripleoclient installation in preparation for a Red Hat OpenStack installation.
 
 # ---------------
 # Setup

rhos_bootstrap/cli.py

@@ -31,7 +31,7 @@ class BootstrapCli:
 
     def __init__(self):
         self._parser = argparse.ArgumentParser(
-            description="Perform basic bootrstrap related functions when "
+            description="Perform basic bootstrap related functions when "
             "installing, updating, or upgrading OpenStack on "
             "Red Hat based systems. This tool can manage "
             "RPM repository and dnf module configurations. This "

rhos_bootstrap/distribution.py

@@ -40,15 +40,18 @@ def __init__(
         """Distribution Information class"""
         _id, _version_id, _name = (None, None, None)
         if not distro_id or not distro_version_id or not distro_name:
-            output = subprocess.Popen(
-                "source /etc/os-release && " 'echo -e -n "$ID\n$VERSION_ID\n$NAME"',
+            cmd = "source /etc/os-release && " 'echo -e -n "$ID\n$VERSION_ID\n$NAME"'
+            with subprocess.Popen(
+                cmd,
                 shell=True,
                 stdout=subprocess.PIPE,
-                stderr=open(os.devnull, "w"),
+                stderr=subprocess.DEVNULL,
                 executable="/bin/bash",
                 universal_newlines=True,
-            ).communicate()
-            _id, _version_id, _name = output[0].split("\n")
+            ) as proc:
+                output = proc.communicate()
+                print(output)
+                _id, _version_id, _name = output[0].split("\n")
 
         self._distro_id = distro_id or _id
         self._distro_version_id = distro_version_id or _version_id

tests/unit/test_distribution.py

@@ -124,7 +124,7 @@ def test_data(self, exists_mock):
                 proc_mock = mock.MagicMock()
                 comm_mock = mock.MagicMock()
                 comm_mock.return_value = ["rhel\n8.2\nRed Hat Enterprise Linux"]
-                proc_mock.communicate = comm_mock
+                proc_mock.__enter__.return_value.communicate = comm_mock
                 popen_mock.return_value = proc_mock
                 obj = distribution.DistributionInfo()
                 self.assertEqual(obj.distro_id, "rhel")