Update docs and changelog

skimbrel · skimbrel · commit 3f6b1b4ed88d · 2013-09-24T15:30:30.000-07:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -3,6 +3,24 @@ twilio-python Changelog
 
 Here you can see the full list of changes between each twilio-python release.
 
+Version 3.6.2
+------------
+
+Released on September 24, 2013
+
+- Adds support for HTTP and SOCKS4/5 proxies to the REST client.
+
+
+Version 3.6.0, 3.6.1
+--------------------
+
+Released on September 18, 2013
+
+- Adds support for the new Message and SIP resources to the REST
+API client.
+- Adds support for the new Message verb to the TwiML generator.
+
+
 Version 3.5.3, 3.5.4
 --------------------
 
diff --git a/docs/usage/basics.rst b/docs/usage/basics.rst
@@ -38,6 +38,29 @@ directly to the the constructor.
     client = TwilioRestClient(ACCOUNT_SID, AUTH_TOKEN)
 
 
+Proxies
+-------
+
+:class:`TwilioRestClient` supports HTTP and SOCKS4/5 proxies. You can change
+the proxy configuration at any time with the :class:`Connection` class:
+
+.. code-block:: python
+
+    from twilio.rest.resources import Connection
+    from twilio.rest.resources.connection import PROXY_TYPE_SOCKS5
+
+    Connection.set_proxy_info(
+        'example.com',
+        5000,
+        proxy_type=PROXY_TYPE_SOCKS5,
+        proxy_user='username',
+        proxy_pass='password',
+    )
+
+The :class:`TwilioRestClient` will retrieve and use the current proxy
+information for each request.
+
+
 Listing Resources
 -------------------
 
diff --git a/twilio/rest/resources/connection.py b/twilio/rest/resources/connection.py
@@ -6,16 +6,32 @@
 
 
 class Connection(object):
+    '''Class for setting proxy configuration to be used for REST calls.'''
     _proxy_info = None
 
     @classmethod
     def proxy_info(cls):
+        '''Returns the currently-set proxy information
+        as an httplib2.ProxyInfo object.
+        '''
         return cls._proxy_info
 
     @classmethod
     def set_proxy_info(cls, proxy_host, proxy_port,
                        proxy_type=PROXY_TYPE_HTTP, proxy_rdns=None,
                        proxy_user=None, proxy_pass=None):
+        '''Set proxy configuration for future REST API calls.
+
+        :param str proxy_host: Hostname of the proxy to use.
+        :param int proxy_port: Port to connect to.
+        :param proxy_type: The proxy protocol to use. One of
+        PROXY_TYPE_HTTP, PROXY_TYPE_SOCKS4, PROXY_TYPE_SOCKS5.
+        Defaults to connection.PROXY_TYPE_HTTP.
+        :param bool proxy_rdns: Use the proxy host's DNS resolver.
+        :param str proxy_user: Username for the proxy.
+        :param str proxy_pass: Password for the proxy.
+        '''
+
         cls._proxy_info = httplib2.ProxyInfo(
             proxy_type,
             proxy_host,
