Merge pull request #653 from watson-developer-cloud/v3.0.0

Release v3.0.0

Author: ehdsouza

.bumpversion.cfg

@@ -2,7 +2,7 @@
 current_version = 2.10.0
 commit = True
 
-[bumpversion:file:watson_developer_cloud/version.py]
+[bumpversion:file:ibm_watson/version.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 

.travis.yml

@@ -1,9 +1,13 @@
 language: python
-python:
-- '2.7'
-- '3.4'
-- '3.5'
-- '3.6'
+matrix:
+  include:
+    - python: 2.7
+    - python: 3.4
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+      dist: xenial
+      sudo: true
 cache: pip
 before_install:
 - '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_cebf25e6c525_key
@@ -37,9 +41,8 @@ deploy:
     python: '3.5'
     branch: master
 - provider: pypi
-  user: ehdsouza
-  password:
-    secure: eMssjS1Airz5MrmcEDAnKYnTlMLuzinX8JFsh4TB0A4t7GCes2a/mlvcoazAv2QZMQUKQMC++bAXYGGgXtsSQsfOYnRtojW4pRphxOZrlXlWFgCLGz/eHioamNZVbH+/P/OYjbLy5ZKSzp3M3bZxYqHcmGTq0sBeo5A2Ilkzu5P+D865Jqtn52brwh/xYq4XWeJeQN/BSLwdtPEtZYQXhQupAteNDAo2ON0FVyt0amINrjA0Qw+0k35g36wti+CsKn5fhbaHf6jjN0oRj8J8wPZieXLAUMdxscfBjUXJ8AK8E4H/wPI30IsaMus+1r85ekiDKZC5iukO6uqMARFywjX/eTIDbWxwKImQUgvVa2+gncre7GvZrHIFxhIDDkssH1IfC1fcw3mNY4vCO9df/vHStp3Kvi27GvsYJnfsbXXj6fAhokHtsrnrbpXFET6LghGQx3HgOKrlCQ1EI0Fk92Qw7+g15jwMGlkwUE1qMS+PVOe7dQ4ikxJgw4CVrqU6/zaLFHV8LXFfjv166ZSWcOJHJXGgJ2TPuGiooL60+pWp/UYY00hZVlYX0Vlks6zN0h9zJd16kR3EwDrW0muqFnLC2xTuv5WsCjsOATtsTQzmBNEdCbGdOskgF4+0yPe7ps3kEs3UpAooKtYVh1OOJAUkl4vSMyu4Jg1ASyQWt00=
+  user: watson-devex
+  password: $PYPI_PASSWORD
   repository: https://upload.pypi.org/legacy
   skip_cleanup: true
   on:

MANIFEST.in

@@ -2,6 +2,6 @@ include README.md
 include LICENSE
 
 recursive-include examples *.py *.md
-recursive-include watson_developer_cloud *.py *.md
+recursive-include ibm_watson *.py *.md
 global-exclude .DS_Store
 global-exclude *.pyc

README.md

@@ -21,6 +21,7 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
   * [Python version](#python-version)
   * [Changes for v1.0](#changes-for-v10)
   * [Changes for v2.0](#changes-for-v20)
+  * [Changes for v3.0](#changes-for-v30)
   * [Migration](#migration)
   * [Configuring the http client](#configuring-the-http-client-supported-from-v110)
   * [Disable SSL certificate verification](#disable-ssl-certificate-verification)
@@ -36,31 +37,34 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
 
 ## Installation
-Note: We are moving to `ibm-watson`. All versions prior to v3.0.0 can still be found in `watson-developer-cloud`
-
 To install, use `pip` or `easy_install`:
 
 ```bash
-pip install --upgrade watson-developer-cloud
+pip install --upgrade ibm-watson
 ```
 
 or
 
 ```bash
-easy_install --upgrade watson-developer-cloud
+easy_install --upgrade ibm-watson
 ```
 
 Note the following:
+a) Versions prior to 3.0.0 can be installed using:
+
+```bash
+pip install --upgrade watson-developer-cloud
+```
 
-a) If you run into permission issues try:
+b) If you run into permission issues try:
 
 ```bash
-sudo -H pip install --ignore-installed six watson-developer-cloud
+sudo -H pip install --ignore-installed six ibm-watson
 ```
 
 For more details see [#225](https://github.com/watson-developer-cloud/python-sdk/issues/225)
 
-b) In case you run into problems installing the SDK in DSX, try
+c) In case you run into problems installing the SDK in DSX, try
 ```
 !pip install --upgrade pip
 ```
@@ -74,7 +78,7 @@ The [examples][examples] folder has basic and advanced examples. The examples wi
 
 ## Running in IBM Cloud
 
-If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable. 
+If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable.
 
 ## Authentication
 
@@ -94,6 +98,9 @@ To find out which authentication to use, view the service credentials. You find
 
 On this page, you should be able to see your credentials for accessing your service instance.
 
+![alt text](https://cdn-images-1.medium.com/max/1600/1*DaTt56z0RaKlbyWDUaRJgQ.png)
+
+
 ### Supplying credentials
 
 There are two ways to supply the credentials you found above to the SDK for authentication.
@@ -143,14 +150,14 @@ You supply either an IAM service **API key** or an **access token**:
 # In the constructor, letting the SDK manage the IAM token
 discovery = DiscoveryV1(version='2018-08-01',
                         url='<url_as_per_region>',
-                        iam_apikey='<iam_apikey>',
+                        apikey='<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='2018-08-01', url='<url_as_per_region>')
-discovery.set_iam_apikey('<iam_apikey>')
+discovery.set_apikey('<apikey>')
 ```
 
 #### Supplying the access token
@@ -169,7 +176,7 @@ discovery.set_iam_access_token('<access_token>')
 
 ### Username and password
 ```python
-from watson_developer_cloud import DiscoveryV1
+from ibm_watson import DiscoveryV1
 # In the constructor
 discovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>', username='<username>', password='<password>')
 ```
@@ -190,7 +197,7 @@ Version 1.0 focuses on the move to programmatically-generated code for many of t
 ## 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
+from ibm_watson import AssistantV1
 
 assistant = AssistantV1(
     username='xxx',
@@ -205,14 +212,19 @@ print(response.get_status_code())
 ```
 See the [changelog](https://github.com/watson-developer-cloud/python-sdk/wiki/Changelog) for the details.
 
+## Changes for v3.0
+The SDK is generated using OpenAPI Specification(OAS3). Changes are basic reordering of parameters in function calls.
+
+The package is renamed to ibm_watson. 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).
 
 ## Configuring the http client (Supported from v1.1.0)
 To set client configs like timeout use the `with_http_config()` function and pass it a dictionary of configs.
 
 ```python
-from watson_developer_cloud import AssistantV1
+from ibm_watson import AssistantV1
 
 assistant = AssistantV1(
     username='xxx',
@@ -243,7 +255,7 @@ headers = {
 For example, to send a header called `Custom-Header` to a call in Watson Assistant, pass
 the headers parameter as:
 ```python
-from watson_developer_cloud import AssistantV1
+from ibm_watson import AssistantV1
 
 assistant = AssistantV1(
     username='xxx',
@@ -257,7 +269,7 @@ response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).
 ## 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`. Since Python SDK `v2.0`, it is set to `True`
 ```python
-from watson_developer_cloud import AssistantV1
+from ibm_watson import AssistantV1
 
 assistant = AssistantV1(
     username='xxx',
@@ -284,7 +296,7 @@ You can use the `get_result()`, `get_headers()` and get_status_code() to return
 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`. Note: The service accepts one request per connection.
 
 ```py
-from watson_developer_cloud.websocket import SynthesizeCallback
+from ibm_watson.websocket import SynthesizeCallback
 
 class MySynthesizeCallback(SynthesizeCallback):
     def __init__(self):
@@ -311,6 +323,7 @@ service.synthesize_using_websocket('I like to pet dogs',
 * [responses] for testing
 * Following for web sockets support in speech to text
    * `websocket-client` 0.48.0
+* `ibm_cloud_sdk_core` >=0.2.0
 
 ## Contributing
 

appveyor.yml

@@ -25,7 +25,7 @@ build: off
 
 test_script:
 
-  - ps: py.test --reruns 3 --cov=watson_developer_cloud
+  - ps: py.test --reruns 3 --cov=ibm_watson
 
 deploy: off
 

docs/Makefile

@@ -55,7 +55,7 @@ clean:
 
 document:
 	rm -rf apis
-	$(SPHINXAPIDOC) -o apis ../watson_developer_cloud -f -e -T
+	$(SPHINXAPIDOC) -o apis ../ibm_watson -f -e -T
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/conf.py

@@ -2,9 +2,9 @@
 
 import sys
 import os
-import watson_developer_cloud
+import ibm_watson
 
-sys.path.insert(0, os.path.abspath('../watson_developer_cloud/'))
+sys.path.insert(0, os.path.abspath('../ibm_watson/'))
 
 from recommonmark.parser import CommonMarkParser
 source_parsers = {
@@ -45,8 +45,8 @@
 copyright = u'2015, IBM Corp'
 author = u'IBM Corp'
 
-version = watson_developer_cloud.__version__
-release = watson_developer_cloud.__version__
+version = ibm_watson.__version__
+release = ibm_watson.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -55,9 +55,9 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build', '_templates',
-    'apis/modules.rst','apis/watson_developer_cloud.rst',
-    'apis/watson_developer_cloud.version.rst',
-    'apis/watson_developer_cloud.watson_developer_cloud_service.rst']
+                    'apis/modules.rst', 'apis/ibm_watson.rst',
+                    'apis/ibm_watson.version.rst',
+                    'apis/ibm_watson.ibm_watson_service.rst']
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = False
@@ -74,7 +74,7 @@
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-modindex_common_prefix = ['watson_developer_cloud.']
+modindex_common_prefix = ['ibm_watson.']
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
@@ -139,7 +139,7 @@
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': ['localtoc.html','sidebarintro.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
+    '**': ['localtoc.html', 'sidebarintro.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
 }
 
 # Additional templates that should be rendered to pages, maps page names to
@@ -192,17 +192,17 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 
-# Latex figure (float) alignment
-#'figure_align': 'htbp',
+    # Latex figure (float) alignment
+    #'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples

docs/generate_index_html.sh

@@ -20,7 +20,7 @@ echo '<!DOCTYPE html>
     <p><a href="https://www.ibm.com/watson/developer/">Info</a>
         | <a href="https://console.bluemix.net/developer/watson/documentation">Documentation</a>
         | <a href="https://github.com/watson-developer-cloud/python-sdk">GitHub</a>
-        | <a href="https://pypi.python.org/pypi/watson-developer-cloud">pypi</a>
+        | <a href="https://pypi.python.org/pypi/ibm-watson">pypi</a>
     </p>
 
     <p>Documentation by branch/tag:</p>

docs/index.rst

@@ -12,13 +12,13 @@ To install, use ``pip`` or ``easy_install``:
 
 .. code:: bash
 
-    $ pip install --upgrade watson-developer-cloud
+    $ pip install --upgrade ibm-watson
 
 or
 
 .. code:: bash
 
-    $ easy_install --upgrade watson-developer-cloud
+    $ easy_install --upgrade ibm-watson
 
 Modules
 -------

examples/assistant_tone_analyzer_integration/.env.example

@@ -0,0 +1,6 @@
+# see README.md for details
+
+ASSISTANT_APIKEY=<Assistant Apikey>
+WORKSPACE_ID=<Workspace Id>
+
+TONE_ANALYZER_APIKEY=<Tone Analyzer Apikey>