| Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 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>apiclient.sample_tools</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 | |
| 18 | <!-- Tree link --> |
| 19 | <th> <a |
| 20 | href="module-tree.html">Trees</a> </th> |
| 21 | |
| 22 | <!-- Index link --> |
| 23 | <th> <a |
| 24 | href="identifier-index.html">Indices</a> </th> |
| 25 | |
| 26 | <!-- Help link --> |
| 27 | <th> <a |
| 28 | href="help.html">Help</a> </th> |
| 29 | |
| 30 | <th class="navbar" width="100%"></th> |
| 31 | </tr> |
| 32 | </table> |
| 33 | <table width="100%" cellpadding="0" cellspacing="0"> |
| 34 | <tr valign="top"> |
| 35 | <td width="100%"> |
| 36 | <span class="breadcrumbs"> |
| 37 | <a href="apiclient-module.html">Package apiclient</a> :: |
| 38 | Module sample_tools |
| 39 | </span> |
| 40 | </td> |
| 41 | <td> |
| 42 | <table cellpadding="0" cellspacing="0"> |
| 43 | <!-- hide/show private --> |
| 44 | <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| 45 | onclick="toggle_private();">hide private</a>]</span></td></tr> |
| 46 | <tr><td align="right"><span class="options" |
| 47 | >[<a href="frames.html" target="_top">frames</a |
| 48 | >] | <a href="apiclient.sample_tools-module.html" |
| 49 | target="_top">no frames</a>]</span></td></tr> |
| 50 | </table> |
| 51 | </td> |
| 52 | </tr> |
| 53 | </table> |
| 54 | <!-- ==================== MODULE DESCRIPTION ==================== --> |
| 55 | <h1 class="epydoc">Module sample_tools</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.sample_tools-pysrc.html">source code</a></span></p> |
| 56 | <pre class="literalblock"> |
| 57 | Utilities for making samples. |
| 58 | |
| 59 | Consolidates a lot of code commonly repeated in sample applications. |
| 60 | |
| 61 | </pre> |
| 62 | |
| 63 | <hr /> |
| 64 | <div class="fields"> <p><strong>Author:</strong> |
| 65 | jcgregorio@google.com (Joe Gregorio) |
| 66 | </p> |
| 67 | </div><!-- ==================== FUNCTIONS ==================== --> |
| 68 | <a name="section-Functions"></a> |
| 69 | <table class="summary" border="1" cellpadding="3" |
| 70 | cellspacing="0" width="100%" bgcolor="white"> |
| 71 | <tr bgcolor="#70b0f0" class="table-header"> |
| 72 | <td colspan="2" class="table-header"> |
| 73 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 74 | <tr valign="top"> |
| 75 | <td align="left"><span class="table-header">Functions</span></td> |
| 76 | <td align="right" valign="top" |
| 77 | ><span class="options">[<a href="#section-Functions" |
| 78 | class="privatelink" onclick="toggle_private();" |
| 79 | >hide private</a>]</span></td> |
| 80 | </tr> |
| 81 | </table> |
| 82 | </td> |
| 83 | </tr> |
| 84 | <tr> |
| 85 | <td width="15%" align="right" valign="top" class="summary"> |
| 86 | <span class="summary-type"> </span> |
| 87 | </td><td class="summary"> |
| 88 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 89 | <tr> |
| 90 | <td><span class="summary-sig"><a href="apiclient.sample_tools-module.html#init" class="summary-sig-name">init</a>(<span class="summary-sig-arg">argv</span>, |
| 91 | <span class="summary-sig-arg">name</span>, |
| 92 | <span class="summary-sig-arg">version</span>, |
| 93 | <span class="summary-sig-arg">doc</span>, |
| 94 | <span class="summary-sig-arg">filename</span>, |
| 95 | <span class="summary-sig-arg">scope</span>=<span class="summary-sig-default">None</span>, |
| 96 | <span class="summary-sig-arg">parents</span>=<span class="summary-sig-default">[]</span>)</span><br /> |
| 97 | A common initialization routine for samples.</td> |
| 98 | <td align="right" valign="top"> |
| 99 | <span class="codelink"><a href="apiclient.sample_tools-pysrc.html#init">source code</a></span> |
| 100 | |
| 101 | </td> |
| 102 | </tr> |
| 103 | </table> |
| 104 | |
| 105 | </td> |
| 106 | </tr> |
| 107 | </table> |
| 108 | <!-- ==================== FUNCTION DETAILS ==================== --> |
| 109 | <a name="section-FunctionDetails"></a> |
| 110 | <table class="details" border="1" cellpadding="3" |
| 111 | cellspacing="0" width="100%" bgcolor="white"> |
| 112 | <tr bgcolor="#70b0f0" class="table-header"> |
| 113 | <td colspan="2" class="table-header"> |
| 114 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 115 | <tr valign="top"> |
| 116 | <td align="left"><span class="table-header">Function Details</span></td> |
| 117 | <td align="right" valign="top" |
| 118 | ><span class="options">[<a href="#section-FunctionDetails" |
| 119 | class="privatelink" onclick="toggle_private();" |
| 120 | >hide private</a>]</span></td> |
| 121 | </tr> |
| 122 | </table> |
| 123 | </td> |
| 124 | </tr> |
| 125 | </table> |
| 126 | <a name="init"></a> |
| 127 | <div> |
| 128 | <table class="details" border="1" cellpadding="3" |
| 129 | cellspacing="0" width="100%" bgcolor="white"> |
| 130 | <tr><td> |
| 131 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 132 | <tr valign="top"><td> |
| 133 | <h3 class="epydoc"><span class="sig"><span class="sig-name">init</span>(<span class="sig-arg">argv</span>, |
| 134 | <span class="sig-arg">name</span>, |
| 135 | <span class="sig-arg">version</span>, |
| 136 | <span class="sig-arg">doc</span>, |
| 137 | <span class="sig-arg">filename</span>, |
| 138 | <span class="sig-arg">scope</span>=<span class="sig-default">None</span>, |
| 139 | <span class="sig-arg">parents</span>=<span class="sig-default">[]</span>)</span> |
| 140 | </h3> |
| 141 | </td><td align="right" valign="top" |
| 142 | ><span class="codelink"><a href="apiclient.sample_tools-pysrc.html#init">source code</a></span> |
| 143 | </td> |
| 144 | </tr></table> |
| 145 | |
| 146 | <pre class="literalblock"> |
| 147 | A common initialization routine for samples. |
| 148 | |
| 149 | Many of the sample applications do the same initialization, which has now |
| 150 | been consolidated into this function. This function uses common idioms found |
| 151 | in almost all the samples, i.e. for an API with name 'apiname', the |
| 152 | credentials are stored in a file named apiname.dat, and the |
| 153 | client_secrets.json file is stored in the same directory as the application |
| 154 | main file. |
| 155 | |
| 156 | Args: |
| 157 | argv: list of string, the command-line parameters of the application. |
| 158 | name: string, name of the API. |
| 159 | version: string, version of the API. |
| 160 | doc: string, description of the application. Usually set to __doc__. |
| 161 | file: string, filename of the application. Usually set to __file__. |
| 162 | parents: list of argparse.ArgumentParser, additional command-line flags. |
| 163 | scope: string, The OAuth scope used. |
| 164 | |
| 165 | Returns: |
| 166 | A tuple of (service, flags), where service is the service object and flags |
| 167 | is the parsed command-line flags. |
| 168 | |
| 169 | </pre> |
| 170 | <dl class="fields"> |
| 171 | </dl> |
| 172 | </td></tr></table> |
| 173 | </div> |
| 174 | <br /> |
| 175 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 176 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 177 | bgcolor="#a0c0ff" cellspacing="0"> |
| 178 | <tr valign="middle"> |
| 179 | |
| 180 | <!-- Tree link --> |
| 181 | <th> <a |
| 182 | href="module-tree.html">Trees</a> </th> |
| 183 | |
| 184 | <!-- Index link --> |
| 185 | <th> <a |
| 186 | href="identifier-index.html">Indices</a> </th> |
| 187 | |
| 188 | <!-- Help link --> |
| 189 | <th> <a |
| 190 | href="help.html">Help</a> </th> |
| 191 | |
| 192 | <th class="navbar" width="100%"></th> |
| 193 | </tr> |
| 194 | </table> |
| 195 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 196 | <tr> |
| 197 | <td align="left" class="footer"> |
| 198 | Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:42 2013 |
| 199 | </td> |
| 200 | <td align="right" class="footer"> |
| 201 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 202 | >http://epydoc.sourceforge.net</a> |
| 203 | </td> |
| 204 | </tr> |
| 205 | </table> |
| 206 | |
| 207 | <script type="text/javascript"> |
| 208 | <!-- |
| 209 | // Private objects are initially displayed (because if |
| 210 | // javascript is turned off then we want them to be |
| 211 | // visible); but by default, we want to hide them. So hide |
| 212 | // them unless we have a cookie that says to show them. |
| 213 | checkCookie(); |
| 214 | // --> |
| 215 | </script> |
| 216 | </body> |
| 217 | </html> |