Metadata-Version: 1.1
Name: watson-developer-cloud
Version: 1.6.0
Summary: Client library to use the IBM Watson Services
Home-page: https://github.com/watson-developer-cloud/python-sdk
Author: Jeffrey Stylos
Author-email: jsstylos@us.ibm.com
License: Apache 2.0
Description: # Watson Developer Cloud Python SDK
        
        [![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)
        
        Python client library to quickly get started with the various [Watson APIs][wdc] services.
        
        <details>
          <summary>Table of Contents</summary>
        
          * [Before you begin](#before-you-begin)
          * [Installation](#installation)
          * [Examples](#examples)
          * [Running in IBM Cloud](#running-in-ibm-cloud)
          * [Authentication](#authentication)
            * [Getting credentials](#getting-credentials)
            * [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)
          * [Migration](#migration)
          * [Configuring the http client](#configuring-the-http-client-supported-from-v110)
          * [Sending request headers](#sending-request-headers)
          * [Parsing HTTP response info](#parsing-http-response-info)
          * [Dependencies](#dependencies)
          * [License](#license)
          * [Contributing](#contributing)
        
        </details>
        
        ## Before you begin
        * You need an [IBM Cloud][ibm-cloud-onboarding] account.
        
        ## Installation
        
        To install, use `pip` or `easy_install`:
        
        ```bash
        pip install --upgrade watson-developer-cloud
        ```
        
        or
        
        ```bash
        easy_install --upgrade watson-developer-cloud
        ```
        
        Note the following:
        
        a) If you run into permission issues try:
        
        ```bash
        sudo -H pip install --ignore-installed six watson-developer-cloud
        ```
        
        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
        ```
        !pip install --upgrade pip
        ```
        Restarting the kernel
        
        For more details see [#405](https://github.com/watson-developer-cloud/python-sdk/issues/405)
        
        ## Examples
        
        The [examples][examples] folder has basic and advanced examples. The examples within each service assume that you already have [service credentials](#getting-credentials). 
        
        ## Running in IBM Cloud
        
        If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable. 
        
        ## Authentication
        
        Watson services are migrating to token-based Identity and Access Management (IAM) authentication.
        
        - With some service instances, you authenticate to the API by using **[IAM](#iam)**.
        - In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.
        - Visual Recognition uses a form of [API key](#api-key) only with instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.
        
        **Note:** Authenticating with the X-Watson-Authorization-Token header is deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. See [here](#iam) for details.
        
        ### 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][watson-dashboard]** page.
        1.  Either click an existing Watson service instance or click **Create**.
        1.  Click **Show** to view your service credentials.
        1.  Copy the `url` and either `apikey` or `username` and `password`.
        
        ### IAM
        
        IBM Cloud is migrating to token-based Identity and Access Management (IAM) authentication. IAM authentication uses a service API key to get an access token that is passed with the call. Access tokens are valid for approximately one hour and must be regenerated.
        
        You supply either an IAM service **API key** or an **access token**:
        
        - Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
        - Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://console.bluemix.net/docs/services/watson/getting-started-iam.html).
        
        #### Supplying the IAM API key
        
        ```python
        # In the constructor, letting the SDK manage the IAM token
        discovery = DiscoveryV1(version='2017-10-16',
                                iam_api_key='<iam_api_key>',
                                iam_url='<iam_url>') # optional - the default value is https://iam.ng.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>')
        ```
        
        #### Supplying the access token
        ```python
        # in the constructor, assuming control of managing IAM token
        discovery = DiscoveryV1(version='2017-10-16',
                                iam_access_token='<iam_access_token>')
        ```
        
        ```python
        # after instantiation, assuming control of managing IAM token
        discovery = DiscoveryV1(version='2017-10-16')
        discovery.set_iam_access_token('<access_token>')
        ```
        
        ### Username and password
        ```python
        from watson_developer_cloud import DiscoveryV1
        # In the constructor
        discovery = DiscoveryV1(version='2017-10-16', username='<username>', password='<password>')
        ```
        
        ```python
        # After instantiation
        discovery = DiscoveryV1(version='2017-10-16')
        discovery.set_username_and_password('<username>', '<password>')
        ```
        
        ### API key
        
        **Important**: This type of authentication works only with Visual Recognition instances created before May 23, 2018. Newer instances of Visual Recognition use [IAM](#iam).
        
        ```python
        from watson_developer_cloud import VisualRecognitionV3
        # In the constructor
        visual_recognition = VisualRecognitionV3(version='2018-05-22', api_key='<api_key>')
        ```
        
        ```python
        # After instantiation
        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.
        
        ## 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
        
        assistant = AssistantV1(
            username='xxx',
            password='yyy',
            version='2017-04-21')
        
        assistant.set_http_config({'timeout': 100})
        response = assistant.message(workspace_id=workspace_id, input={
            'text': 'What\'s the weather like?'})
        print(json.dumps(response, indent=2))
        ```
        
        ## Sending request headers
        Custom headers can be passed in any request in the form of a `dict` as:
        ```python
        headers = {
            'Custom-Header': 'custom_value'
        }
        ```
        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
        
        assistant = AssistantV1(
            username='xxx',
            password='yyy',
            version='2017-04-21')
        
        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`
        ```python
        from watson_developer_cloud import AssistantV1
        
        assistant = AssistantV1(
            username='xxx',
            password='yyy',
            version='2017-04-21')
        
        assistant.set_detailed_response(True)
        response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
        print(response)
        ```
        
        This would give an output of `DetailedResponse` having the structure:
        ```python
        {
            'result': <response returned by service>,
            'headers': { <http response headers> }
        }
        ```
        You can use the `get_result()` and `get_headers()` to return the result and headers 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
        
        ## Contributing
        
        See [CONTRIBUTING.md][CONTRIBUTING].
        
        ## License
        
        This library is licensed under the [Apache 2.0 license][license].
        
        [wdc]: http://www.ibm.com/watson/developercloud/
        [ibm_cloud]: https://console.bluemix.net
        [watson-dashboard]: https://console.bluemix.net/dashboard/apps?category=watson
        [responses]: https://github.com/getsentry/responses
        [requests]: http://docs.python-requests.org/en/latest/
        [examples]: https://github.com/watson-developer-cloud/python-sdk/tree/master/examples
        [CONTRIBUTING]: https://github.com/watson-developer-cloud/python-sdk/blob/master/CONTRIBUTING.md
        [license]: http://www.apache.org/licenses/LICENSE-2.0
        [vcap_services]: https://console.bluemix.net/docs/services/watson/getting-started-variables.html
        [ibm-cloud-onboarding]: http://console.bluemix.net/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Python
        
Keywords: language,vision,question and answer tone_analyzer,natural language classifier,text to speech,language translation,language identification,concept expansion,machine translation,personality insights,message resonance,watson developer cloud,wdc,watson,ibm,dialog,user modeling,tone analyzer,speech to text,visual recognition
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
