|
| 1 | +## Watson Developer Cloud Python SDK |
| 2 | +[](https://travis-ci.org/watson-developer-cloud/python-sdk) |
| 3 | +[](https://coveralls.io/github/watson-developer-cloud/python-sdk?branch=master) |
| 4 | +[](https://pypi.python.org/pypi/watson-developer-cloud) |
| 5 | +[](https://pypi.python.org/pypi/watson-developer-cloud) |
| 6 | + |
| 7 | +Python client library to quickly get started with the various [Watson Developer Cloud][wdc] services. |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +To install, use `pip` or `easy_install`: |
| 12 | + |
| 13 | +```bash |
| 14 | +$ pip install --upgrade watson-developer-cloud |
| 15 | +``` |
| 16 | +or |
| 17 | +```bash |
| 18 | +$ easy_install --upgrade watson-developer-cloud |
| 19 | +``` |
| 20 | + |
| 21 | +## Examples |
| 22 | +The [examples][examples] folder has basic and advanced examples. |
| 23 | + |
| 24 | +## Getting the Service Credentials |
| 25 | +You will need the `username` and `password` credentials for each service. Service credentials are different from your Bluemix account username and password. |
| 26 | + |
| 27 | +To get your service credentials, follow these steps: |
| 28 | + 1. Log in to Bluemix at https://bluemix.net. |
| 29 | + |
| 30 | + 1. Create an instance of the service: |
| 31 | + 1. In the Bluemix **Catalog**, select the Natural Language Classifier service. |
| 32 | + 1. Under **Add Service**, 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. |
| 33 | + 1. Click **Use**. |
| 34 | + |
| 35 | + 1. Copy your credentials: |
| 36 | + 1. On the left side of the page, click **Service Credentials** to view your service credentials. |
| 37 | + 1. Copy `username` and `password` from these service credentials. |
| 38 | + |
| 39 | +## Python Version |
| 40 | +Tested 👌 (lightly) on: Python from 2.6 to 3.5-dev (development branch) |
| 41 | + |
| 42 | +## Dependencies |
| 43 | +* [requests] |
| 44 | +* [responses] (for testing) |
| 45 | + |
| 46 | +## Contributing |
| 47 | +See [CONTRIBUTING.md][CONTRIBUTING]. |
| 48 | + |
| 49 | +## License |
| 50 | + |
| 51 | +This library is licensed under the [Apache 2.0 license][license]. |
| 52 | + |
| 53 | +[wdc]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/ |
| 54 | +[vcap_environment]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/index.html#EnvVars |
| 55 | +[bluemix]: https://console.ng.bluemix.net |
| 56 | +[pytest]: http://pytest.org/latest/ |
| 57 | +[responses]: https://github.com/getsentry/responses |
| 58 | +[requests]: http://docs.python-requests.org/en/latest/ |
| 59 | +[examples]: https://github.com/watson-developer-cloud/python-sdk/tree/master/examples |
| 60 | +[CONTRIBUTING]: https://github.com/watson-developer-cloud/python-sdk/blob/master/CONTRIBUTING.md |
| 61 | +[license]: http://www.apache.org/licenses/LICENSE-2.0 |
0 commit comments