Metadata-Version: 1.1
Name: watson-developer-cloud
Version: 1.3.2
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-Content-Type: UNKNOWN
Description: Watson Developer Cloud Python SDK
        =================================
        
        |Build Status| |Slack| |codecov.io| |Latest Stable Version|
        
        Python client library to quickly get started with the various `Watson
        APIs <http://www.ibm.com/watson/developercloud/>`__ services.
        
        Installation
        ------------
        
        To install, use ``pip`` or ``easy_install``:
        
        .. code:: bash
        
            pip install --upgrade watson-developer-cloud
        
        or
        
        .. code:: bash
        
            easy_install --upgrade watson-developer-cloud
        
        Note the following:
        
        a) If you run into permission issues try:
        
        .. code:: 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 <https://github.com/watson-developer-cloud/python-sdk/tree/master/examples>`__
        folder has basic and advanced examples.
        
        Getting the Service Credentials
        -------------------------------
        
        Service credentials are required to access the APIs.
        
        If you run your app in IBM Cloud, you don't need to specify the username
        and password. In that case, the SDK uses the ``VCAP_SERVICES``
        environment variable to load the credentials.
        
        To run locally or outside of IBM Cloud you need the ``username`` and
        ``password`` credentials for each service. (Service credentials are
        different from your IBM Cloud account email and password.)
        
        To create an instance of the service:
        
        1. Log in to `IBM Cloud <https://console.bluemix.net>`__.
        2. Create an instance of the service:
        3. In the IBM Cloud **Catalog**, select the Watson service you want to
           use. For example, select the Conversation service.
        4. Type a unique name for the service instance in the **Service name**
           field. For example, type ``my-service-name``. Leave the default
           values for the other options.
        5. Click **Create**.
        
        To get your service credentials:
        
        Copy your credentials from the **Service details** page. To find the the
        Service details page for an existing service, navigate to your IBM Cloud
        dashboard and click the service name.
        
        1. On the **Service Details** page, click **Service Credentials**, and
           then **View credentials**.
        2. Copy ``username``, ``password``, and ``url``.
        
        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.
        
        .. code:: 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:
        
        .. code:: 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:
        
        .. code:: 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``
        
        .. code:: 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:
        
        .. code:: 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 <http://docs.python-requests.org/en/latest/>`__
        -  ``python_dateutil`` >= 2.5.3
        -  `responses <https://github.com/getsentry/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 <https://github.com/watson-developer-cloud/python-sdk/blob/master/CONTRIBUTING.md>`__.
        
        License
        -------
        
        This library is licensed under the `Apache 2.0
        license <http://www.apache.org/licenses/LICENSE-2.0>`__.
        
        .. |Build Status| image:: https://travis-ci.org/watson-developer-cloud/python-sdk.svg?branch=master
           :target: https://travis-ci.org/watson-developer-cloud/python-sdk
        .. |Slack| image:: https://wdc-slack-inviter.mybluemix.net/badge.svg
           :target: https://wdc-slack-inviter.mybluemix.net
        .. |codecov.io| image:: https://codecov.io/github/watson-developer-cloud/python-sdk/coverage.svg?branch=master
           :target: https://codecov.io/github/watson-developer-cloud/python-sdk?branch=master
        .. |Latest Stable Version| image:: https://img.shields.io/pypi/v/watson-developer-cloud.svg
           :target: https://pypi.python.org/pypi/watson-developer-cloud
        
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
