Skip to content

Commit a61d76c

Browse files
authored
Python SDK copy edit (#26)
* Python SDK copy edit * Update authentication
1 parent 04761ce commit a61d76c

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ Service Name | Imported Class Name
5050
[ibm-cloud-onboarding]: https://cloud.ibm.com/registration
5151

5252
* An [IBM Cloud][ibm-cloud-onboarding] account.
53-
* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
54-
* Python 3.5.3 or above.
53+
* An IAM API key to allow the SDK to access your account. Create an apikey [here](https://cloud.ibm.com/iam/apikeys).
54+
* Python version 3.5.3 or above.
5555

5656
## Installation
5757

@@ -68,16 +68,16 @@ easy_install --upgrade "ibm-vpc>=0.7.0"
6868
```
6969

7070
## Using the SDK
71-
For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)
71+
For general SDK usage information, see the [IBM Cloud SDK Common README](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
7272

7373
## Setting up VPC service
7474
```python
7575
from ibm_vpc import VpcV1
7676
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
7777
from ibm_cloud_sdk_core import ApiException
7878

79-
authenticator = IAMAuthenticator("YOUR_IBMCLOUD_API_KEY")
80-
service = VpcV1('2020-06-02', authenticator=authenticator)
79+
authenticator = IAMAuthenticator('apikey')
80+
service = VpcV1(authenticator=authenticator)
8181

8282
# Listing VPCs
8383
print("List VPCs")
@@ -125,18 +125,16 @@ print(instance['id'], "\t", instance['name'])
125125

126126

127127
## Questions
128-
129-
If you are having difficulties using this SDK or have a question about the IBM Cloud services,
130-
please ask a question
131-
[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
128+
If you have difficulties using this SDK or you have a question about the IBM Cloud services,
129+
ask a question at [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
132130

133131
## Issues
134132
If you encounter an issue with the project, you are welcome to submit a
135133
[bug report](https://github.com/IBM/vpc-python-sdk/issues).
136-
Before that, please search for similar issues. It's possible that someone has already reported the problem.
134+
Before you create a new issue, search for similar issues. It's possible that someone has already reported the problem.
137135

138136
## Open source @ IBM
139-
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)
137+
Find more open source projects on the [IBM GitHub Page](http://ibm.github.io/).
140138

141139
## Contributing
142140
See [CONTRIBUTING](https://github.com/IBM/vpc-python-sdk/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)