You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-5Lines changed: 12 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,23 @@ Review the following guidelines for submitting questions, issues, or changes to
4
4
5
5
## Questions
6
6
7
-
If you have questions about using the IBM Cloud Secrets Manager SDKs, you can ask questions in
8
-
[Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud+secrets-manager). Be sure to include the `ibm-cloud` and `secrets-manager` tags.
7
+
If you have questions about using the IBM Cloud Secrets Manager SDKs, you can ask questions in
8
+
[Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud+secrets-manager). Be sure to include
9
+
the `ibm-cloud` and `secrets-manager` tags.
9
10
10
-
You can also check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager) and [API reference](https://cloud.ibm.com/apidocs/secrets-manager) for more information about the service.
11
+
You can also check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager)
12
+
and [API reference](https://cloud.ibm.com/apidocs/secrets-manager) for more information about the service.
11
13
12
14
## Issues
13
15
14
-
If you encounter an issue with this project, you're welcome to submit a [bug report](https://github.com/IBM/secrets-manager-python-sdk/issues) to help us improve. Before you create a new issue, please search for similar issues in case someone has already reported the same problem.
16
+
If you encounter an issue with this project, you're welcome to submit
17
+
a [bug report](https://github.com/IBM/secrets-manager-python-sdk/issues) to help us improve. Before you create a new
18
+
issue, please search for similar issues in case someone has already reported the same problem.
15
19
16
20
## Changes
17
21
18
-
Thank you for contributing to IBM Cloud SDK projects! To learn more about submitting changes to this repository, check out the [IBM Cloud SDK Common contribution guidelines](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_python.md).
22
+
Thank you for contributing to IBM Cloud SDK projects! To learn more about submitting changes to this repository, check
23
+
out
24
+
the [IBM Cloud SDK Common contribution guidelines](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_python.md)
Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
51
54
52
-
With IAM authentication, you supply an API key that is used to generate an access token. Then, the access token is included in each API request to Secrets Manager. Access tokens are valid for a limited amount of time and must be regenerated.
55
+
With IAM authentication, you supply an API key that is used to generate an access token. Then, the access token is
56
+
included in each API request to Secrets Manager. Access tokens are valid for a limited amount of time and must be
57
+
regenerated.
53
58
54
-
Authentication for this SDK is accomplished by using [IAM authenticators](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication). Import authenticators from `ibm_cloud_sdk_core.authenticators`.
59
+
Authentication for this SDK is accomplished by
60
+
using [IAM authenticators](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication). Import
61
+
authenticators from `ibm_cloud_sdk_core.authenticators`.
55
62
56
63
### Examples
57
64
@@ -60,18 +67,20 @@ Authentication for this SDK is accomplished by using [IAM authenticators](https:
60
67
```python
61
68
from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
To learn more about IAM authenticators and how to use them in your Python application, see the [IBM Python SDK Core documentation](https://github.com/IBM/python-sdk-core/blob/master/Authentication.md).
75
+
To learn more about IAM authenticators and how to use them in your Python application, see
76
+
the [IBM Python SDK Core documentation](https://github.com/IBM/python-sdk-core/blob/master/Authentication.md).
69
77
70
78
## Using the SDK
71
79
72
80
### Basic usage
73
81
74
-
- Use the `set_service_url` method to set the endpoint URL that is specific to your Secrets Manager service instance. To find your endpoint URL, you can copy it from the **Endpoints** page in the Secrets Manager UI.
82
+
- Use the `set_service_url` method to set the endpoint URL that is specific to your Secrets Manager service instance. To
83
+
find your endpoint URL, you can copy it from the **Endpoints** page in the Secrets Manager UI.
75
84
76
85
#### Examples
77
86
@@ -81,9 +90,9 @@ Here's an example `secrets_manager.py` file:
81
90
82
91
```python
83
92
from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
84
-
from ibm_secrets_manager_sdk.ibm_cloud_secrets_manager_api_v1import*
93
+
from ibm_secrets_manager_sdk.secrets_manager_v1import*
Replace the `apikey` and `set_service_url()` values. Then use the `python secrets_manager.py` command to run your application. You should see the payload of the arbitrary secret that was created.
122
+
Replace the `apikey` and `set_service_url()` values. Then use the `python secrets_manager.py` command to run your
123
+
application. You should see the payload of the arbitrary secret that was created.
114
124
115
-
For more information and IBM Cloud SDK usage examples for Python, see the [IBM Cloud SDK Common documentation](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
125
+
For more information and IBM Cloud SDK usage examples for Python, see
126
+
the [IBM Cloud SDK Common documentation](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
116
127
117
128
## Questions
118
129
119
-
If you're having difficulties using this SDK, you can ask questions about this project by using [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud+secrets-manager). Be sure to include the `ibm-cloud` and `secrets-manager` tags.
130
+
If you're having difficulties using this SDK, you can ask questions about this project by
131
+
using [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud+secrets-manager). Be sure to include
132
+
the `ibm-cloud` and `secrets-manager` tags.
120
133
121
-
You can also check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager) and [API reference](https://cloud.ibm.com/apidocs/secrets-manager) for more information about the service.
134
+
You can also check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager)
135
+
and [API reference](https://cloud.ibm.com/apidocs/secrets-manager) for more information about the service.
122
136
123
137
## Issues
124
138
125
-
If you encounter an issue with the project, you're welcome to submit a [bug report](https://github.com/IBM/secrets-manager-python-sdk/issues) to help us improve.
139
+
If you encounter an issue with the project, you're welcome to submit
140
+
a [bug report](https://github.com/IBM/secrets-manager-python-sdk/issues) to help us improve.
0 commit comments