| Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: module apiclient.discovery</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> <br> |
| 9 | <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.discovery</strong></big></big></font></td |
| 10 | ><td align=right valign=bottom |
| Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame^] | 11 | ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiary/apiclient/discovery.py">/home/jcgregorio/projects/apiary/apiclient/discovery.py</a></font></td></tr></table> |
| Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 12 | <p><tt>Client for discovery based APIs<br> |
| 13 | <br> |
| 14 | A client library for Google's discovery<br> |
| 15 | based APIs.</tt></p> |
| 16 | <p> |
| 17 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 18 | <tr bgcolor="#aa55cc"> |
| 19 | <td colspan=3 valign=bottom> <br> |
| 20 | <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| 21 | |
| 22 | <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| 23 | <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httplib2.html">httplib2</a><br> |
| 24 | <a href="logging.html">logging</a><br> |
| 25 | </td><td width="25%" valign=top><a href="os.html">os</a><br> |
| 26 | <a href="re.html">re</a><br> |
| 27 | </td><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br> |
| 28 | <a href="uritemplate.html">uritemplate</a><br> |
| 29 | </td><td width="25%" valign=top><a href="urllib.html">urllib</a><br> |
| 30 | <a href="urlparse.html">urlparse</a><br> |
| 31 | </td></tr></table></td></tr></table><p> |
| 32 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 33 | <tr bgcolor="#eeaa77"> |
| 34 | <td colspan=3 valign=bottom> <br> |
| 35 | <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> |
| 36 | |
| 37 | <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> |
| 38 | <td width="100%"><dl><dt><a name="-build"><strong>build</strong></a>(serviceName, version, http<font color="#909090">=None</font>, discoveryServiceUrl<font color="#909090">='https://www.googleapis.com/discovery/v0.2beta1/describe/{api}/{apiVersion}'</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=<apiclient.model.JsonModel object></font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt></dl> |
| Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame^] | 39 | <dl><dt><a name="-build_from_document"><strong>build_from_document</strong></a>(service, base, future<font color="#909090">=None</font>, http<font color="#909090">=None</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=<apiclient.model.JsonModel object></font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt><dd><tt>Args:<br> |
| 40 | service: string, discovery document<br> |
| 41 | base: string, base URI for all HTTP requests, usually the discovery URI<br> |
| 42 | future: string, discovery document with future capabilities<br> |
| 43 | auth_discovery: dict, information about the authentication the API supports<br> |
| 44 | http: httplib2.Http, An instance of httplib2.Http or something that acts<br> |
| 45 | like it that HTTP requests will be made through.<br> |
| 46 | developerKey: string, Key for controlling API usage, generated<br> |
| 47 | from the API Console.<br> |
| 48 | model: Model class instance that serializes and<br> |
| 49 | de-serializes requests and responses.<br> |
| 50 | requestBuilder: Takes an http request and packages it up to be executed.</tt></dd></dl> |
| 51 | <dl><dt><a name="-createResource"><strong>createResource</strong></a>(http, baseUrl, model, requestBuilder, developerKey, resourceDesc, futureDesc)</dt></dl> |
| Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 52 | <dl><dt><a name="-key2param"><strong>key2param</strong></a>(key)</dt><dd><tt>max-results -> max_results</tt></dd></dl> |
| 53 | </td></tr></table><p> |
| 54 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 55 | <tr bgcolor="#55aa55"> |
| 56 | <td colspan=3 valign=bottom> <br> |
| 57 | <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| 58 | |
| 59 | <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| 60 | <td width="100%"><strong>DISCOVERY_URI</strong> = 'https://www.googleapis.com/discovery/v0.2beta1/describe/{api}/{apiVersion}'<br> |
| 61 | <strong>URITEMPLATE</strong> = <_sre.SRE_Pattern object><br> |
| 62 | <strong>VARNAME</strong> = <_sre.SRE_Pattern object><br> |
| 63 | <strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p> |
| 64 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 65 | <tr bgcolor="#7799ee"> |
| 66 | <td colspan=3 valign=bottom> <br> |
| 67 | <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| 68 | |
| 69 | <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| 70 | <td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table> |
| 71 | </body></html> |