chore(doc): Update readme and other chores

Author: ehdsouza

README.md

@@ -2,7 +2,6 @@
 
 [![Build Status](https://travis-ci.org/watson-developer-cloud/python-sdk.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/python-sdk)
 [![Slack](https://wdc-slack-inviter.mybluemix.net/badge.svg)](https://wdc-slack-inviter.mybluemix.net)
-[![codecov.io](https://codecov.io/github/watson-developer-cloud/python-sdk/coverage.svg?branch=master)](https://codecov.io/github/watson-developer-cloud/python-sdk?branch=master)
 [![Latest Stable Version](https://img.shields.io/pypi/v/watson-developer-cloud.svg)](https://pypi.python.org/pypi/watson-developer-cloud)
 [![CLA assistant](https://cla-assistant.io/readme/badge/watson-developer-cloud/python-sdk)](https://cla-assistant.io/watson-developer-cloud/python-sdk)
 
@@ -251,6 +250,30 @@ This would give an output of `DetailedResponse` having the structure:
 ```
 You can use the `get_result()`, `get_headers()` and get_status_code() to return the result, headers and status code respectively.
 
+## Using Websockets
+The Text to Speech service supports synthesizing text to spoken audio using web sockets with the `synthesize_using_websocket`. The Speech to Text service supports recognizing speech to text using web sockets with the `recognize_using_websocket`. These methods need a custom callback class to listen to events. Below is an example of `synthesize_using_websocket`.
+
+```py
+from watson_developer_cloud.websocket import SynthesizeCallback
+
+class MySynthesizeCallback(SynthesizeCallback):
+    def __init__(self):
+        SynthesizeCallback.__init__(self)
+
+    def on_audio_stream(self, audio_stream):
+        return audio_stream
+
+    def on_data(self, data):
+        return data
+
+my_callback = MySynthesizeCallback()
+service.synthesize_using_websocket("I like to pet dogs",
+                                   my_callback,
+                                   accept='audio/wav',
+                                   voice="en-US_AllisonVoice"
+                                  )
+```
+
 ## Dependencies
 
 * [requests]

examples/speaker_text_to_speech.py

@@ -1,7 +1,7 @@
 # You need to install pyaudio to run this example
 # pip install pyaudio
 
-# In this example, the a websocket connection is opened with a text
+# In this example, the websocket connection is opened with a text
 # passed in the request. When the service responds with the synthesized
 # audio, the pyaudio would play it in a blocking mode
 
@@ -82,7 +82,7 @@ def on_close(self):
         print 'Completed synthesizing'
         self.play.complete_playing()
 
-testCallback = MySynthesizeCallback()
+test_callback = MySynthesizeCallback()
 
 # An example SSML text
 SSML_sorry_text = """<speak version=\"1.0\">
@@ -108,7 +108,7 @@ def on_close(self):
    </speak>"""
 
 service.synthesize_using_websocket(SSML_text,
-                                   testCallback,
+                                   test_callback,
                                    accept='audio/wav',
                                    voice="en-US_AllisonVoice"
                                   )

examples/text_to_speech_v1.py

@@ -91,9 +91,9 @@ def on_close(self):
         self.fd.close()
         print("Done synthesizing. Closing the connection")
 
-myCallback = MySynthesizeCallback()
+my_callback = MySynthesizeCallback()
 service.synthesize_using_websocket("I like to pet dogs",
-                                   myCallback,
+                                   my_callback,
                                    accept='audio/wav',
                                    voice="en-US_AllisonVoice"
                                   )

test/integration/test_speech_to_text_v1.py

@@ -97,12 +97,12 @@ def on_error(self, error):
             def on_transcription(self, transcript):
                 self.transcript = transcript
 
-        testCallback = MyRecognizeCallback()
+        test_callback = MyRecognizeCallback()
         with open(os.path.join(os.path.dirname(__file__), '../../resources/speech.wav'), 'rb') as audio_file:
             audio_source = AudioSource(audio_file, False)
-            t = threading.Thread(target=self.speech_to_text.recognize_using_websocket, args=(audio_source, "audio/l16; rate=44100", testCallback))
+            t = threading.Thread(target=self.speech_to_text.recognize_using_websocket, args=(audio_source, "audio/l16; rate=44100", test_callback))
             t.start()
             t.join()
-        assert testCallback.error is None
-        assert testCallback.transcript is not None
-        assert testCallback.transcript[0]['transcript'] == 'thunderstorms could produce large hail isolated tornadoes and heavy rain '
+        assert test_callback.error is None
+        assert test_callback.transcript is not None
+        assert test_callback.transcript[0]['transcript'] == 'thunderstorms could produce large hail isolated tornadoes and heavy rain '

test/integration/test_text_to_speech_v1.py

@@ -89,13 +89,13 @@ def on_audio_stream(self, audio_stream):
             def on_close(self):
                 self.fd.close()
 
-        testCallback = MySynthesizeCallback()
+        test_callback = MySynthesizeCallback()
         self.text_to_speech.synthesize_using_websocket("She sells seashells by the seashore",
-                                                       testCallback,
+                                                       test_callback,
                                                        accept='audio/wav',
                                                        voice="en-GB_KateVoice"
                                                       )
-        assert testCallback.error is None
-        assert testCallback.fd is not None
+        assert test_callback.error is None
+        assert test_callback.fd is not None
         assert os.stat(file).st_size > 0
         os.remove(file)