Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 3.32 KB

README.md

File metadata and controls

77 lines (55 loc) · 3.32 KB
Raw

Watson Developer Cloud Python SDK

Build Status codecov.io Latest Stable Version Download Times

Python client library to quickly get started with the various Watson Developer Cloud services.

Installation

To install, use pip or easy_install:

$ pip install --upgrade watson-developer-cloud

or

$ easy_install --upgrade watson-developer-cloud

Examples

The 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 Bluemix, 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 Bluemix you need the username and password credentials for each service. (Service credentials are different from your Bluemix account email and password.)

To create an instance of the service:

  1. Log in to Bluemix.
  2. Create an instance of the service:
    1. In the Bluemix Catalog, select the Watson service you want to use. For example, select the Conversation service.
    2. 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.
    3. 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 Bluemix dashboard and click the service name.

  1. On the Service Details page, click Service Credentials, and then View credentials.
  2. Copy username and password.

Python Version

Tested on: Python from 2.7 to 3.6. Python 2.6 is partially supported but generates InsecurePlatformWarnings (and other warnings), which can be ignored.

CHANGELOG

See CHANGELOG.

Known Issues

There is a known incompatibility with this module with Python versions 3.x with Korean systems.

Dependencies

Contributing

See CONTRIBUTING.md.

License

This library is licensed under the Apache 2.0 license.