Get releases to honor deleted tags

Remove MANIFEST.in Add dependencies to requirements.txt Release alpha version Restructure all dependent .py models
thevickypedia · Sep 26, 2023 · b97b5b7 · b97b5b7
1 parent 754f2ec
commit b97b5b7
Show file tree

Hide file tree

Showing 21 changed files with 47 additions and 167 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Vignesh Sivanandha Rao
+Copyright (c) 2020 Vignesh Rao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 [![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)
 
 # GitVerse
-Get release notes or commit history from `GitHub` and format it into `reStructuredText`/`Markdown` files.
+Get GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents.
 
 ### Installation
 ```shell
@@ -75,7 +75,7 @@ pre-commit run --all-files
 
 ## License & copyright
 
-&copy; Vignesh Sivanandha Rao, GitVerse
+&copy; Vignesh Rao, GitVerse
 
 Licensed under the [MIT License][license]
 

diff --git a/changelog.rst b/changelog.rst
@@ -1,6 +1,14 @@
 Commit History
 ==============
 
+0.4.6 (09/25/2023)
+------------------
+- Get releases to honor deleted tags
+- Remove MANIFEST.in
+- Add dependencies to requirements.txt
+- Release alpha version
+- Restructure all dependent .py models
+
 0.4.5 (08/30/2023)
 ------------------
 - Set return type to None from NoReturn

diff --git a/doc_generator/conf.py b/doc_generator/conf.py
@@ -19,8 +19,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'GitVerse'
-copyright = '2021, Vignesh Sivanandha Rao'
-author = 'Vignesh Sivanandha Rao'
+copyright = '2021, Vignesh Rao'
+author = 'Vignesh Rao'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/README.html b/docs/README.html
@@ -127,7 +127,7 @@ <h3>Runbook<a class="headerlink" href="#runbook" title="Permalink to this headin
 </section>
 <section id="license-copyright">
 <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title="Permalink to this heading">¶</a></h2>
-<p>© Vignesh Sivanandha Rao, GitVerse</p>
+<p>© Vignesh Rao, GitVerse</p>
 <p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/gitverse/blob/master/LICENSE">MIT License</a></p>
 </section>
 </section>
@@ -208,7 +208,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2021, Vignesh Sivanandha Rao.
+        &#169; Copyright 2021, Vignesh Rao.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
     </div>
   </body>

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -75,7 +75,7 @@ pre-commit run --all-files
 
 ## License & copyright
 
-&copy; Vignesh Sivanandha Rao, GitVerse
+&copy; Vignesh Rao, GitVerse
 
 Licensed under the [MIT License][license]
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -41,40 +41,11 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <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="#G"><strong>G</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.auth_bearer.BearerAuth">BearerAuth (class in gitverse.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.debugger.debug">debug() (in module gitverse.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.debugger.error">error() (in module gitverse.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>
@@ -90,31 +61,17 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="index.html#gitverse.releases.get_dates">get_dates() (in module gitverse.releases)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#gitverse.commits.get_gitlog">get_gitlog() (in module gitverse.commits)</a>
 </li>
       <li><a href="index.html#gitverse.releases.get_releases">get_releases() (in module gitverse.releases)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    gitverse.auth_bearer
-
-      <ul>
-        <li><a href="index.html#module-gitverse.auth_bearer">module</a>
-</li>
-      </ul></li>
       <li>
     gitverse.commits
 
       <ul>
         <li><a href="index.html#module-gitverse.commits">module</a>
-</li>
-      </ul></li>
-      <li>
-    gitverse.debugger
-
-      <ul>
-        <li><a href="index.html#module-gitverse.debugger">module</a>
 </li>
       </ul></li>
       <li>
@@ -127,26 +84,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.debugger.info">info() (in module gitverse.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>
       <li>
     module
 
       <ul>
-        <li><a href="index.html#module-gitverse.auth_bearer">gitverse.auth_bearer</a>
-</li>
         <li><a href="index.html#module-gitverse.commits">gitverse.commits</a>
-</li>
-        <li><a href="index.html#module-gitverse.debugger">gitverse.debugger</a>
 </li>
         <li><a href="index.html#module-gitverse.releases">gitverse.releases</a>
 </li>
@@ -170,14 +115,6 @@ <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.debugger.warning">warning() (in module gitverse.debugger)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 
 
             <div class="clearer"></div>
@@ -214,7 +151,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2021, Vignesh Sivanandha Rao.
+        &#169; Copyright 2021, Vignesh Rao.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
     </div>
   </body>

diff --git a/docs/index.html b/docs/index.html
@@ -228,56 +228,11 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </dd></dl>
 
 </section>
-<section id="module-gitverse.auth_bearer">
-<span id="authbearer"></span><h1>AuthBearer<a class="headerlink" href="#module-gitverse.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.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.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.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 id="authbearer">
+<h1>AuthBearer<a class="headerlink" href="#authbearer" title="Permalink to this heading">¶</a></h1>
 </section>
-<section id="module-gitverse.debugger">
-<span id="debugger"></span><h1>Debugger<a class="headerlink" href="#module-gitverse.debugger" title="Permalink to this heading">¶</a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="gitverse.debugger.debug">
-<span class="sig-prename descclassname"><span class="pre">gitverse.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><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.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.debugger.error">
-<span class="sig-prename descclassname"><span class="pre">gitverse.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><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.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.debugger.info">
-<span class="sig-prename descclassname"><span class="pre">gitverse.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><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.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.debugger.warning">
-<span class="sig-prename descclassname"><span class="pre">gitverse.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><span class="sig-paren">)</span><a class="headerlink" href="#gitverse.debugger.warning" title="Permalink to this definition">¶</a></dt>
-<dd><p>Print the incoming message in bright yellow.</p>
-</dd></dl>
-
+<section id="debugger">
+<h1>Debugger<a class="headerlink" href="#debugger" title="Permalink to this heading">¶</a></h1>
 </section>
 <section id="rst-parser">
 <h1>RST Parser<a class="headerlink" href="#rst-parser" title="Permalink to this heading">¶</a></h1>
@@ -304,8 +259,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="#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="#authbearer">AuthBearer</a></li>
+<li><a class="reference internal" href="#debugger">Debugger</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>
@@ -354,7 +309,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2021, Vignesh Sivanandha Rao.
+        &#169; Copyright 2021, Vignesh Rao.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
     </div>
   </body>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -57,21 +57,11 @@ <h1>Python Module Index</h1>
        <td>
        <code class="xref">gitverse</code></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="index.html#module-gitverse.auth_bearer"><code class="xref">gitverse.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.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.debugger"><code class="xref">gitverse.debugger</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -114,7 +104,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2021, Vignesh Sivanandha Rao.
+        &#169; Copyright 2021, Vignesh Rao.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
     </div>
   </body>

diff --git a/docs/search.html b/docs/search.html
@@ -98,7 +98,7 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2021, Vignesh Sivanandha Rao.
+        &#169; Copyright 2021, Vignesh Rao.
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
     </div>
   </body>