Merge pull request #670 from watson-developer-cloud/icp4d

Release 3.1.0 with ICP4D support

Author: ehdsouza

.pylintrc

@@ -1,4 +1,4 @@
 # lint Python modules using external checkers.
 [MASTER]
 ignore=SVN
-disable=R0903,R0912,R0913,R0914,R0915,W0141,C0111,C0103,W0603,W0703,R0911,C0301,C0302,R0902,R0904,W0142,W0212,E1101,E1103,R0201,W0201,W0122,W0232,RP0001,RP0003,RP0101,RP0002,RP0401,RP0701,RP0801,F0401,E0611,R0801,I0011,F0401,E0611,E1004,C0111,I0011,I0012,W0704,W0142,W0212,W0232,W0613,W0702,R0201,W0614,R0914,R0912,R0915,R0913,R0904,R0801,C0301,C0411,R0204,W0622,E1121,inconsistent-return-statements
+disable=R0903,R0912,R0913,R0914,R0915,W0141,C0111,C0103,W0603,W0703,R0911,C0301,C0302,R0902,R0904,W0142,W0212,E1101,E1103,R0201,W0201,W0122,W0232,RP0001,RP0003,RP0101,RP0002,RP0401,RP0701,RP0801,F0401,E0611,R0801,I0011,F0401,E0611,E1004,C0111,I0011,I0012,W0704,W0142,W0212,W0232,W0613,W0702,R0201,W0614,R0914,R0912,R0915,R0913,R0904,R0801,C0301,C0411,R0204,W0622,E1121,inconsistent-return-statements,R0205,C0325

README.md

@@ -27,6 +27,8 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
   * [Disable SSL certificate verification](#disable-ssl-certificate-verification)
   * [Sending request headers](#sending-request-headers)
   * [Parsing HTTP response info](#parsing-http-response-info)
+  * [Using Websockets](#using-websockets)
+  * [IBM Cloud Pak for Data(ICP4D)](#ibm-cloud-pak-for-data(icp4d))
   * [Dependencies](#dependencies)
   * [License](#license)
   * [Contributing](#contributing)
@@ -322,14 +324,41 @@ service.synthesize_using_websocket('I like to pet dogs',
                                   )
 ```
 
+## IBM Cloud Pak for Data(ICP4D)
+If your service instance is of ICP4D, below are two ways of initializing the assistant service.
+
+#### 1) Supplying the `username`, `password`, `icp4d_url` and `authentication_type`
+The SDK will manage the token for the user
+```python
+assistant = AssistantV1(
+    version='<version',
+    username='<your username>',
+    password='<your password>',
+    url='<service url>', # should be of the form https://{icp_cluster_host}/{deployment}/assistant/{instance-id}/api
+    icp4d_url='<authentication url>', # should be of the form https://{icp_cluster_host}
+    authentication_type='icp4d')
+
+assistant.disable_SSL_verification() # MAKE SURE SSL VERIFICATION IS DISABLED
+```
+
+#### 2) Supplying the access token
+```python
+assistant = AssistantV1(
+    version='<version>',
+    url='service url', # should be of the form https://{icp_cluster_host}/{deployment}/assistant/{instance-id}/api
+    icp4d_access_token='<your managed access token>')
+
+assistant.disable_SSL_verification() # MAKE SURE SSL VERIFICATION IS DISABLED
+```
+
 ## Dependencies
 
 * [requests]
 * `python_dateutil` >= 2.5.3
 * [responses] for testing
 * Following for web sockets support in speech to text
    * `websocket-client` 0.48.0
-* `ibm_cloud_sdk_core` >=0.2.0
+* `ibm_cloud_sdk_core` >=0.5.0
 
 ## Contributing
 

examples/language_translator_v3.py

@@ -4,7 +4,7 @@
 from ibm_watson import LanguageTranslatorV3
 
 language_translator = LanguageTranslatorV3(
-    version='2018-05-01.',
+    version='2018-05-01',
     ### url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/language-translator/api',
     iam_apikey='YOUR APIKEY')

examples/microphone-speech-to-text.py

@@ -122,7 +122,7 @@ def pyaudio_callback(in_data, frame_count, time_info, status):
         pass
 except KeyboardInterrupt:
     # stop recording
-    audio_source.completed_recording()
     stream.stop_stream()
     stream.close()
     audio.terminate()
+    audio_source.completed_recording()