add pandas as an install requirement, address issue #8, update docs b…

…uild
aschleg · Sep 19, 2018 · 71ece83 · 71ece83
1 parent fd2f632
commit 71ece83
Show file tree

Hide file tree

Showing 17 changed files with 69 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,19 @@
 
+## Version 1.8.2
+
+- Add `pandas` back as an installation requirement as it is included in top-level imports. `pandas` is 
+  still not necessary to use the primary functionality of `petpy`.
+
+## Version 1.8.1
+
+- Implement check to make sure `count` parameter is not larger than 1,000 records (per the Petfinder API
+  limits). If `count` exceeds 1,000 a `ValueError` is raised.
+- Add check for ensuring the number of total records to return does not exceed 2,000 when paging results with
+  the `pages` and `count` parameters. If the desired amount of records is higher than 2,000, a
+  `ValueError` is raised.
+- Remove Python 3.3 support. Although `petpy` should work fine for those still using Python 3.3, testing for 3.3
+  has been discontinued.
+
 ## Version 1.8.0
 
 - General refactoring of the `petpy` library to remove unneeded methods from being exposed when importing the 

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
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: 151ad18da822b5b00f82ff69af5243c3
+config: be04914fa9f1576dbe03b2ea0f59e477
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/versions.rst.txt b/docs/build/html/_sources/versions.rst.txt
@@ -5,9 +5,20 @@ Version History
 
 Changelog and version changes made with each release.
 
+Version 1.8.2
+-------------
+
+- Add :code:`pandas` back as an installation requirement as it is included in top-level imports. :code:`pandas` is
+  still not necessary to use the primary functionality of :code:`petpy`.
+
 Version 1.8.1
 -------------
 
+- Implement check to make sure :code:`count` parameter is not larger than 1,000 records (per the Petfinder API
+  limits). If :code:`count` exceeds 1,000 a :code:`ValueError` is raised.
+- Add check for ensuring the number of total records to return does not exceed 2,000 when paging results with
+  the :code:`pages` and :code:`count` parameters. If the desired amount of records is higher than 2,000, a
+  :code:`ValueError` is raised.
 - Remove Python 3.3 support. Although :code:`petpy` should work fine for those still using Python 3.3, testing for 3.3
   has been discontinued.
 

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: '',
-    VERSION: '1.8.0',
+    VERSION: '1.8.1',
     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; petpy 1.8.0 documentation</title>
+  <title>API Reference &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -535,7 +535,7 @@ <h2>Shelter Methods<a class="headerlink" href="#shelter-methods" title="Permalin
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

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; petpy 1.8.0 documentation</title>
+  <title>Index &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -234,7 +234,7 @@ <h2 id="S">S</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

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>Petpy - Python Wrapper of the Petfinder API &mdash; petpy 1.8.0 documentation</title>
+  <title>Petpy - Python Wrapper of the Petfinder API &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -236,7 +236,7 @@ <h1>Tutorials and Examples<a class="headerlink" href="#tutorials-and-examples" t
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
diff --git a/docs/build/html/parameters.html b/docs/build/html/parameters.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>&lt;no title&gt; &mdash; petpy 1.8.0 documentation</title>
+  <title>&lt;no title&gt; &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -57,7 +57,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -182,7 +182,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

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; petpy 1.8.0 documentation</title>
+  <title>Search &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -57,7 +57,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -192,7 +192,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

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; petpy 1.8.0 documentation</title>
+  <title>Version History &mdash; petpy 1.8.1 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                1.8.0
+                1.8
               </div>
 
 
@@ -85,6 +85,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-1-8-2">Version 1.8.2</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-8-1">Version 1.8.1</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-8-0">Version 1.8.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-7-2">Version 1.7.2</a></li>
@@ -170,9 +171,21 @@
   <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>
 <p>Changelog and version changes made with each release.</p>
+<div class="section" id="version-1-8-2">
+<h2>Version 1.8.2<a class="headerlink" href="#version-1-8-2" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>Add <code class="code docutils literal notranslate"><span class="pre">pandas</span></code> back as an installation requirement as it is included in top-level imports. <code class="code docutils literal notranslate"><span class="pre">pandas</span></code> is
+still not necessary to use the primary functionality of <code class="code docutils literal notranslate"><span class="pre">petpy</span></code>.</li>
+</ul>
+</div>
 <div class="section" id="version-1-8-1">
 <h2>Version 1.8.1<a class="headerlink" href="#version-1-8-1" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
+<li>Implement check to make sure <code class="code docutils literal notranslate"><span class="pre">count</span></code> parameter is not larger than 1,000 records (per the Petfinder API
+limits). If <code class="code docutils literal notranslate"><span class="pre">count</span></code> exceeds 1,000 a <code class="code docutils literal notranslate"><span class="pre">ValueError</span></code> is raised.</li>
+<li>Add check for ensuring the number of total records to return does not exceed 2,000 when paging results with
+the <code class="code docutils literal notranslate"><span class="pre">pages</span></code> and <code class="code docutils literal notranslate"><span class="pre">count</span></code> parameters. If the desired amount of records is higher than 2,000, a
+<code class="code docutils literal notranslate"><span class="pre">ValueError</span></code> is raised.</li>
 <li>Remove Python 3.3 support. Although <code class="code docutils literal notranslate"><span class="pre">petpy</span></code> should work fine for those still using Python 3.3, testing for 3.3
 has been discontinued.</li>
 </ul>
@@ -402,7 +415,7 @@ <h2>Version 1.0.0<a class="headerlink" href="#version-1-0-0" title="Permalink to
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.8.0',
+            VERSION:'1.8.1',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

diff --git a/docs/source/versions.rst b/docs/source/versions.rst
@@ -5,6 +5,12 @@ Version History
 
 Changelog and version changes made with each release.
 
+Version 1.8.2
+-------------
+
+- Add :code:`pandas` back as an installation requirement as it is included in top-level imports. :code:`pandas` is
+  still not necessary to use the primary functionality of :code:`petpy`.
+
 Version 1.8.1
 -------------
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
+pandas>=0.22.0
 requests>=2.18.4
 six>=1.11.0
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name='petpy',
-    version='1.8.1',
+    version='1.8.2',
     author='Aaron Schlegel',
     author_email='aaron@aaronschlegel.com',
     url='https://github.com/aschleg/petpy',
@@ -14,7 +14,7 @@
                                     'docs', 'notebooks', 'tests*']),
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',
-    install_requires=['requests>=2.18.4', 'six>=1.11.0'],
+    install_requires=['pandas>=0.22.0', 'requests>=2.18.4', 'six>=1.11.0'],
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Environment :: Console',