apiclient.discovery
index
/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/discovery.py

Client for discovery based APIs
 
A client library for Google's discovery based APIs.

 
Modules
       
copy
httplib2
logging
apiclient.mimeparse
mimetypes
os
re
simplejson
uritemplate
urllib
urlparse

 
Functions
       
build(serviceName, version, http=None, discoveryServiceUrl='https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest', developerKey=None, model=None, requestBuilder=<class 'apiclient.http.HttpRequest'>)
Construct a Resource for interacting with an API.
 
Construct a Resource object for interacting with
an API. The serviceName and version are the
names from the Discovery service.
 
Args:
  serviceName: string, name of the service
  version: string, the version of the service
  discoveryServiceUrl: string, a URI Template that points to
    the location of the discovery service. It should have two
    parameters {api} and {apiVersion} that when filled in
    produce an absolute URI to the discovery document for
    that service.
  developerKey: string, key obtained
    from https://code.google.com/apis/console
  model: apiclient.Model, converts to and from the wire format
  requestBuilder: apiclient.http.HttpRequest, encapsulator for
    an HTTP request
 
Returns:
  A Resource object with methods for interacting with
  the service.
build_from_document(service, base, future=None, http=None, developerKey=None, model=None, requestBuilder=<class 'apiclient.http.HttpRequest'>)
Create a Resource for interacting with an API.
 
Same as `build()`, but constructs the Resource object
from a discovery document that is it given, as opposed to
retrieving one over HTTP.
 
Args:
  service: string, discovery document
  base: string, base URI for all HTTP requests, usually the discovery URI
  future: string, discovery document with future capabilities
  auth_discovery: dict, information about the authentication the API supports
  http: httplib2.Http, An instance of httplib2.Http or something that acts
    like it that HTTP requests will be made through.
  developerKey: string, Key for controlling API usage, generated
    from the API Console.
  model: Model class instance that serializes and
    de-serializes requests and responses.
  requestBuilder: Takes an http request and packages it up to be executed.
 
Returns:
  A Resource object with methods for interacting with
  the service.

 
Data
        __all__ = ['build', 'build_from_document']
__author__ = 'jcgregorio@google.com (Joe Gregorio)'

 
Author
        jcgregorio@google.com (Joe Gregorio)