Restructure version naming in output files

Set return type to None from NoReturn Upgrade to latest flake8 and isort Bump version
thevickypedia · Aug 31, 2023 · 754f2ec · 754f2ec
1 parent fa5ee1d
commit 754f2ec
Show file tree

Hide file tree

Showing 11 changed files with 47 additions and 118 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,18 +1,18 @@
 repos:
   -
-    repo: https://github.com/pycqa/flake8
-    rev: '3.9.2'
+    repo: https://github.com/PyCQA/flake8
+    rev: '6.1.0'
     hooks:
       -
         id: flake8
         additional_dependencies:
           - flake8-docstrings
           - flake8-sfs
-        args: [--max-line-length=120, --extend-ignore=SFS3 D107 SFS301 D100 D104 D401 SFS201 SFS101]
+        args: [--max-line-length=120, --extend-ignore=SFS3 D107 SFS301 D100 D104 D401 SFS101 SFS201]
 
   -
-    repo: https://github.com/pre-commit/mirrors-isort
-    rev: 'v5.8.0'
+    repo: https://github.com/PyCQA/isort
+    rev: '5.12.0'
     hooks:
       -
         id: isort

diff --git a/changelog.rst b/changelog.rst
@@ -1,6 +1,12 @@
 Commit History
 ==============
 
+0.4.5 (08/30/2023)
+------------------
+- Set return type to None from NoReturn
+- Upgrade to latest flake8 and isort
+- Bump version
+
 0.4.4 (08/19/2023)
 ------------------
 - Add ``BearerAuth`` object to authenticate request

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -91,8 +91,6 @@ <h2 id="G">G</h2>
       <li><a href="index.html#gitverse.releases.get_dates">get_dates() (in module gitverse.releases)</a>
 </li>
       <li><a href="index.html#gitverse.commits.get_gitlog">get_gitlog() (in module gitverse.commits)</a>
-</li>
-      <li><a href="index.html#gitverse.utils.rst.get_release_notes">get_release_notes() (in module gitverse.utils.rst)</a>
 </li>
       <li><a href="index.html#gitverse.releases.get_releases">get_releases() (in module gitverse.releases)</a>
 </li>
@@ -124,13 +122,6 @@ <h2 id="G">G</h2>
 
       <ul>
         <li><a href="index.html#module-gitverse.releases">module</a>
-</li>
-      </ul></li>
-      <li>
-    gitverse.utils.rst
-
-      <ul>
-        <li><a href="index.html#module-gitverse.utils.rst">module</a>
 </li>
       </ul></li>
   </ul></td>
@@ -158,28 +149,22 @@ <h2 id="M">M</h2>
         <li><a href="index.html#module-gitverse.debugger">gitverse.debugger</a>
 </li>
         <li><a href="index.html#module-gitverse.releases">gitverse.releases</a>
-</li>
-        <li><a href="index.html#module-gitverse.utils.rst">gitverse.utils.rst</a>
 </li>
       </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#gitverse.utils.rst.rst2dict">rst2dict() (in module gitverse.utils.rst)</a>
-</li>
-      <li><a href="index.html#gitverse.utils.rst.rst2html">rst2html() (in module gitverse.utils.rst)</a>
-</li>
-  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#gitverse.commits.run">run() (in module gitverse.commits)</a>
 
       <ul>
         <li><a href="index.html#gitverse.releases.run">(in module gitverse.releases)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#gitverse.releases.run_git_cmd">run_git_cmd() (in module gitverse.releases)</a>
 </li>
   </ul></td>

diff --git a/docs/index.html b/docs/index.html
@@ -118,7 +118,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">
-<span class="sig-prename descclassname"><span class="pre">gitverse.releases.</span></span><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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">title</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">NoReturn</span></span></span><a class="headerlink" href="#gitverse.releases.run" 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</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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">title</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">None</span></span></span><a class="headerlink" href="#gitverse.releases.run" title="Permalink to this definition">¶</a></dt>
 <dd><p>Handler for generator functions that writes the release notes into a file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -214,7 +214,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.commits.run">
-<span class="sig-prename descclassname"><span class="pre">gitverse.commits.</span></span><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">branch</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">filename</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">title</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">NoReturn</span></span></span><a class="headerlink" href="#gitverse.commits.run" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">gitverse.commits.</span></span><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">branch</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">filename</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">title</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">None</span></span></span><a class="headerlink" href="#gitverse.commits.run" title="Permalink to this definition">¶</a></dt>
 <dd><p>Handler for generator functions that writes the commit history into a file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -279,68 +279,8 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </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>
-<dl class="py function">
-<dt class="sig sig-object py" id="gitverse.utils.rst.get_release_notes">
-<span class="sig-prename descclassname"><span class="pre">gitverse.utils.rst.</span></span><span class="sig-name descname"><span class="pre">get_release_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">PathLike</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">None</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">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gitverse.utils.rst.get_release_notes" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get release notes from an RST file. Tested for files generated by this module.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>filename</strong> – Name of the source file.</p></li>
-<li><p><strong>version</strong> – Version number to get release notes of a particular version.</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>Returns an iterable string.</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Iterable</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="gitverse.utils.rst.rst2dict">
-<span class="sig-prename descclassname"><span class="pre">gitverse.utils.rst.</span></span><span class="sig-name descname"><span class="pre">rst2dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">PathLike</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regular_dict</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">OrderedDict</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gitverse.utils.rst.rst2dict" title="Permalink to this definition">¶</a></dt>
-<dd><p>Converts RST file to a python dictionary.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>filename</strong> – Source filename or filepath.</p></li>
-<li><p><strong>regular_dict</strong> – Boolean flag to return as regular dict. Defaults to <code class="docutils literal notranslate"><span class="pre">OrderedDict</span></code></p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>Output as regular dict or ordered dict based on arg passed.</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Union[OrderedDict, Dict]</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="gitverse.utils.rst.rst2html">
-<span class="sig-prename descclassname"><span class="pre">gitverse.utils.rst.</span></span><span class="sig-name descname"><span class="pre">rst2html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">PathLike</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">PathLike</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">bool</span></span></span><a class="headerlink" href="#gitverse.utils.rst.rst2html" title="Permalink to this definition">¶</a></dt>
-<dd><p>Converts RST files to HTML.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>src</strong> – Source filename or filepath.</p></li>
-<li><p><strong>dst</strong> – Destination filename or filepath.</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>A boolean flag if conversion was successful.</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>bool</p>
-</dd>
-</dl>
-</dd></dl>
-
+<section id="rst-parser">
+<h1>RST Parser<a class="headerlink" href="#rst-parser" title="Permalink to this heading">¶</a></h1>
 </section>
 <section id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1>
@@ -366,7 +306,7 @@ <h3><a href="#">Table of Contents</a></h3>
 <li><a class="reference internal" href="#module-gitverse.commits">CommitHistory</a></li>
 <li><a class="reference internal" href="#module-gitverse.auth_bearer">AuthBearer</a></li>
 <li><a class="reference internal" href="#module-gitverse.debugger">Debugger</a></li>
-<li><a class="reference internal" href="#module-gitverse.utils.rst">RST Parser</a></li>
+<li><a class="reference internal" href="#rst-parser">RST Parser</a></li>
 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
 

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -77,11 +77,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="index.html#module-gitverse.releases"><code class="xref">gitverse.releases</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="index.html#module-gitverse.utils.rst"><code class="xref">gitverse.utils.rst</code></a></td><td>
-       <em></em></td></tr>
    </table>