updated documentation for v2.3

python-fedex-devs · Jan 29, 2016 · ebff31a · ebff31a
1 parent 7a41c6a
commit ebff31a
Show file tree

Hide file tree

Showing 82 changed files with 2,596 additions and 614 deletions.
diff --git a/doc_source/README.rst b/doc_source/README.rst
@@ -0,0 +1,12 @@
+python-fedex Examples
+=====================
+
+This directory contains a number of examples of how to use python-fedex. For
+these examples to work, you must open example_config.py and enter your
+testing account credentials there.
+
+To run all tests from bash, type:
+
+    for f in *.py; do python "$f"; done
+    # Or use the below to only see response errors:
+    for f in *.py; do python "$f"; done | grep -i error
diff --git a/docs/2.2.0/api-objects.txt → docs/2.3.0/api-objects.txt b/docs/2.2.0/api-objects.txt → docs/2.3.0/api-objects.txt
diff --git a/docs/2.2.0/class-tree.html → docs/2.3.0/class-tree.html b/docs/2.2.0/class-tree.html → docs/2.3.0/class-tree.html
@@ -59,7 +59,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
       <em class="summary">Plugin base.</em>
     <ul>
     <li> <strong class="uidlink">suds.plugin.MessagePlugin</strong>:
-      <em class="summary">The base class for suds <i>soap message</i> plugins.</em>
+      <em class="summary">The base class for suds <i>SOAP message</i> plugins.</em>
     <ul>
     <li> <strong class="uidlink"><a href="fedex.base_service.GeneralSudsPlugin-class.html">fedex.base_service.GeneralSudsPlugin</a></strong>
     </li>
@@ -131,6 +131,10 @@ <h1 class="epydoc">Class Hierarchy</h1>
       <em class="summary">This class allows you to get the shipping charges for a particular 
         address.</em>
     </li>
+    <li> <strong class="uidlink"><a href="fedex.services.location_service.FedexSearchLocationRequest-class.html">fedex.services.location_service.FedexSearchLocationRequest</a></strong>:
+      <em class="summary">This class allows you to figure out a FedEx location closest to a 
+        specified location criteria, based on location type.</em>
+    </li>
     <li> <strong class="uidlink"><a href="fedex.services.track_service.FedexTrackRequest-class.html">fedex.services.track_service.FedexTrackRequest</a></strong>:
       <em class="summary">This class allows you to track shipments by providing a tracking 
         number or other identifying features.</em>
@@ -177,7 +181,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016
+    Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:05 2016
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/2.2.0/crarr.png → docs/2.3.0/crarr.png b/docs/2.2.0/crarr.png → docs/2.3.0/crarr.png
diff --git a/docs/2.2.0/epydoc.css → docs/2.3.0/epydoc.css b/docs/2.2.0/epydoc.css → docs/2.3.0/epydoc.css
diff --git a/docs/2.2.0/epydoc.js → docs/2.3.0/epydoc.js b/docs/2.2.0/epydoc.js → docs/2.3.0/epydoc.js
diff --git a/docs/2.2.0/fedex-module.html → docs/2.3.0/fedex-module.html b/docs/2.2.0/fedex-module.html → docs/2.3.0/fedex-module.html
@@ -120,7 +120,7 @@ <h2 class="heading">Getting Support</h2>
 
 <hr />
 <div class="fields">      <p><strong>Version:</strong>
-        2.2.0
+        2.3.0
       </p>
 </div><!-- ==================== SUBMODULES ==================== -->
 <a name="section-Submodules"></a>
@@ -165,12 +165,19 @@ <h2 class="heading">Getting Support</h2>
     <li> <strong class="uidlink"><a href="fedex.services.address_validation_service-module.html">fedex.services.address_validation_service</a></strong>: <em class="summary">Address Validation Service Module</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.availability_commitment_service-module.html">fedex.services.availability_commitment_service</a></strong>: <em class="summary">Service Availability and Commitment Module</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.country_service-module.html">fedex.services.country_service</a></strong>: <em class="summary">Country Service Module</em>    </li>
+    <li> <strong class="uidlink"><a href="fedex.services.location_service-module.html">fedex.services.location_service</a></strong>: <em class="summary">Location Service Module</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.package_movement-module.html">fedex.services.package_movement</a></strong>: <em class="summary">Package Movement Information Service</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.rate_service-module.html">fedex.services.rate_service</a></strong>: <em class="summary">Rate Service Module</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.ship_service-module.html">fedex.services.ship_service</a></strong>: <em class="summary">Ship Service Module</em>    </li>
     <li> <strong class="uidlink"><a href="fedex.services.track_service-module.html">fedex.services.track_service</a></strong>: <em class="summary">Tracking Service Module</em>    </li>
     </ul>
     </li>
+    <li> <strong class="uidlink"><a href="fedex.tools-module.html">fedex.tools</a></strong>
+    <ul>
+    <li> <strong class="uidlink"><a href="fedex.tools.conversion-module.html">fedex.tools.conversion</a></strong>: <em class="summary">Response output conversion tools to help parse suds response object
+        output.</em>    </li>
+    </ul>
+    </li>
   </ul></td></tr>
 </table>
 
@@ -196,7 +203,7 @@ <h2 class="heading">Getting Support</h2>
     <td width="15%" align="right" valign="top" class="summary">
       <span class="summary-type">&nbsp;</span>
     </td><td class="summary">
-        <a name="VERSION"></a><span class="summary-name">VERSION</span> = <code title="'2.2.0'"><code class="variable-quote">'</code><code class="variable-string">2.2.0</code><code class="variable-quote">'</code></code>
+        <a name="VERSION"></a><span class="summary-name">VERSION</span> = <code title="'2.3.0'"><code class="variable-quote">'</code><code class="variable-string">2.3.0</code><code class="variable-quote">'</code></code>
     </td>
   </tr>
 <tr>
@@ -233,7 +240,7 @@ <h2 class="heading">Getting Support</h2>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016
+    Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:05 2016
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/2.2.0/fedex-pysrc.html → docs/2.3.0/fedex-pysrc.html b/docs/2.2.0/fedex-pysrc.html → docs/2.3.0/fedex-pysrc.html
@@ -109,7 +109,7 @@ <h1 class="epydoc">Source Code for <a href="fedex-module.html">Package fedex</a>
 <a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line"><tt class="py-docstring">our U{Github project&lt;http://github.com/gtaylor/python-fedex/&gt;} and enter</tt> </tt>
 <a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line"><tt class="py-docstring">an issue in the U{Issue Tracker&lt;http://github.com/gtaylor/python-fedex/issues&gt;}.</tt> </tt>
 <a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
-<a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable fedex.VERSION=fedex-module.html#VERSION"><a title="fedex.VERSION" class="py-name" href="#" onclick="return doclink('link-0', 'VERSION', 'link-0');">VERSION</a></tt> <tt class="py-op">=</tt> <tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">'2.2.0'</tt> </tt>
+<a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable fedex.VERSION=fedex-module.html#VERSION"><a title="fedex.VERSION" class="py-name" href="#" onclick="return doclink('link-0', 'VERSION', 'link-0');">VERSION</a></tt> <tt class="py-op">=</tt> <tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">'2.3.0'</tt> </tt>
 <a name="L56"></a><tt class="py-lineno">56</tt>  <tt class="py-line"> </tt><script type="text/javascript">
 <!--
 expandto(location.href);
@@ -143,7 +143,7 @@ <h1 class="epydoc">Source Code for <a href="fedex-module.html">Package fedex</a>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016
+    Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:06 2016
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/2.2.0/fedex.base_service-module.html → docs/2.3.0/fedex.base_service-module.html b/docs/2.2.0/fedex.base_service-module.html → docs/2.3.0/fedex.base_service-module.html
@@ -183,7 +183,7 @@ <h1 class="epydoc">Module base_service</h1><p class="nomargin-top"><span class="
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016
+    Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:05 2016
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"