Reduce redundancy, improve runtime

Suppress onscreen rejection messages while pruning
Print onscreen runtime message regardless of debug flag
Fix broken sections of the runbook

changelog.rst

@@ -1,6 +1,13 @@
 Commit History
 ==============
 
+0.5.4 (12/01/2023)
+------------------
+- Reduce redundancy, improve runtime
+- Suppress onscreen rejection messages while pruning
+- Print onscreen runtime message regardless of debug flag
+- Fix broken sections of the runbook
+
 0.5.3 (11/30/2023)
 ------------------
 - Support hyperlinks for restructured text file format

doc_generator/index.rst

@@ -29,14 +29,14 @@ CommitHistory
 AuthBearer
 ==========
 
-.. automodule:: gitverse.auth_bearer
+.. automodule:: gitverse.models.auth_bearer
    :members:
    :undoc-members:
 
 Debugger
 ========
 
-.. automodule:: gitverse.debugger
+.. automodule:: gitverse.models.debugger
    :members:
    :undoc-members:
 

docs/_sources/index.rst.txt

@@ -29,14 +29,14 @@ CommitHistory
 AuthBearer
 ==========
 
-.. automodule:: gitverse.auth_bearer
+.. automodule:: gitverse.models.auth_bearer
    :members:
    :undoc-members:
 
 Debugger
 ========
 
-.. automodule:: gitverse.debugger
+.. automodule:: gitverse.models.debugger
    :members:
    :undoc-members:
 

docs/genindex.html

@@ -41,11 +41,40 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#G"><strong>G</strong></a>
+ <a href="#B"><strong>B</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#E"><strong>E</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#I"><strong>I</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#R"><strong>R</strong></a>
+ | <a href="#W"><strong>W</strong></a>
 
 </div>
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#gitverse.models.auth_bearer.BearerAuth">BearerAuth (class in gitverse.models.auth_bearer)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#gitverse.models.debugger.debug">debug() (in module gitverse.models.debugger)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#gitverse.models.debugger.error">error() (in module gitverse.models.debugger)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -63,17 +92,31 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="index.html#gitverse.utils.rst.get_release_notes">get_release_notes() (in module gitverse.utils.rst)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#gitverse.releases.get_releases">get_releases() (in module gitverse.releases)</a>
 </li>
       <li><a href="index.html#gitverse.releases.get_tags">get_tags() (in module gitverse.releases)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     gitverse.commits
 
       <ul>
         <li><a href="index.html#module-gitverse.commits">module</a>
+</li>
+      </ul></li>
+      <li>
+    gitverse.models.auth_bearer
+
+      <ul>
+        <li><a href="index.html#module-gitverse.models.auth_bearer">module</a>
+</li>
+      </ul></li>
+      <li>
+    gitverse.models.debugger
+
+      <ul>
+        <li><a href="index.html#module-gitverse.models.debugger">module</a>
 </li>
       </ul></li>
       <li>
@@ -93,6 +136,14 @@ <h2 id="G">G</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#gitverse.models.debugger.info">info() (in module gitverse.models.debugger)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -101,6 +152,10 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="index.html#module-gitverse.commits">gitverse.commits</a>
+</li>
+        <li><a href="index.html#module-gitverse.models.auth_bearer">gitverse.models.auth_bearer</a>
+</li>
+        <li><a href="index.html#module-gitverse.models.debugger">gitverse.models.debugger</a>
 </li>
         <li><a href="index.html#module-gitverse.releases">gitverse.releases</a>
 </li>
@@ -130,6 +185,14 @@ <h2 id="R">R</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#gitverse.models.debugger.warning">warning() (in module gitverse.models.debugger)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
             <div class="clearer"></div>

docs/index.html

@@ -129,7 +129,7 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 
 <dl class="py function">
 <dt class="sig sig-object py" id="gitverse.releases.run_git_cmd">
-<span class="sig-prename descclassname"><span class="pre">gitverse.releases.</span></span><span class="sig-name descname"><span class="pre">run_git_cmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gitverse.releases.run_git_cmd" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">gitverse.releases.</span></span><span class="sig-name descname"><span class="pre">run_git_cmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#gitverse.releases.run_git_cmd" title="Permalink to this definition">¶</a></dt>
 <dd><p>Run the git command.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -225,11 +225,56 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </dd></dl>
 
 </section>
-<section id="authbearer">
-<h1>AuthBearer<a class="headerlink" href="#authbearer" title="Permalink to this heading">¶</a></h1>
+<section id="module-gitverse.models.auth_bearer">
+<span id="authbearer"></span><h1>AuthBearer<a class="headerlink" href="#module-gitverse.models.auth_bearer" title="Permalink to this heading">¶</a></h1>
+<p>Module to set up bearer authentication.</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">AuthBearer</span>
+</pre></div>
+</div>
+<dl class="py class">
+<dt class="sig sig-object py" id="gitverse.models.auth_bearer.BearerAuth">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gitverse.models.auth_bearer.</span></span><span class="sig-name descname"><span class="pre">BearerAuth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.models.auth_bearer.BearerAuth" title="Permalink to this definition">¶</a></dt>
+<dd><p>Instantiates <code class="docutils literal notranslate"><span class="pre">BearerAuth</span></code> object.</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">BearerAuth</span>
+</pre></div>
+</div>
+<p class="rubric">References</p>
+<p><a class="reference external" href="https://requests.readthedocs.io/en/latest/user/authentication/#new-forms-of-authentication">New Forms of Authentication</a></p>
+<p>Initializes the class and assign object members.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>token</strong> – Token for bearer auth.</p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
-<section id="debugger">
-<h1>Debugger<a class="headerlink" href="#debugger" title="Permalink to this heading">¶</a></h1>
+<section id="module-gitverse.models.debugger">
+<span id="debugger"></span><h1>Debugger<a class="headerlink" href="#module-gitverse.models.debugger" title="Permalink to this heading">¶</a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="gitverse.models.debugger.debug">
+<span class="sig-prename descclassname"><span class="pre">gitverse.models.debugger.</span></span><span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">override</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.models.debugger.debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>Print the incoming message in light green.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gitverse.models.debugger.error">
+<span class="sig-prename descclassname"><span class="pre">gitverse.models.debugger.</span></span><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">override</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.models.debugger.error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Print the incoming message in bright red.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gitverse.models.debugger.info">
+<span class="sig-prename descclassname"><span class="pre">gitverse.models.debugger.</span></span><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">override</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.models.debugger.info" title="Permalink to this definition">¶</a></dt>
+<dd><p>Print the incoming message in bright green.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gitverse.models.debugger.warning">
+<span class="sig-prename descclassname"><span class="pre">gitverse.models.debugger.</span></span><span class="sig-name descname"><span class="pre">warning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">override</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.models.debugger.warning" title="Permalink to this definition">¶</a></dt>
+<dd><p>Print the incoming message in bright yellow.</p>
+</dd></dl>
+
 </section>
 <section id="module-gitverse.utils.rst">
 <span id="rst-parser"></span><h1>RST Parser<a class="headerlink" href="#module-gitverse.utils.rst" title="Permalink to this heading">¶</a></h1>
@@ -316,8 +361,8 @@ <h3><a href="#">Table of Contents</a></h3>
 <li><a class="reference internal" href="#">Welcome to GitVerse’s documentation!</a></li>
 <li><a class="reference internal" href="#module-gitverse.releases">ReleaseNotes</a></li>
 <li><a class="reference internal" href="#module-gitverse.commits">CommitHistory</a></li>
-<li><a class="reference internal" href="#authbearer">AuthBearer</a></li>
-<li><a class="reference internal" href="#debugger">Debugger</a></li>
+<li><a class="reference internal" href="#module-gitverse.models.auth_bearer">AuthBearer</a></li>
+<li><a class="reference internal" href="#module-gitverse.models.debugger">Debugger</a></li>
 <li><a class="reference internal" href="#module-gitverse.utils.rst">RST Parser</a></li>
 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
 </ul>

docs/objects.inv

@@ -2,4 +2,6 @@
 # Project: GitVerse
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڥ�MN�0��9�lQ��!Q!�*�`i���Xr�Ȟ ��\��`Ǥu?q��ͼ�y�&_�:��i[��tò5u��\�kx�l�y���,�7���246�Ͻ�(�&���C��L��h2q&�ʈL��z&aA
s����LauZv̾_b��u��S���D6��m@�)o�h�Ry�a�^vP��g��w��U-9�������f�"�em8)$VF���l����(Tl*H�j߅�b/��KO���
��������[��Œg���ú���m��M��`�
��
�Y�������0
�'6
�
+xڥ��N�0��}� ��bwbB&M ��JS/��&U����OB��-kʡjd����8���XȘ�k��4�y��V�$B��UX�soK/H��#$��PԦ�7�b(�"���ü0T�
+�4�8�tF�y$hZ5�p�i3�b�@���~�����p�N�Ij���%-�r�_��zǂ1�'�j�'�/�(��m@�5�3�=�V���ѣ`N��U���a��hn�5����.G�-
+w��b̹젰/��8�9{�]���$����/7�%�X�K�H:#��G�[���l���@I�]�`��w�2ه}�O ��N�����֠�v5�%��?$k����j+>m�=���X�N��=k�:��3޿��OoqcJ

docs/py-modindex.html

@@ -62,6 +62,16 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="index.html#module-gitverse.commits"><code class="xref">gitverse.commits</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="index.html#module-gitverse.models.auth_bearer"><code class="xref">gitverse.models.auth_bearer</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="index.html#module-gitverse.models.debugger"><code class="xref">gitverse.models.debugger</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;