commit fix and doc build for version 0.2.3

aschleg · aschleg · commit cd81c71beddb · 2019-12-08T06:59:18.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+
+# Version 0.2.3
+
+- Fixes bug in `nhats` function when `return_df` parameter is set to `True`.
+
 # Version 0.2.2
 
 - An optional `return_df` parameter has been implemented in the listed functions below. When set 
diff --git a/README.md b/README.md
@@ -33,6 +33,14 @@ python setup.py install
 * [nasapy Documentation](https://nasapy.readthedocs.io/)
 * [Nasa's API documentation page](https://api.nasa.gov/)
 
+## Requirements
+
+* Python 3.4+
+* `requests>=2.18`
+* `pandas>=0.22.0`
+  - Although not strictly required to use `nasapy`, the [pandas](https://pandas.pydata.org/) library is needed 
+    for returning results as a DataFrame.
+
 ## Examples and Usage
 
 Although not strictly required to begin interacting with the NASA API, it is recommended to sign up 
@@ -212,11 +220,6 @@ julian_date(modified=False)
 julian_date(year=2019)
 ~~~
 
-## Requirements
-
-* Python 3.4+
-* `requests>=2.18`
-
 ## License
 
 MIT
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/versions.doctree b/docs/build/doctrees/versions.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -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: dcd4018dc8aa2025c0012393ea8eb72e
+config: cb14ba640c3632142bbc2ca6e8f2b912
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -31,6 +31,16 @@ file per the following:
     cd nasapy
     python setup.py install
 
+Requirements
+============
+
+ - Python 3.4+
+ - :code:`requests>=2.18`
+ - :code:`pandas>=0.22.0`
+
+  - Although not strictly required to use :code:`nasapy`, the `pandas <https://pandas.pydata.org/>`_ library is needed
+    for returning results as a DataFrame.
+
 Examples and Usage
 ==================
 
diff --git a/docs/build/html/_sources/versions.rst.txt b/docs/build/html/_sources/versions.rst.txt
@@ -4,6 +4,11 @@
 Version History
 ===============
 
+Version 0.2.3
+-------------
+
+- Fixes bug in :code:`nhats` function when :code:`return_df` parameter is set to :code:`True`.
+
 Version 0.2.2
 -------------
 
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.2',
+    VERSION: '0.2.3',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',
diff --git a/docs/build/html/api.html b/docs/build/html/api.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>API Reference &mdash; nasapy 0.2.2 documentation</title>
+  <title>API Reference &mdash; nasapy 0.2.3 documentation</title>
   
 
   
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; nasapy 0.2.2 documentation</title>
+  <title>Index &mdash; nasapy 0.2.3 documentation</title>
   
 
   
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Nasapy Documentation &mdash; nasapy 0.2.2 documentation</title>
+  <title>Nasapy Documentation &mdash; nasapy 0.2.3 documentation</title>
   
 
   
@@ -179,6 +179,22 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </pre></div>
 </div>
 </div>
+<div class="section" id="requirements">
+<h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h1>
+<blockquote>
+<div><ul class="simple">
+<li>Python 3.4+</li>
+<li><code class="code docutils literal notranslate"><span class="pre">requests&gt;=2.18</span></code></li>
+<li><code class="code docutils literal notranslate"><span class="pre">pandas&gt;=0.22.0</span></code></li>
+</ul>
+<blockquote>
+<div><ul class="simple">
+<li>Although not strictly required to use <code class="code docutils literal notranslate"><span class="pre">nasapy</span></code>, the <a class="reference external" href="https://pandas.pydata.org/">pandas</a> library is needed
+for returning results as a DataFrame.</li>
+</ul>
+</div></blockquote>
+</div></blockquote>
+</div>
 <div class="section" id="examples-and-usage">
 <h1>Examples and Usage<a class="headerlink" href="#examples-and-usage" title="Permalink to this headline">¶</a></h1>
 <p>Although not strictly required to begin interacting with the NASA API, it is recommended to sign up
diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; nasapy 0.2.2 documentation</title>
+  <title>Search &mdash; nasapy 0.2.3 documentation</title>
   
 
   
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/versions.html b/docs/build/html/versions.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Version History &mdash; nasapy 0.2.2 documentation</title>
+  <title>Version History &mdash; nasapy 0.2.3 documentation</title>
   
 
   
@@ -88,6 +88,7 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Version History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-0-2-3">Version 0.2.3</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-2">Version 0.2.2</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-1">Version 0.2.1</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-0">Version 0.2.0</a></li>
@@ -159,6 +160,12 @@
             
   <div class="section" id="version-history">
 <span id="versions"></span><h1>Version History<a class="headerlink" href="#version-history" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="version-0-2-3">
+<h2>Version 0.2.3<a class="headerlink" href="#version-0-2-3" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>Fixes bug in <code class="code docutils literal notranslate"><span class="pre">nhats</span></code> function when <code class="code docutils literal notranslate"><span class="pre">return_df</span></code> parameter is set to <code class="code docutils literal notranslate"><span class="pre">True</span></code>.</li>
+</ul>
+</div>
 <div class="section" id="version-0-2-2">
 <h2>Version 0.2.2<a class="headerlink" href="#version-0-2-2" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,7 +29,7 @@
 # The short X.Y version
 version = '0.2'
 # The full version, including alpha/beta/rc tags
-release = '0.2.2'
+release = '0.2.3'
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -31,6 +31,16 @@ file per the following:
     cd nasapy
     python setup.py install
 
+Requirements
+============
+
+ - Python 3.4+
+ - :code:`requests>=2.18`
+ - :code:`pandas>=0.22.0`
+
+  - Although not strictly required to use :code:`nasapy`, the `pandas <https://pandas.pydata.org/>`_ library is needed
+    for returning results as a DataFrame.
+
 Examples and Usage
 ==================
 
diff --git a/docs/source/versions.rst b/docs/source/versions.rst
@@ -4,6 +4,11 @@
 Version History
 ===============
 
+Version 0.2.3
+-------------
+
+- Fixes bug in :code:`nhats` function when :code:`return_df` parameter is set to :code:`True`.
+
 Version 0.2.2
 -------------
 
diff --git a/nasapy/api.py b/nasapy/api.py
@@ -2439,6 +2439,9 @@ def nhats(spk=None, des=None, delta_v=12, duration=450, stay=8, launch='2020-204
         if des is not None or spk is not None:
             raise ValueError('magnitude parameter cannot be specified when passing a des or spk.')
 
+    if not isinstance(return_df, bool):
+        raise TypeError('return_df parameter must be boolean (True or False)')
+
     params = {
         'dv': delta_v,
         'dur': duration,
@@ -2459,7 +2462,7 @@ def nhats(spk=None, des=None, delta_v=12, duration=450, stay=8, launch='2020-204
     r = _return_api_result(url=url, params=params)
 
     if return_df:
-        r = DataFrame(r)
+        r = DataFrame(r['data'])
 
     return r
 
@@ -2591,6 +2594,9 @@ def scout(tdes=None, plot=None, data_files=None, orbits=None, n_orbits=None, eph
         if not isinstance(orbits, bool):
             raise TypeError('orbits parameter must be boolean (True or False).')
 
+    if not isinstance(return_df, bool):
+        raise TypeError('return_df parameter must be boolean (True or False)')
+
     params = {'tdes': tdes,
               'plot': plot,
               'file': data_files,
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name='nasapy',
-    version='0.2.2',
+    version='0.2.3',
     author='Aaron Schlegel',
     author_email='aaron@aaronschlegel.me',
     description=('Python wrapper for the NASA API.'),
diff --git a/tests/cassettes/fireballs.yml b/tests/cassettes/fireballs.yml
diff --git a/tests/cassettes/nhats.yml b/tests/cassettes/nhats.yml
diff --git a/tests/cassettes/scout.yml b/tests/cassettes/scout.yml

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`<meta name="viewport" content="width=device-width, initial-scale=1.0">`
`10`	`10`
`11`		`- <title>API Reference — nasapy 0.2.2 documentation</title>`
	`11`	`+ <title>API Reference — nasapy 0.2.3 documentation</title>`
`12`	`12`
`13`	`13`
`14`	`14`