Get it to a better state

README.md

@@ -13,6 +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.
 
 ### Installation
 ```shell
@@ -25,6 +26,9 @@ Generate release notes from releases tagged in GitHub
 ```shell
 gitverse-release
 ```
+> :bulb: Tries to get release notes, via GitHub API call.
+> If failed, uses the commit message as notes for the associated release.
+> This feature optionally takes `GIT_TOKEN` as an environment variable if it is generated for a personal repo.
 
 Generate commit history from git log
 #### Commit History

changelog.rst

@@ -1,6 +1,10 @@
 Commit History
 ==============
 
+0.3.8 (08/10/2023)
+------------------
+- Get it to a better state
+
 0.3.7 (08/10/2023)
 ------------------
 - Generate release notes based on version tags

docs/README.html

@@ -54,6 +54,7 @@ <h3>Navigation</h3>
 <a class="reference external" href="https://api.github.com/repos/thevickypedia/gitverse"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/thevickypedia/gitverse" /></a></p>
 <section id="gitverse">
 <h1>GitVerse<a class="headerlink" href="#gitverse" title="Permalink to this heading">¶</a></h1>
+<p>Get release notes or commit history from <code class="docutils literal notranslate"><span class="pre">GitHub</span></code> and format it into <code class="docutils literal notranslate"><span class="pre">reStructuredText</span></code>/<code class="docutils literal notranslate"><span class="pre">Markdown</span></code> files.</p>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
@@ -68,6 +69,11 @@ <h3>Release Notes (Tags)<a class="headerlink" href="#release-notes-tags" title="
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-release
 </pre></div>
 </div>
+<blockquote>
+<div><p>:bulb: Tries to get release notes, via GitHub API call.
+If failed, uses the commit message as notes for the associated release.
+This feature optionally takes <code class="docutils literal notranslate"><span class="pre">GIT_TOKEN</span></code> as an environment variable if it is generated for a personal repo.</p>
+</div></blockquote>
 <p>Generate commit history from git log</p>
 </section>
 <section id="commit-history">

docs/_sources/README.md.txt

@@ -13,6 +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.
 
 ### Installation
 ```shell
@@ -25,6 +26,9 @@ Generate release notes from releases tagged in GitHub
 ```shell
 gitverse-release
 ```
+> :bulb: Tries to get release notes, via GitHub API call.
+> If failed, uses the commit message as notes for the associated release.
+> This feature optionally takes `GIT_TOKEN` as an environment variable if it is generated for a personal repo.
 
 Generate commit history from git log
 #### Commit History

docs/genindex.html

@@ -97,12 +97,14 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="index.html#commits.generator">generator() (in module commits)</a>
 </li>
-      <li><a href="index.html#commits.get_branches">get_branches() (in module commits)</a>
+      <li><a href="index.html#releases.get_api_releases">get_api_releases() (in module releases)</a>
 </li>
-      <li><a href="index.html#commits.get_commits">get_commits() (in module commits)</a>
+      <li><a href="index.html#commits.get_branches">get_branches() (in module commits)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#commits.get_commits">get_commits() (in module commits)</a>
+</li>
       <li><a href="index.html#releases.get_dates">get_dates() (in module releases)</a>
 </li>
       <li><a href="index.html#commits.get_gitlog">get_gitlog() (in module commits)</a>

docs/index.html

@@ -74,6 +74,20 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </dl>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="releases.get_api_releases">
+<span class="sig-prename descclassname"><span class="pre">releases.</span></span><span class="sig-name descname"><span class="pre">get_api_releases</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</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="#releases.get_api_releases" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get release notes via git api.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Returns release notes in the form of release version and description as key-value pairs gathered via GitHub API.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>Dict[str, List[str]]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="releases.get_dates">
 <span class="sig-prename descclassname"><span class="pre">releases.</span></span><span class="sig-name descname"><span class="pre">get_dates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</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">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#releases.get_dates" title="Permalink to this definition">¶</a></dt>
@@ -118,7 +132,7 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 
 <dl class="py function">
 <dt class="sig sig-object py" id="releases.run_git_cmd">
-<span class="sig-prename descclassname"><span class="pre">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">List</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="#releases.run_git_cmd" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">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="#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>

gitverse/__init__.py

@@ -1 +1 @@
-version = "1.0b"
+version = "2.0a"