Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / fffa7d74f610637b2a213739f664826b55a904f6 / . / docs / oauth2client.tools.html
blob: 50e66a747f396aa02bb78a4028bf4e1933cfc286 [file] [log] [blame]
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module oauth2client.tools</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.tools</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame^]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiary/oauth2client/tools.py">/home/jcgregorio/projects/apiary/oauth2client/tools.py</a></font></td></tr></table>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]12 <p><tt>Command-line&nbsp;tools&nbsp;for&nbsp;authenticating&nbsp;via&nbsp;OAuth&nbsp;2.0<br>
13&nbsp;<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]14Do&nbsp;the&nbsp;OAuth&nbsp;2.0&nbsp;Web&nbsp;Server&nbsp;dance&nbsp;for&nbsp;a&nbsp;command&nbsp;line&nbsp;application.&nbsp;Stores&nbsp;the<br>
15generated&nbsp;credentials&nbsp;in&nbsp;a&nbsp;common&nbsp;file&nbsp;that&nbsp;is&nbsp;used&nbsp;by&nbsp;other&nbsp;example&nbsp;apps&nbsp;in<br>
16the&nbsp;same&nbsp;directory.</tt></p>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]17<p>
18<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]19<tr bgcolor="#eeaa77">
20<td colspan=3 valign=bottom>&nbsp;<br>
21<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
22
23<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame^]24<td width="100%"><dl><dt><a name="-run"><strong>run</strong></a>(flow, storage)</dt><dd><tt>Core&nbsp;code&nbsp;for&nbsp;a&nbsp;command-line&nbsp;application.<br>
25&nbsp;<br>
26Args:<br>
27&nbsp;&nbsp;flow:&nbsp;Flow,&nbsp;an&nbsp;OAuth&nbsp;2.0&nbsp;Flow&nbsp;to&nbsp;step&nbsp;through.<br>
28&nbsp;&nbsp;storage:&nbsp;Storage,&nbsp;a&nbsp;Storage&nbsp;to&nbsp;store&nbsp;the&nbsp;credential&nbsp;in.<br>
29&nbsp;<br>
30Returns:<br>
31&nbsp;&nbsp;Credentials,&nbsp;the&nbsp;obtained&nbsp;credential.<br>
32&nbsp;<br>
33Exceptions:<br>
34&nbsp;&nbsp;RequestError:&nbsp;if&nbsp;step2&nbsp;of&nbsp;the&nbsp;flow&nbsp;fails.</tt></dd></dl>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]35</td></tr></table><p>
36<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
37<tr bgcolor="#55aa55">
38<td colspan=3 valign=bottom>&nbsp;<br>
39<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
40
41<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
42<td width="100%"><strong>__all__</strong> = ['run']<br>
43<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
44<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
45<tr bgcolor="#7799ee">
46<td colspan=3 valign=bottom>&nbsp;<br>
47<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
48
49<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
50<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
51</body></html>