bumped version to 1.5.1 and rebuilt docs

Author: connordelacruz

docs/build/doctrees/environment.pickle

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: fbebf356fa469fa55c1b295b565dda2d
+config: 7a10bdd474e3d086ffd3f9956bc9e5fe
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/randomuser.doctree

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; Python Random User Generator 1.5.0 documentation</title>
+  <title>Overview: module code &mdash; Python Random User Generator 1.5.1 documentation</title>
 
 
 
@@ -182,7 +182,7 @@ <h1>All modules for which code is available</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'1.5.0',
+            VERSION:'1.5.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/build/html/.buildinfo

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>randomuser &mdash; Python Random User Generator 1.5.0 documentation</title>
+  <title>randomuser &mdash; Python Random User Generator 1.5.1 documentation</title>
 
 
 
@@ -163,7 +163,7 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
 <span class="c1"># ----------------------------------------------------------------</span>
 
 <span class="c1"># Python module version</span>
-<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;1.5.0&#39;</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;1.5.1&#39;</span>
 
 <span class="c1"># Version of the random user API</span>
 <span class="n">API_VERSION</span> <span class="o">=</span> <span class="s1">&#39;1.2&#39;</span>
@@ -278,17 +278,22 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;gender&#39;</span><span class="p">]</span></div>
 
 <div class="viewcode-block" id="RandomUser.get_dob"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_dob">[docs]</a>    <span class="k">def</span> <span class="nf">get_dob</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parse_time</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;Returns date of birth as a string in the format &#39;%Y-%m-%d %H:%M:%S&#39;</span>
+        <span class="sd">&quot;&quot;&quot;Returns date of birth as a string in the format &#39;%Y-%m-%dT%H:%M:%SZ&#39;</span>
+<span class="sd">        (ISO 8601 standard)</span>
 
 <span class="sd">        :param parse_time: (Default = False) If True, parse date of birth</span>
 <span class="sd">            string using time.strptime() and return the results instead of a</span>
 <span class="sd">            string</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">dob</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;dob&#39;</span><span class="p">]</span>
+        <span class="n">dob</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;dob&#39;</span><span class="p">][</span><span class="s1">&#39;date&#39;</span><span class="p">]</span>
         <span class="k">if</span> <span class="n">parse_time</span><span class="p">:</span>
             <span class="n">dob</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_time</span><span class="p">(</span><span class="n">dob</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">dob</span></div>
 
+<div class="viewcode-block" id="RandomUser.get_age"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_age">[docs]</a>    <span class="k">def</span> <span class="nf">get_age</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Returns the age of the user&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;dob&#39;</span><span class="p">][</span><span class="s1">&#39;age&#39;</span><span class="p">]</span></div>
+
 <div class="viewcode-block" id="RandomUser.get_nat"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_nat">[docs]</a>    <span class="k">def</span> <span class="nf">get_nat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Returns nationality&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;nat&#39;</span><span class="p">]</span></div>
@@ -331,6 +336,15 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
         <span class="sd">&quot;&quot;&quot; Returns zip code (wrapper for get_postcode())&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_postcode</span><span class="p">()</span></div>
 
+<div class="viewcode-block" id="RandomUser.get_coordinates"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_coordinates">[docs]</a>    <span class="k">def</span> <span class="nf">get_coordinates</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Returns a dictionary with keys &#39;longitude&#39; and &#39;latitude&#39; mapped to</span>
+<span class="sd">        their respective values</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;location&#39;</span><span class="p">][</span><span class="s1">&#39;coordinates&#39;</span><span class="p">]</span></div>
+
+    <span class="c1"># TODO: def get_timezone(self)</span>
+    <span class="c1"># https://docs.python.org/3/library/datetime.html#timezone-objects</span>
+
     <span class="c1"># Contact</span>
     <span class="c1"># --------------------------------</span>
 
@@ -387,16 +401,20 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="RandomUser.get_registered"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_registered">[docs]</a>    <span class="k">def</span> <span class="nf">get_registered</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parse_time</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Returns registration date as a string in the format</span>
-<span class="sd">        &#39;%Y-%m-%d %H:%M:%S&#39;</span>
+<span class="sd">        &#39;%Y-%m-%dT%H:%M:%SZ&#39; (ISO 8601 standard)</span>
 
 <span class="sd">        :param parse_time: (Default = False) If True, parse date string using</span>
 <span class="sd">            time.strptime() and return the results instead of a string</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">registered</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;registered&#39;</span><span class="p">]</span>
+        <span class="n">registered</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;registered&#39;</span><span class="p">][</span><span class="s1">&#39;date&#39;</span><span class="p">]</span>
         <span class="k">if</span> <span class="n">parse_time</span><span class="p">:</span>
             <span class="n">registered</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_time</span><span class="p">(</span><span class="n">registered</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">registered</span></div>
 
+<div class="viewcode-block" id="RandomUser.get_registered_age"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_registered_age">[docs]</a>    <span class="k">def</span> <span class="nf">get_registered_age</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Returns the age (in years) since registration date&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;registered&#39;</span><span class="p">][</span><span class="s1">&#39;age&#39;</span><span class="p">]</span></div>
+
 <div class="viewcode-block" id="RandomUser.get_login_salt"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_login_salt">[docs]</a>    <span class="k">def</span> <span class="nf">get_login_salt</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Returns user login salt&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;login&#39;</span><span class="p">][</span><span class="s1">&#39;salt&#39;</span><span class="p">]</span></div>
@@ -413,6 +431,10 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
         <span class="sd">&quot;&quot;&quot;Returns user login sha256&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;login&#39;</span><span class="p">][</span><span class="s1">&#39;sha256&#39;</span><span class="p">]</span></div>
 
+<div class="viewcode-block" id="RandomUser.get_login_uuid"><a class="viewcode-back" href="../randomuser.html#randomuser.RandomUser.get_login_uuid">[docs]</a>    <span class="k">def</span> <span class="nf">get_login_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Returns user login uuid&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="s1">&#39;login&#39;</span><span class="p">][</span><span class="s1">&#39;sha256&#39;</span><span class="p">]</span></div>
+
     <span class="c1"># ID</span>
     <span class="c1"># --------------------------------</span>
 
@@ -457,9 +479,9 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
         <span class="sd">&quot;&quot;&quot;Parses the date string format returned by the API and returns the</span>
 <span class="sd">        time tuple result of time.strptime()</span>
 
-<span class="sd">        :param date_string: The date string in the format &#39;%Y-%m-%d %H:%M:%S&#39;</span>
+<span class="sd">        :param date_string: The date string in the format &#39;%Y-%m-%dT%H:%M:%SZ&#39;</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">date_format</span> <span class="o">=</span> <span class="s1">&#39;%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S&#39;</span>
+        <span class="n">date_format</span> <span class="o">=</span> <span class="s1">&#39;%Y-%m-</span><span class="si">%d</span><span class="s1">T%H:%M:%SZ&#39;</span>
         <span class="k">return</span> <span class="n">time</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">date_string</span><span class="p">,</span> <span class="n">date_format</span><span class="p">)</span></div>
 
     <span class="c1"># Static Methods</span>
@@ -530,7 +552,7 @@ <h1>Source code for randomuser</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'1.5.0',
+            VERSION:'1.5.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/build/html/_modules/index.html

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.5.0',
+    VERSION: '1.5.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

docs/build/html/_modules/randomuser.html

@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; Python Random User Generator 1.5.0 documentation</title>
+  <title>Index &mdash; Python Random User Generator 1.5.1 documentation</title>
 
 
 
@@ -188,10 +188,14 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="randomuser.html#randomuser.RandomUser.generate_users">generate_users() (randomuser.RandomUser static method)</a>
+</li>
+      <li><a href="randomuser.html#randomuser.RandomUser.get_age">get_age() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_cell">get_cell() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_city">get_city() (randomuser.RandomUser method)</a>
+</li>
+      <li><a href="randomuser.html#randomuser.RandomUser.get_coordinates">get_coordinates() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_dob">get_dob() (randomuser.RandomUser method)</a>
 </li>
@@ -222,6 +226,8 @@ <h2 id="G">G</h2>
       <li><a href="randomuser.html#randomuser.RandomUser.get_login_sha1">get_login_sha1() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_login_sha256">get_login_sha256() (randomuser.RandomUser method)</a>
+</li>
+      <li><a href="randomuser.html#randomuser.RandomUser.get_login_uuid">get_login_uuid() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_nat">get_nat() (randomuser.RandomUser method)</a>
 </li>
@@ -234,6 +240,8 @@ <h2 id="G">G</h2>
       <li><a href="randomuser.html#randomuser.RandomUser.get_postcode">get_postcode() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_registered">get_registered() (randomuser.RandomUser method)</a>
+</li>
+      <li><a href="randomuser.html#randomuser.RandomUser.get_registered_age">get_registered_age() (randomuser.RandomUser method)</a>
 </li>
       <li><a href="randomuser.html#randomuser.RandomUser.get_state">get_state() (randomuser.RandomUser method)</a>
 </li>
@@ -346,7 +354,7 @@ <h2 id="V">V</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.5.0',
+            VERSION:'1.5.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/build/html/_static/documentation_options.js

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Python Random User Generator &mdash; Python Random User Generator 1.5.0 documentation</title>
+  <title>Python Random User Generator &mdash; Python Random User Generator 1.5.1 documentation</title>
 
 
 
@@ -226,7 +226,7 @@ <h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to thi
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.5.0',
+            VERSION:'1.5.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/build/html/genindex.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>randomuser &mdash; Python Random User Generator 1.5.0 documentation</title>
+  <title>randomuser &mdash; Python Random User Generator 1.5.1 documentation</title>
 
 
 
@@ -192,7 +192,7 @@ <h1>randomuser<a class="headerlink" href="#randomuser" title="Permalink to this
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.5.0',
+            VERSION:'1.5.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',