Merge pull request #635 from watson-developer-cloud/load-credentials

Instantiate credentials using `ibm-credentials.env`

Author: ehdsouza

README.md

@@ -90,9 +90,45 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 ### Getting credentials
 To find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:
 
-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.
+1. Go to the IBM Cloud [Dashboard](https://cloud.ibm.com/) page.
+1. Either click an existing Watson service instance in your [resource list](https://cloud.ibm.com/resources) or click [**Create resource > AI**](https://cloud.ibm.com/catalog?category=ai) and create a service instance.
+1. Click on the **Manage** item in the left nav bar of your service instance.
+
+On this page, you should be able to see your credentials for accessing your service instance.
+
+### Supplying credentials
+
+There are two ways to supply the credentials you found above to the SDK for authentication.
+
+#### Credential file (easier!)
+
+With a credential file, you just need to put the file in the right place and the SDK will do the work of parsing and authenticating. You can get this file by clicking the **Download** button for the credentials in the **Manage** tab of your service instance.
+
+The file downloaded will be called `ibm-credentials.env`. This is the name the SDK will search for and **must** be preserved unless you want to configure the file path (more on that later). The SDK will look for your `ibm-credentials.env` file in the following places (in order):
+
+- Your system's home directory
+- The top-level directory of the project you're using the SDK in
+
+As long as you set that up correctly, you don't have to worry about setting any authentication options in your code. So, for example, if you created and downloaded the credential file for your Discovery instance, you just need to do the following:
+
+```python
+discovery = DiscoveryV1(version='2018-08-01')
+```
+
+And that's it!
+
+If you're using more than one service at a time in your code and get two different `ibm-credentials.env` files, just put the contents together in one `ibm-credentials.env` file and the SDK will handle assigning credentials to their appropriate services.
+
+If you would like to configure the location/name of your credential file, you can set an environment variable called `IBM_CREDENTIALS_FILE`. **This will take precedence over the locations specified above.** Here's how you can do that:
+
+```bash
+export IBM_CREDENTIALS_FILE="<path>"
+```
+
+where `<path>` is something like `/home/user/Downloads/<file_name>.env`.
+
+#### Manually
+If you'd prefer to set authentication values manually in your code, the SDK supports that as well. The way you'll do this depends on what type of credentials your service instance gives you.
 
 ### IAM
 

resources/ibm-credentials.env

@@ -0,0 +1,4 @@
+VISUAL_RECOGNITION_APIKEY=1234abcd
+VISUAL_RECOGNITION_URL=https://stgwat-us-south-mzr-cruiser6.us-south.containers.mybluemix.net/visual-recognition/api
+WATSON_APIKEY=5678efgh
+WATSON_URL=https://gateway-s.watsonplatform.net/watson/api

test/unit/test_watson_service.py

@@ -3,6 +3,7 @@
 import pytest
 from watson_developer_cloud import WatsonService
 import time
+import os
 
 import responses
 
@@ -28,7 +29,8 @@ def __init__(self, version, url=default_url, username=None, password=None,
             use_vcap_services=True,
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
-            iam_url=iam_url)
+            iam_url=iam_url,
+            display_name='Watson')
         self.version = version
 
     def op_with_path_params(self, path0, path1):
@@ -217,3 +219,14 @@ def test_has_bad_first_or_last_char():
     with pytest.raises(ValueError) as err:
         AnyServiceV1('2018-11-20', iam_apikey='apikey', url='"url"')
     assert str(err.value) == 'The URL shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your URL'
+
+@responses.activate
+def test__set_credential_based_on_type():
+    file_path = os.path.join(os.path.dirname(__file__), '../../resources/ibm-credentials.env')
+    os.environ['IBM_CREDENTIALS_FILE'] = file_path
+    service = AnyServiceV1('2018-11-20')
+    assert service.iam_apikey == '5678efgh'
+    del os.environ['IBM_CREDENTIALS_FILE']
+
+    service = AnyServiceV1('2018-11-20', username='test', password='test')
+    assert service.username == 'test'

watson_developer_cloud/assistant_v1.py

@@ -97,7 +97,8 @@ def __init__(
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
             iam_url=iam_url,
-            use_vcap_services=True)
+            use_vcap_services=True,
+            display_name='Assistant')
         self.version = version
 
     #########################

watson_developer_cloud/assistant_v2.py

@@ -96,7 +96,8 @@ def __init__(
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
             iam_url=iam_url,
-            use_vcap_services=True)
+            use_vcap_services=True,
+            display_name='Assistant')
         self.version = version
 
     #########################

watson_developer_cloud/authorization_v1.py

@@ -38,7 +38,7 @@ class AuthorizationV1(WatsonService):
     def __init__(self, url=default_url,
                  username=None, password=None, use_vcap_services=True):
         WatsonService.__init__(
-            self, 'authorization', url, username, password, use_vcap_services)
+            self, 'authorization', url, username, password, use_vcap_services, display_name='authorization')
 
     def get_token(self, url):
         """

watson_developer_cloud/compare_comply_v1.py

@@ -81,7 +81,8 @@ def __init__(
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
             iam_url=iam_url,
-            use_vcap_services=True)
+            use_vcap_services=True,
+            display_name='Compare Comply')
         self.version = version
 
     #########################

watson_developer_cloud/discovery_v1.py

@@ -100,7 +100,8 @@ def __init__(
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
             iam_url=iam_url,
-            use_vcap_services=True)
+            use_vcap_services=True,
+            display_name='Discovery')
         self.version = version
 
     #########################

watson_developer_cloud/iam_token_manager.py

@@ -111,6 +111,12 @@ def set_iam_apikey(self, iam_apikey):
         """
         self.iam_apikey = iam_apikey
 
+    def set_iam_url(self, iam_url):
+        """
+        Set the IAM url
+        """
+        self.iam_url = iam_url
+
     def _is_token_expired(self):
         """
         Check if currently stored token is expired.

watson_developer_cloud/language_translator_v3.py

@@ -99,7 +99,8 @@ def __init__(
             iam_apikey=iam_apikey,
             iam_access_token=iam_access_token,
             iam_url=iam_url,
-            use_vcap_services=True)
+            use_vcap_services=True,
+            display_name='Language Translator')
         self.version = version
 
     #########################