Updated docstrings and README.md

Author: rowedonalde

README.md

@@ -6,6 +6,9 @@ httplib2. Instead it uses urllib2 as the HTTP transport.
 
 It currently supports Python 2.4 - 2.7, with 3.x support comming in the future.
 
+As of version 0.4.0, ox3apiclient supports API v2. If your instance is v2,
+set the api_path option to "/ox/4.0".
+
 Basic usage:
 
 ````python
@@ -101,5 +104,4 @@ ox = ox3apiclient.Client(
     consumer_secret=consumer_secret)
 
 ox.logon(email, password)
-````
-Test
+````

ox3apiclient/__init__.py

@@ -49,6 +49,13 @@ class UnknownAPIFormatError(ValueError):
     pass
 
 class Client(object):
+    """Client for making requests to the OX3 API. Maintains
+    authentication and points all requests at a domain+path
+    combination. Handles request and response data in the form
+    of Python dictionaries, translated to and from the JSON and
+    query string encoding the API itself uses.
+
+    """ 
 
     def __init__(self, domain, realm, consumer_key, consumer_secret,
                     callback_url='oob',
@@ -321,7 +328,10 @@ def logoff(self):
         return self
 
     def _resolve_url(self, url):
-        """"""
+        """Converts an API path shorthand into a full URL unless
+        given a full url already.
+
+        """
         parse_res = urlparse.urlparse(url)
 
         # 2.4 returns a tuple instead of ParseResult. Since ParseResult is a
@@ -338,12 +348,15 @@ def _resolve_url(self, url):
         return url
 
     def get(self, url):
-        """"""
+        """Issue a GET request to the given URL or API shorthand
+
+        """
         res = self.request(self._resolve_url(url), method='GET')
         return json.loads(res.read())
 
     def options(self, url):
-        """Send a request with HTTP method OPTIONS.
+        """Send a request with HTTP method OPTIONS to the given
+        URL or API shorthand.
         
         OX3 v2 uses this method for showing help information.
         
@@ -352,27 +365,36 @@ def options(self, url):
         return json.loads(res.read())
 
     def put(self, url, data=None):
-        """Issue a PUT request to url with the data."""
+        """Issue a PUT request to url (either a full URL or API
+        shorthand) with the data.
+
+        """
         res = self.request(self._resolve_url(url), method='PUT', data=data,
                            send_json=(self.api_path in JSON_PATHS))
         return json.loads(res.read())
 
     def post(self, url, data=None):
-        """"""
+        """Issue a POST request to url (either a full URL or API
+        shorthand) with the data.
+
+        """
         res = self.request(self._resolve_url(url), method='POST', data=data,
                            send_json=(self.api_path in JSON_PATHS))
         return json.loads(res.read())
 
     def delete(self, url):
-        """"""
+        """Issue a DELETE request to the URL or API shorthand."""
         res = self.request(self._resolve_url(url), method='DELETE')
         # Catch no content responses from some delete actions.
         if res.code == 204:
             return json.loads('[]')
         return json.loads(res.read())
 
     def upload_creative(self, account_id, file_path):
-        """"""
+        """Upload a media creative to the account with ID
+        account_id from the local file_path.
+
+        """
         # Thanks to nosklo for his answer on SO:
         # http://stackoverflow.com/a/681182
         boundary = '-----------------------------' + str(int(random.random()*1e10))