|
| 1 | +<?xml version="1.0" encoding="ascii"?> |
| 2 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 3 | + "DTD/xhtml1-transitional.dtd"> |
| 4 | +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 5 | +<head> |
| 6 | + <title>fedex</title> |
| 7 | + <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| 8 | + <script type="text/javascript" src="epydoc.js"></script> |
| 9 | +</head> |
| 10 | + |
| 11 | +<body bgcolor="white" text="black" link="blue" vlink="#204080" |
| 12 | + alink="#204080"> |
| 13 | +<!-- ==================== NAVIGATION BAR ==================== --> |
| 14 | +<table class="navbar" border="0" width="100%" cellpadding="0" |
| 15 | + bgcolor="#a0c0ff" cellspacing="0"> |
| 16 | + <tr valign="middle"> |
| 17 | + <!-- Home link --> |
| 18 | + <th bgcolor="#70b0f0" class="navbar-select" |
| 19 | + > Home </th> |
| 20 | + |
| 21 | + <!-- Tree link --> |
| 22 | + <th> <a |
| 23 | + href="module-tree.html">Trees</a> </th> |
| 24 | + |
| 25 | + <!-- Index link --> |
| 26 | + <th> <a |
| 27 | + href="identifier-index.html">Indices</a> </th> |
| 28 | + |
| 29 | + <!-- Help link --> |
| 30 | + <th> <a |
| 31 | + href="help.html">Help</a> </th> |
| 32 | + |
| 33 | + <!-- Project homepage --> |
| 34 | + <th class="navbar" align="right" width="100%"> |
| 35 | + <table border="0" cellpadding="0" cellspacing="0"> |
| 36 | + <tr><th class="navbar" align="center" |
| 37 | + ><a class="navbar" target="_top" href="http://code.google.com/p/python-fedex/">python-fedex</a></th> |
| 38 | + </tr></table></th> |
| 39 | + </tr> |
| 40 | +</table> |
| 41 | +<table width="100%" cellpadding="0" cellspacing="0"> |
| 42 | + <tr valign="top"> |
| 43 | + <td width="100%"> |
| 44 | + <span class="breadcrumbs"> |
| 45 | + Package fedex |
| 46 | + </span> |
| 47 | + </td> |
| 48 | + <td> |
| 49 | + <table cellpadding="0" cellspacing="0"> |
| 50 | + <!-- hide/show private --> |
| 51 | + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| 52 | + onclick="toggle_private();">hide private</a>]</span></td></tr> |
| 53 | + <tr><td align="right"><span class="options" |
| 54 | + >[<a href="frames.html" target="_top">frames</a |
| 55 | + >] | <a href="fedex-module.html" |
| 56 | + target="_top">no frames</a>]</span></td></tr> |
| 57 | + </table> |
| 58 | + </td> |
| 59 | + </tr> |
| 60 | +</table> |
| 61 | +<!-- ==================== PACKAGE DESCRIPTION ==================== --> |
| 62 | +<h1 class="epydoc">Package fedex</h1><p class="nomargin-top"><span class="codelink"><a href="fedex-pysrc.html">source code</a></span></p> |
| 63 | +<h1 class="heading">python-fedex API Documentation</h1> |
| 64 | + <p>The python-fedex module is a light wrapper around Fedex's Web |
| 65 | + Services SOAP API. Using the excellent <a |
| 66 | + href="https://fedorahosted.org/suds/" target="_top">suds</a> SOAP |
| 67 | + client, the Fedex requests and responses are trivial to work with.</p> |
| 68 | + <h2 class="heading">What python-fedex is</h2> |
| 69 | + <ul> |
| 70 | + <li> |
| 71 | + A light wrapper around Fedex Web Services SOAP API. |
| 72 | + </li> |
| 73 | + <li> |
| 74 | + Simple and easy to use. |
| 75 | + </li> |
| 76 | + <li> |
| 77 | + Minimal by design. |
| 78 | + </li> |
| 79 | + </ul> |
| 80 | + <h2 class="heading">What python-fedex is not</h2> |
| 81 | + <ul> |
| 82 | + <li> |
| 83 | + An abstraction layer. python-fedex only assembles the needed SOAP |
| 84 | + calls and returns a SOAP response through suds. This is easy |
| 85 | + enough to work with that no abstraction is needed. Doing so would |
| 86 | + limit your use of the data. |
| 87 | + </li> |
| 88 | + <li> |
| 89 | + Anything more than a light wrapper. |
| 90 | + </li> |
| 91 | + </ul> |
| 92 | + <h2 class="heading">A note on completeness</h2> |
| 93 | + <p>python-fedex was created for use with some of my internal |
| 94 | + projects. For the initial release, only the things that I needed at |
| 95 | + the time were implemented. If there is missing functionality, please |
| 96 | + report an <a href="http://code.google.com/p/python-fedex/issues/list" |
| 97 | + target="_top">issue</a> so that I may make this module more useful to |
| 98 | + others. Likewise, feel free to submit patches as well if you would |
| 99 | + like to help.</p> |
| 100 | + <h2 class="heading">Getting Started</h2> |
| 101 | + <p>The best place to get started is by viewing the examples in the |
| 102 | + 'examples' directory. These should be very self-explanatory. For |
| 103 | + further details, you may review the API here, or get support by |
| 104 | + reading the instructions in the appropriately named section |
| 105 | + below.</p> |
| 106 | + <p>The <a href="fedex.services-module.html" class="link">services</a> |
| 107 | + module is also a good place to start looking at the different objects |
| 108 | + used for issuing Fedex requests.</p> |
| 109 | + <p>As a general tip, the best way to see which attributes are |
| 110 | + available on WSDL objects is to simply print them, hitting their |
| 111 | + __str__() method.</p> |
| 112 | + <h2 class="heading">Fedex Documentation</h2> |
| 113 | + <p>If you are wondering what attributes or variables are present, |
| 114 | + you'll want to refer to the Fedex Web Services documentation at |
| 115 | + http://fedex.com/developer/. Complete specification documents are |
| 116 | + there, which correspond very closely with what you'll be able to do |
| 117 | + with python-fedex.</p> |
| 118 | + <h2 class="heading">Getting Support</h2> |
| 119 | + <p>If you have any questions, problems, ideas, or patch submissions, |
| 120 | + please visit our <a href="http://code.google.com/p/python-fedex/" |
| 121 | + target="_top">Google Code project</a> and enter an issue in the <a |
| 122 | + href="http://code.google.com/p/python-fedex/issues/list" |
| 123 | + target="_top">Issue Tracker</a>.</p> |
| 124 | + |
| 125 | +<!-- ==================== SUBMODULES ==================== --> |
| 126 | +<a name="section-Submodules"></a> |
| 127 | +<table class="summary" border="1" cellpadding="3" |
| 128 | + cellspacing="0" width="100%" bgcolor="white"> |
| 129 | +<tr bgcolor="#70b0f0" class="table-header"> |
| 130 | + <td colspan="2" class="table-header"> |
| 131 | + <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 132 | + <tr valign="top"> |
| 133 | + <td align="left"><span class="table-header">Submodules</span></td> |
| 134 | + <td align="right" valign="top" |
| 135 | + ><span class="options">[<a href="#section-Submodules" |
| 136 | + class="privatelink" onclick="toggle_private();" |
| 137 | + >hide private</a>]</span></td> |
| 138 | + </tr> |
| 139 | + </table> |
| 140 | + </td> |
| 141 | +</tr> |
| 142 | + <tr><td class="summary"> |
| 143 | + <ul class="nomargin"> |
| 144 | + <li> <strong class="uidlink"><a href="fedex.base_service-module.html">fedex.base_service</a></strong>: <em class="summary">The <a href="fedex.base_service-module.html" |
| 145 | + class="link">base_service</a> module contains classes that form the |
| 146 | + low level foundations of the Web Service API.</em> </li> |
| 147 | + <li> <strong class="uidlink"><a href="fedex.config-module.html">fedex.config</a></strong>: <em class="summary">The <a href="fedex.config-module.html" class="link">config</a> |
| 148 | + module contains the <a href="fedex.config.FedexConfig-class.html" |
| 149 | + class="link">FedexConfig</a> class, which is passed to the Fedex |
| 150 | + API calls.</em> </li> |
| 151 | + <li> <strong class="uidlink"><a href="fedex.printers-module.html">fedex.printers</a></strong>: <em class="summary">Optional classes used for the convenient printing of FedEx labels |
| 152 | + from <a |
| 153 | + href="fedex.services.ship_service.FedexProcessShipmentRequest-class.html" |
| 154 | + class="link">FedexProcessShipmentRequest</a> objects.</em> |
| 155 | + <ul> |
| 156 | + <li> <strong class="uidlink"><a href="fedex.printers.unix-module.html">fedex.printers.unix</a></strong>: <em class="summary">This module provides a label printing wrapper class for Unix-based |
| 157 | + installations.</em> </li> |
| 158 | + </ul> |
| 159 | + </li> |
| 160 | + <li> <strong class="uidlink"><a href="fedex.services-module.html">fedex.services</a></strong>: <em class="summary">This module contains the wrappers around Fedex Web Service requests |
| 161 | + which you will want to instantiate and use with a <a |
| 162 | + href="fedex.config.FedexConfig-class.html" |
| 163 | + class="link">FedexConfig</a> object supplying your static details.</em> |
| 164 | + <ul> |
| 165 | + <li> <strong class="uidlink"><a href="fedex.services.address_validation_service-module.html">fedex.services.address_validation_service</a></strong>: <em class="summary">This package contains the shipping methods defined by Fedex's |
| 166 | + AddressValidationService WSDL file.</em> </li> |
| 167 | + <li> <strong class="uidlink"><a href="fedex.services.ship_service-module.html">fedex.services.ship_service</a></strong>: <em class="summary">This package contains the shipping methods defined by Fedex's |
| 168 | + ShipService WSDL file.</em> </li> |
| 169 | + <li> <strong class="uidlink"><a href="fedex.services.track_service-module.html">fedex.services.track_service</a></strong>: <em class="summary">This package contains the shipment tracking methods defined by |
| 170 | + Fedex's TrackService WSDL file.</em> </li> |
| 171 | + </ul> |
| 172 | + </li> |
| 173 | + </ul></td></tr> |
| 174 | +</table> |
| 175 | + |
| 176 | +<br /> |
| 177 | +<!-- ==================== VARIABLES ==================== --> |
| 178 | +<a name="section-Variables"></a> |
| 179 | +<table class="summary" border="1" cellpadding="3" |
| 180 | + cellspacing="0" width="100%" bgcolor="white"> |
| 181 | +<tr bgcolor="#70b0f0" class="table-header"> |
| 182 | + <td colspan="2" class="table-header"> |
| 183 | + <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 184 | + <tr valign="top"> |
| 185 | + <td align="left"><span class="table-header">Variables</span></td> |
| 186 | + <td align="right" valign="top" |
| 187 | + ><span class="options">[<a href="#section-Variables" |
| 188 | + class="privatelink" onclick="toggle_private();" |
| 189 | + >hide private</a>]</span></td> |
| 190 | + </tr> |
| 191 | + </table> |
| 192 | + </td> |
| 193 | +</tr> |
| 194 | +<tr> |
| 195 | + <td width="15%" align="right" valign="top" class="summary"> |
| 196 | + <span class="summary-type"> </span> |
| 197 | + </td><td class="summary"> |
| 198 | + <a name="VERSION"></a><span class="summary-name">VERSION</span> = <code title="'1.0.3'"><code class="variable-quote">'</code><code class="variable-string">1.0.3</code><code class="variable-quote">'</code></code> |
| 199 | + </td> |
| 200 | + </tr> |
| 201 | +<tr> |
| 202 | + <td width="15%" align="right" valign="top" class="summary"> |
| 203 | + <span class="summary-type"> </span> |
| 204 | + </td><td class="summary"> |
| 205 | + <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code> |
| 206 | + </td> |
| 207 | + </tr> |
| 208 | +</table> |
| 209 | +<!-- ==================== NAVIGATION BAR ==================== --> |
| 210 | +<table class="navbar" border="0" width="100%" cellpadding="0" |
| 211 | + bgcolor="#a0c0ff" cellspacing="0"> |
| 212 | + <tr valign="middle"> |
| 213 | + <!-- Home link --> |
| 214 | + <th bgcolor="#70b0f0" class="navbar-select" |
| 215 | + > Home </th> |
| 216 | + |
| 217 | + <!-- Tree link --> |
| 218 | + <th> <a |
| 219 | + href="module-tree.html">Trees</a> </th> |
| 220 | + |
| 221 | + <!-- Index link --> |
| 222 | + <th> <a |
| 223 | + href="identifier-index.html">Indices</a> </th> |
| 224 | + |
| 225 | + <!-- Help link --> |
| 226 | + <th> <a |
| 227 | + href="help.html">Help</a> </th> |
| 228 | + |
| 229 | + <!-- Project homepage --> |
| 230 | + <th class="navbar" align="right" width="100%"> |
| 231 | + <table border="0" cellpadding="0" cellspacing="0"> |
| 232 | + <tr><th class="navbar" align="center" |
| 233 | + ><a class="navbar" target="_top" href="http://code.google.com/p/python-fedex/">python-fedex</a></th> |
| 234 | + </tr></table></th> |
| 235 | + </tr> |
| 236 | +</table> |
| 237 | +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 238 | + <tr> |
| 239 | + <td align="left" class="footer"> |
| 240 | + Generated by Epydoc 3.0.1 on Thu Mar 25 11:33:58 2010 |
| 241 | + </td> |
| 242 | + <td align="right" class="footer"> |
| 243 | + <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 244 | + >http://epydoc.sourceforge.net</a> |
| 245 | + </td> |
| 246 | + </tr> |
| 247 | +</table> |
| 248 | + |
| 249 | +<script type="text/javascript"> |
| 250 | + <!-- |
| 251 | + // Private objects are initially displayed (because if |
| 252 | + // javascript is turned off then we want them to be |
| 253 | + // visible); but by default, we want to hide them. So hide |
| 254 | + // them unless we have a cookie that says to show them. |
| 255 | + checkCookie(); |
| 256 | + // --> |
| 257 | +</script> |
| 258 | +</body> |
| 259 | +</html> |
0 commit comments