Refresh docs
diff --git a/docs/epy/oauth2client.tools-module.html b/docs/epy/oauth2client.tools-module.html
index 7ad7db6..888070d 100644
--- a/docs/epy/oauth2client.tools-module.html
+++ b/docs/epy/oauth2client.tools-module.html
@@ -123,11 +123,46 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a href="oauth2client.tools-module.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">flow</span>,
+ <td><span class="summary-sig"><a href="oauth2client.tools-module.html#run_flow" class="summary-sig-name">run_flow</a>(<span class="summary-sig-arg">flow</span>,
<span class="summary-sig-arg">storage</span>,
+ <span class="summary-sig-arg">flags</span>,
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
Core code for a command-line application.</td>
<td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.tools-pysrc.html#run_flow">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="message_if_missing"></a><span class="summary-sig-name">message_if_missing</span>(<span class="summary-sig-arg">filename</span>)</span><br />
+ Helpful message to display if the CLIENT_SECRETS file is missing.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.tools-pysrc.html#message_if_missing">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">*args</span>,
+ <span class="summary-sig-arg">**kwargs</span>)</span></td>
+ <td align="right" valign="top">
<span class="codelink"><a href="oauth2client.tools-pysrc.html#run">source code</a></span>
</td>
@@ -158,7 +193,22 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a name="FLAGS"></a><span class="summary-name">FLAGS</span> = <code title="gflags.FLAGS">gflags.FLAGS</code>
+ <a href="oauth2client.tools-module.html#_CLIENT_SECRETS_MESSAGE" class="summary-name" onclick="show_private();">_CLIENT_SECRETS_MESSAGE</a> = <code title=""""WARNING: Please configure OAuth 2.0
+
+To make this sample run you will need to populate the client_secrets.j\
+son file
+found at:
+
+ %s
+
+...">"""WARNING: Please configure OAuth <code class="variable-ellipsis">...</code></code>
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <a name="argparser"></a><span class="summary-name">argparser</span> = <code title="argparse.ArgumentParser(add_help= False)">argparse.ArgumentParser(add_help= False)</code>
</td>
</tr>
</table>
@@ -180,19 +230,20 @@
</td>
</tr>
</table>
-<a name="run"></a>
+<a name="run_flow"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">flow</span>,
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">run_flow</span>(<span class="sig-arg">flow</span>,
<span class="sig-arg">storage</span>,
+ <span class="sig-arg">flags</span>,
<span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
- ><span class="codelink"><a href="oauth2client.tools-pysrc.html#run">source code</a></span>
+ ><span class="codelink"><a href="oauth2client.tools-pysrc.html#run_flow">source code</a></span>
</td>
</tr></table>
@@ -224,12 +275,19 @@
during OAuth authorization.
(default: 'true')
-Since it uses flags make sure to initialize the gflags module before calling
-run().
+The tools module defines an ArgumentParser the already contains the flag
+definitions that run() requires. You can pass that ArgumentParser to your
+ArgumentParser constructor:
+
+ parser = argparse.ArgumentParser(description=__doc__,
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ parents=[tools.run_parser])
+ flags = parser.parse_args(argv)
Args:
flow: Flow, an OAuth 2.0 Flow to step through.
storage: Storage, a Storage to store the credential in.
+ flags: argparse.ArgumentParser, the command-line flags.
http: An instance of httplib2.Http.request
or something that acts like it.
@@ -240,12 +298,57 @@
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
- <li><code>@util.positional(2)</code></li>
+ <li><code>@util.positional(3)</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
+<!-- ==================== VARIABLES DETAILS ==================== -->
+<a name="section-VariablesDetails"></a>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr bgcolor="#70b0f0" class="table-header">
+ <td colspan="2" class="table-header">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr valign="top">
+ <td align="left"><span class="table-header">Variables Details</span></td>
+ <td align="right" valign="top"
+ ><span class="options">[<a href="#section-VariablesDetails"
+ class="privatelink" onclick="toggle_private();"
+ >hide private</a>]</span></td>
+ </tr>
+ </table>
+ </td>
+</tr>
+</table>
+<a name="_CLIENT_SECRETS_MESSAGE"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <h3 class="epydoc">_CLIENT_SECRETS_MESSAGE</h3>
+
+ <dl class="fields">
+ </dl>
+ <dl class="fields">
+ <dt>Value:</dt>
+ <dd><table><tr><td><pre class="variable">
+"""WARNING: Please configure OAuth 2.0
+
+To make this sample run you will need to populate the client_secrets.j<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
+son file
+found at:
+
+ %s
+
+<code class="variable-ellipsis">...</code>
+</pre></td></tr></table>
+</dd>
+ </dl>
+</td></tr></table>
+</div>
+<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
@@ -269,7 +372,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:23 2013
+ Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:42 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"