Add BearerAuth object to authenticate request

Simply extracting version numbers

changelog.rst

@@ -1,6 +1,11 @@
 Commit History
 ==============
 
+0.4.4 (08/19/2023)
+------------------
+- Add ``BearerAuth`` object to authenticate request
+- Simply extracting version numbers
+
 0.4.3 (08/18/2023)
 ------------------
 - Extract version numbers explicitly

doc_generator/index.rst

@@ -26,6 +26,13 @@ CommitHistory
    :members:
    :undoc-members:
 
+AuthBearer
+==========
+
+.. automodule:: gitverse.auth_bearer
+   :members:
+   :undoc-members:
+
 Debugger
 ========
 

docs/_sources/index.rst.txt

@@ -26,6 +26,13 @@ CommitHistory
    :members:
    :undoc-members:
 
+AuthBearer
+==========
+
+.. automodule:: gitverse.auth_bearer
+   :members:
+   :undoc-members:
+
 Debugger
 ========
 

docs/genindex.html

@@ -41,7 +41,8 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#D"><strong>D</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>
@@ -50,6 +51,14 @@ <h1 id="index">Index</h1>
  | <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>
@@ -62,10 +71,6 @@ <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>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#gitverse.releases.extract_numbers_from_string">extract_numbers_from_string() (in module gitverse.releases)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -88,11 +93,18 @@ <h2 id="G">G</h2>
       <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>
   </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>
+    gitverse.auth_bearer
+
+      <ul>
+        <li><a href="index.html#module-gitverse.auth_bearer">module</a>
 </li>
+      </ul></li>
       <li>
     gitverse.commits
 
@@ -139,6 +151,8 @@ <h2 id="M">M</h2>
     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>

docs/index.html

@@ -60,20 +60,6 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </section>
 <section id="module-gitverse.releases">
 <span id="releasenotes"></span><h1>ReleaseNotes<a class="headerlink" href="#module-gitverse.releases" title="Permalink to this heading">¶</a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="gitverse.releases.extract_numbers_from_string">
-<span class="sig-prename descclassname"><span class="pre">gitverse.releases.</span></span><span class="sig-name descname"><span class="pre">extract_numbers_from_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_string</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">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Generator</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 class="w"> </span><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><span class="pre">int</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.extract_numbers_from_string" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extract numbers or floating points in a string.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>input_string</strong> – String from which the numbers are to be extracted.</p>
-</dd>
-<dt class="field-even">Yields<span class="colon">:</span></dt>
-<dd class="field-even"><p>Yields the string that is either a number or a dot.</p>
-</dd>
-</dl>
-</dd></dl>
-
 <dl class="py function">
 <dt class="sig sig-object py" id="gitverse.releases.generate_snippets">
 <span class="sig-prename descclassname"><span class="pre">gitverse.releases.</span></span><span class="sig-name descname"><span class="pre">generate_snippets</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">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="#gitverse.releases.generate_snippets" title="Permalink to this definition">¶</a></dt>
@@ -241,6 +227,30 @@ <h1>Welcome to GitVerse’s documentation!<a class="headerlink" href="#welcome-t
 </dl>
 </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>
 <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>
@@ -354,6 +364,7 @@ <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="#module-gitverse.utils.rst">RST Parser</a></li>
 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>

docs/py-modindex.html

@@ -57,6 +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;

gitverse/__init__.py

@@ -1 +1 @@
-version = "2.3"
+version = "2.4"

gitverse/auth_bearer.py

@@ -0,0 +1,41 @@
+# noinspection PyUnresolvedReferences
+"""Module to set up bearer authentication.
+
+>>> AuthBearer
+
+"""
+
+from requests.auth import AuthBase
+from requests.models import PreparedRequest
+
+
+class BearerAuth(AuthBase):
+    """Instantiates ``BearerAuth`` object.
+
+    >>> BearerAuth
+
+    References:
+        `New Forms of Authentication <https://requests.readthedocs.io/en/latest/user/authentication/#new
+        -forms-of-authentication>`__
+    """
+
+    def __init__(self, token: str):
+        """Initializes the class and assign object members.
+
+        Args:
+            token: Token for bearer auth.
+        """
+        self.token = token
+
+    def __call__(self, request: PreparedRequest) -> PreparedRequest:
+        """Override built-in.
+
+        Args:
+            request: Takes prepared request as an argument.
+
+        Returns:
+            PreparedRequest:
+            Returns the request after adding the auth header.
+        """
+        request.headers["authorization"] = "Bearer " + self.token
+        return request