Merge pull request #554 from watson-developer-cloud/v2.0.0

Release V2.0.0

Author: ehdsouza

.bumpversion.cfg

@@ -1,6 +1,7 @@
 [bumpversion]
 current_version = 1.7.1
 commit = True
+message = [skip ci] Bump version: {current_version} -> {new_version}
 
 [bumpversion:file:watson_developer_cloud/version.py]
 search = __version__ = '{current_version}'

README.md

@@ -19,9 +19,9 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
     * [IAM](#iam)
     * [Username and password](#username-and-password)
     * [API key](#api-key)
-  * [Deprecation notice](#deprecation-notice)
   * [Python version](#python-version)
   * [Changes for v1.0](#changes-for-v10)
+  * [Changes for v2.0](#changes-for-v20)
   * [Migration](#migration)
   * [Configuring the http client](#configuring-the-http-client-supported-from-v110)
   * [Sending request headers](#sending-request-headers)
@@ -106,14 +106,14 @@ You supply either an IAM service **API key** or an **access token**:
 ```python
 # In the constructor, letting the SDK manage the IAM token
 discovery = DiscoveryV1(version='2017-10-16',
-                        iam_api_key='<iam_api_key>',
+                        iam_apikey='<iam_apikey>',
                         iam_url='<iam_url>') # optional - the default value is https://iam.bluemix.net/identity/token
 ```
 
 ```python
 # after instantiation, letting the SDK manage the IAM token
 discovery = DiscoveryV1(version='2017-10-16')
-discovery.set_iam_api_key('<iam_api_key>')
+discovery.set_iam_apikey('<iam_apikey>')
 ```
 
 #### Supplying the access token
@@ -158,16 +158,30 @@ visual_recognition = VisualRecognitionV3(version='2018-05-22')
 visual_recognition.set_api_key('<api_key>')
 ```
 
-## Deprecation notice
-Language Translator v3 is now available. The v2 Language Translator API will no longer be available after July 31, 2018. To take advantage of the latest service enhancements, migrate to the v3 API. View the [Migrating to Language Translator v3](https://console.bluemix.net/docs/services/language-translator/migrating.html) page for more information.
-
 ## Python version
 
 Tested on Python 2.7, 3.4, 3.5, and 3.6.
 
 ## Changes for v1.0
 Version 1.0 focuses on the move to programmatically-generated code for many of the services. See the [changelog](https://github.com/watson-developer-cloud/python-sdk/wiki/Changelog) for the details.
 
+## Changes for v2.0
+`DetailedResponse` which contains the result, headers and HTTP status code is now the default response for all methods.
+```python
+from watson_developer_cloud import AssistantV1
+
+assistant = AssistantV1(
+    username='xxx',
+    password='yyy',
+    version='2017-04-21')
+
+response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
+print(response.get_result())
+print(response.get_headers())
+print(response.get_status_code())
+```
+See the [changelog](https://github.com/watson-developer-cloud/python-sdk/wiki/Changelog) for the details.
+
 ## Migration
 This version includes many breaking changes as a result of standardizing behavior across the new generated services. Full details on migration from previous versions can be found [here](https://github.com/watson-developer-cloud/python-sdk/wiki/Migration).
 
@@ -184,7 +198,7 @@ assistant = AssistantV1(
 
 assistant.set_http_config({'timeout': 100})
 response = assistant.message(workspace_id=workspace_id, input={
-    'text': 'What\'s the weather like?'})
+    'text': 'What\'s the weather like?'}).get_result()
 print(json.dumps(response, indent=2))
 ```
 
@@ -205,11 +219,11 @@ assistant = AssistantV1(
     password='yyy',
     version='2017-04-21')
 
-response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
+response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()
 ```
 
 ## Parsing HTTP response info
-If you would like access to some HTTP response information along with the response model, you can set the `set_detailed_response()` to `True`
+If you would like access to some HTTP response information along with the response model, you can set the `set_detailed_response()` to `True`. Since Python SDK `v2.0`, it is set to `True`
 ```python
 from watson_developer_cloud import AssistantV1
 
@@ -219,29 +233,27 @@ assistant = AssistantV1(
     version='2017-04-21')
 
 assistant.set_detailed_response(True)
-response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
+response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()
 print(response)
 ```
 
 This would give an output of `DetailedResponse` having the structure:
 ```python
 {
     'result': <response returned by service>,
-    'headers': { <http response headers> }
+    'headers': { <http response headers> },
+    'status_code': <http status code>
 }
 ```
-You can use the `get_result()` and `get_headers()` to return the result and headers respectively.
+You can use the `get_result()`, `get_headers()` and get_status_code() to return the result, headers and status code respectively.
 
 ## Dependencies
 
 * [requests]
 * `python_dateutil` >= 2.5.3
 * [responses] for testing
 * Following for web sockets support in speech to text
-   * `autobahn` >= 0.10.9
-   * `Twisted` >= 13.2.0
-   * `pyOpenSSL` >= 16.2.0
-   * `service-identity` >= 17.0.0
+   * `websocket-client` 0.47.0
 
 ## Contributing
 

appveyor.yml

@@ -0,0 +1,34 @@
+environment:
+
+  matrix:
+
+    - PYTHON: "C:\\Python35"
+    - PYTHON: "C:\\Python27-x64"
+    - PYTHON: "C:\\Python36-x64"
+
+install:
+
+  # Install Python (from the official .msi of https://python.org) and pip when
+  # not already installed.
+  - ps: if (-not(Test-Path($env:PYTHON))) { & appveyor\install.ps1 }
+
+  # Prepend newly installed Python to the PATH of this build
+  - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
+
+  - "python -m pip install --upgrade pip"
+
+  - "pip install --editable ."
+
+  - "pip install -r requirements-dev.txt"
+
+build: off
+
+test_script:
+
+  - ps: py.test --reruns 3 --cov=watson_developer_cloud
+
+deploy: off
+
+matrix:
+  fast_finish: true
+

examples/README.md

@@ -1,14 +1,6 @@
 ## Examples
-To run the examples, you will need a `username`, `password`, and `url`. To get your service credentials, follow these steps:
- 1. Log in to IBM Cloud at https://console.bluemix.net.
+To run the examples, you will need the appropriate service instance
 
- 1. Create an instance of the service:
-     1. In the IBM Cloud **Catalog**, select the Natural Language Classifier service.
-     1. Click **Create**.
-
- 1. Copy your credentials:
-     1. On the left side of the page, click **Service Credentials** to view your service credentials.
-     1. Copy `username`, `password`, and `url` from these service credentials.
-
-## Deprecation notice
-Language Translator v3 is now available. The v2 Language Translator API will no longer be available after July 31, 2018. To take advantage of the latest service enhancements, migrate to the v3 API. View the [Migrating to Language Translator v3](https://console.bluemix.net/docs/services/language-translator/migrating.html) page for more information.
+1. Go to the IBM Cloud [Dashboard](https://console.bluemix.net/dashboard/apps?category=ai) page.
+1. Either click an existing Watson service instance or click [**Create resource > AI**](https://console.bluemix.net/catalog/?category=ai) and create a service instance.
+1. Copy the `url` and either `apikey` or `username` and `password`. Click **Show** if the credentials are masked.