Merge pull request #12 from draios/readme-log-api-requests

Record recipe for logging  REST requests made by library.  Several cu…

Author: philrz

README.md

@@ -54,3 +54,27 @@ Function List
 -------------
 
 Please Refer to the [Python Script Library documentation page](http://python-sdc-client.readthedocs.io/en/latest/) for the list of functions available.
+
+Transitioning from python to REST
+---------------------------------
+
+If your goal is to interact with the REST API directly, you can use this python client library to understand the REST interactions by logging the actions it takes.  This is useful because full documentation of the REST API has not yet been created; and also provides a complete example of known working operations.
+
+- Use or modify an example, or write a new script against the python sdcclient module.
+- Log the HTTP requests made by the script.
+
+To log all the requests made by your script in significant detail, add to your script:
+
+``` python
+import logging
+import httplib
+httplib.HTTPConnection.debuglevel = 1
+
+logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
+logging.getLogger().setLevel(logging.DEBUG)
+requests_log = logging.getLogger("requests.packages.urllib3")
+requests_log.setLevel(logging.DEBUG)
+requests_log.propagate = True
+```
+
+Then run as normal.