Skip to content

Commit dd47f5c

Browse files
fix documentation issues
1 parent 3baa667 commit dd47f5c

File tree

4 files changed

+64
-6
lines changed

4 files changed

+64
-6
lines changed

.bumpversion.cfg

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,3 @@ tag = True
66
[bumpversion:file:watson_developer_cloud/__init__.py]
77
search = __version__ = '{current_version}'
88
replace = __version__ = '{new_version}'
9-
10-
[bumpversion:file:docs/conf.py]
11-
search = __version__ = '{current_version}'
12-
replace = __version__ = '{new_version}'

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,4 @@ python3/
5555
resources/output.wav
5656

5757
docs/_build/
58+
deploy.sh

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
## Watson Developer Cloud Python SDK
2-
[![Software License](https://img.shields.io/badge/license-Apache 2.0-brightgreen.svg)](LICENSE)
32
[![Build Status](https://travis-ci.org/watson-developer-cloud/python-sdk.svg)](https://travis-ci.org/watson-developer-cloud/python-sdk)
43
[![Coverage Status](https://coveralls.io/repos/watson-developer-cloud/python-sdk/badge.svg?branch=master&service=github)](https://coveralls.io/github/watson-developer-cloud/python-sdk?branch=master)
54
[![Latest Stable Version](https://img.shields.io/pypi/v/watson-developer-cloud.svg)](https://pypi.python.org/pypi/watson-developer-cloud)
@@ -49,7 +48,7 @@ See [CONTRIBUTING.md][CONTRIBUTING].
4948

5049
## License
5150

52-
This library is licensed under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0).
51+
This library is licensed under the [Apache 2.0 license][license].
5352

5453
[wdc]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/
5554
[vcap_environment]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/index.html#EnvVars
@@ -59,3 +58,4 @@ This library is licensed under the [Apache 2.0 license](http://www.apache.org/li
5958
[requests]: http://docs.python-requests.org/en/latest/
6059
[examples]: https://github.com/watson-developer-cloud/python-sdk/tree/master/examples
6160
[CONTRIBUTING]: https://github.com/watson-developer-cloud/python-sdk/blob/master/CONTRIBUTING.md
61+
[license]: http://www.apache.org/licenses/LICENSE-2.0

docs/index.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Watson Developer Cloud Python SDK
2+
[![Build Status](https://travis-ci.org/watson-developer-cloud/python-sdk.svg)](https://travis-ci.org/watson-developer-cloud/python-sdk)
3+
[![Coverage Status](https://coveralls.io/repos/watson-developer-cloud/python-sdk/badge.svg?branch=master&service=github)](https://coveralls.io/github/watson-developer-cloud/python-sdk?branch=master)
4+
[![Latest Stable Version](https://img.shields.io/pypi/v/watson-developer-cloud.svg)](https://pypi.python.org/pypi/watson-developer-cloud)
5+
[![Download Times](https://img.shields.io/pypi/dm/watson-developer-cloud.svg)](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

Comments
 (0)