Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 497c39f73a1d7e35e9c4cba8119f87c65799258b / . / docs / oauth2client.tools.html
blob: f7e39b9990715f1b317c625ddc74a8844936d5b0 [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 Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/tools.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/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 Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]19<tr bgcolor="#aa55cc">
20<td colspan=3 valign=bottom>&nbsp;<br>
21<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
22
23<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
24<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="BaseHTTPServer.html">BaseHTTPServer</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]25<a href="gflags.html">gflags</a><br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]26</td><td width="25%" valign=top><a href="socket.html">socket</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]27<a href="sys.html">sys</a><br>
28</td><td width="25%" valign=top><a href="webbrowser.html">webbrowser</a><br>
29</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]30<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]31<tr bgcolor="#eeaa77">
32<td colspan=3 valign=bottom>&nbsp;<br>
33<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
34
35<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]36<td width="100%"><dl><dt><a name="-run"><strong>run</strong></a>(flow, storage, http<font color="#909090">=None</font>)</dt><dd><tt>Core&nbsp;code&nbsp;for&nbsp;a&nbsp;command-line&nbsp;application.<br>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]37&nbsp;<br>
38Args:<br>
39&nbsp;&nbsp;flow:&nbsp;Flow,&nbsp;an&nbsp;OAuth&nbsp;2.0&nbsp;Flow&nbsp;to&nbsp;step&nbsp;through.<br>
40&nbsp;&nbsp;storage:&nbsp;Storage,&nbsp;a&nbsp;Storage&nbsp;to&nbsp;store&nbsp;the&nbsp;credential&nbsp;in.<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]41&nbsp;&nbsp;http:&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http.request<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;something&nbsp;that&nbsp;acts&nbsp;like&nbsp;it.<br>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]43&nbsp;<br>
44Returns:<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]45&nbsp;&nbsp;Credentials,&nbsp;the&nbsp;obtained&nbsp;credential.</tt></dd></dl>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]46</td></tr></table><p>
47<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
48<tr bgcolor="#55aa55">
49<td colspan=3 valign=bottom>&nbsp;<br>
50<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
51
52<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
53<td width="100%"><strong>__all__</strong> = ['run']<br>
54<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
55<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
56<tr bgcolor="#7799ee">
57<td colspan=3 valign=bottom>&nbsp;<br>
58<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
59
60<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
61<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
62</body></html>