commit new docs build and other small additional changes

CHANGELOG.md

@@ -3,10 +3,24 @@
 
 Changelog and version changes made with each release.
 
+## Version 2.1.2 
+
+New release includes a bug fix and some additional changes for checking total usage against the Petfinder API. 
+
+- `animal_type` parameter used in the `animals()` endpoint has been corrected and should be working properly.
+- New methods for checking the usage of the supplied API key against the limits defined by the Petfinder API have been 
+  implemented to better help warn users when they are approaching their API request limit.
+    - If the `max_pages` parameter exceeds 10,000, a warning will be issued to give the user the opportunity to continue 
+      or limit their results to 10,000 pages.
+    - When the API limits are exceeded, a `RuntimeError` will be issued. 
+
+Thank you to contributor [ma755](https://github.com/ma7555) for submitting the pull request.
+
 ## Version 2.1.1
 
 Small update release to fix the `distance` parameter logic when searching for pets using the `animals()` or
-`organizations()` methods. 
+`organizations()` methods. Thank you to contributor [ljlevins](https://github.com/ljlevins) for submitting the pull 
+request. 
 
 ## Version 2.1.0
 

README.md

@@ -156,7 +156,10 @@ but the data and information provided in Petfinder's database makes it ideal for
 
 ## Contributors
 
-
+* [ma755](https://github.com/ma7555) - Fixed several functions that use an `animal` parameter and 
+  implementing checks for exceeding the Petfinder API limit.
+* [ljlevins](https://github.com/ljlevins) - Found and fixed an error with the `distance` parameter used in the 
+  `organizations` API endpoint.  
 
 ## License
 

docs/build/html/_sources/contributors.rst.txt

@@ -0,0 +1,9 @@
+.. _contributors:
+
+Contributors
+============
+
+- `ma755 <https://github.com/ma7555>`_ - Fixed several functions that use an :code:`animal` parameter and
+  implementing checks for exceeding the Petfinder API limit.
+- `ljlevins <https://github.com/ljlevins>`_ - Found and fixed an error with the :code:`distance` parameter used in the
+  :code:`organizations` API endpoint.

docs/build/html/_sources/index.rst.txt

@@ -40,6 +40,7 @@ Contents
    api.rst
    exceptions.rst
    versions.rst
+   contributors.rst
 
 Introduction
 ============

docs/build/html/_sources/versions.rst.txt

@@ -5,11 +5,27 @@ Version History
 
 Changelog and version changes made with each release.
 
+Version 2.1.2
+-------------
+
+New release includes a bug fix and some additional changes for checking total usage against the Petfinder API.
+
+- :code:`animal_type` parameter used in the :code:`animals()` endpoint has been corrected and should be working
+  properly.
+- New methods for checking the usage of the supplied API key against the limits defined by the Petfinder API have been
+  implemented to better help warn users when they are approaching their API request limit.
+   - If the :code:`max_pages` parameter exceeds 10,000, a warning will be issued to give the user the opportunity to
+     continue or limit their results to 10,000 pages.
+   - When the API limits are exceeded, a :code:`RuntimeError` will be issued.
+
+Thank you to contributor `ma755 <https://github.com/ma7555>`_ for submitting the pull request.
+
 Version 2.1.1
 -------------
 
 Small update release to fix the :code:`distance` parameter logic when searching for pets using the :code:`animals()` or
-:code:`organizations()` methods.
+:code:`organizations()` methods. Thank you to contributor `ljlevins <https://github.com/ljlevins>`_ for submitting the
+pull request.
 
 Version 2.1.0
 -------------

docs/build/html/api.html

@@ -95,6 +95,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 
 

docs/build/html/contributors.html

@@ -0,0 +1,212 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Contributors &mdash; petpy 2.1.1 documentation</title>
+
+
+
+
+
+
+
+
+  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script type="text/javascript" src="_static/jquery.js"></script>
+        <script type="text/javascript" src="_static/underscore.js"></script>
+        <script type="text/javascript" src="_static/doctools.js"></script>
+        <script type="text/javascript" src="_static/language_data.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Version History" href="versions.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="index.html" class="icon icon-home"> petpy
+
+
+
+          </a>
+
+
+
+
+              <div class="version">
+                2.1
+              </div>
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributors</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">petpy</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html">Docs</a> &raquo;</li>
+
+      <li>Contributors</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/contributors.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="contributors">
+<span id="id1"></span><h1>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
+<li><a class="reference external" href="https://github.com/ma7555">ma755</a> - Fixed several functions that use an <code class="code docutils literal notranslate"><span class="pre">animal</span></code> parameter and
+implementing checks for exceeding the Petfinder API limit.</li>
+<li><a class="reference external" href="https://github.com/ljlevins">ljlevins</a> - Found and fixed an error with the <code class="code docutils literal notranslate"><span class="pre">distance</span></code> parameter used in the
+<code class="code docutils literal notranslate"><span class="pre">organizations</span></code> API endpoint.</li>
+</ul>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+
+        <a href="versions.html" class="btn btn-neutral float-left" title="Version History" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2017, Aaron Schlegel
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>

docs/build/html/exceptions.html

@@ -88,6 +88,7 @@
 <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="#">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 
 

docs/build/html/genindex.html

@@ -87,6 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 
 

docs/build/html/index.html

@@ -87,6 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 
 
@@ -187,6 +188,7 @@ <h1>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 </div>
 </div>

docs/build/html/objects.inv

@@ -2,5 +2,4 @@
 # Project: petpy
 # Version: 2.1
 # The remainder of this file is compressed using zlib.
-xڥ�_K�0���).�k��L܃R&�d��H��܎�Oo�l�7�;�7�wNz�Z$[Ϙ��)�Z�[Ϲb��4����ĞkgL˒�/�-�,�
-#.'��6Q\��Yߌ�����h��a���]�����\r�����S�vLI��P7y�o�W����`�Fo*���Г����ӻƽEN(.j=� xsa8�݁�"[�st�9�*�6����1Tv}�Q�Y��1Ԧ�oxnQ7�b�i�Z5�I';n��8�	)du��>�6��&*��:�'��$�:=-D�#*��l�]���iD�
���!��/�q�oq=c[Lv�`\�i����'��!�������
(N�a
+xڥ�QK�0���+.�k��P܃R&�d��H���c�כ.[����{ko�wNz�V���h>+Е\24��9�Z��n�r����<�S�H^��Z��kt�b�B��.d����o⸒�������������W�6e�)G�����x��li�y7~��*���As���j�W�T#����%�5R����	�ul��|8PX+Xc�%�^%�E����*��4N�:"�x��d��I�G&��Tq��Y�|�gc�O�V4�(���)v���Uw���"��� �����OC���U�����j�~I�m~Z�/�5��zx%�Ӏ�K�;��Ebh�F�Y�����l1�y�qݧYP�;x��Q�������d��R

docs/build/html/parameters.html

@@ -86,6 +86,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>
 
 

docs/build/html/search.html

@@ -87,6 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptions.html">API Exceptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
 </ul>