Skip to content

Commit 302c727

Browse files
authored
Merge pull request #11 from IBM/update
Update SDK with latest APIs
2 parents 837c5e6 + 984d2bd commit 302c727

File tree

12 files changed

+462
-373
lines changed

12 files changed

+462
-373
lines changed

.github/workflows/create-release-and-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ jobs:
2323
env:
2424
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
2525
with:
26-
tag_name: v0.0.${{ github.run_number }}
27-
release_name: Release v0.0.${{ github.run_number }}
26+
tag_name: v0.1.${{ github.run_number }}
27+
release_name: Release v0.1.${{ github.run_number }}
2828
body: |
2929
${{ steps.Changelog.outputs.changelog }}
3030
draft: false

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,6 @@ dmypy.json
127127

128128
# Pyre type checker
129129
.pyre/
130-
*.idea
130+
*.idea
131+
.openapi-generator-ignore
132+
.openapi-generator

CODE_OF_CONDUCT.md

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,14 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6+
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7+
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
8+
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
119

1210
## Our Standards
1311

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
12+
Examples of behavior that contributes to creating a positive environment include:
1613

1714
* Using welcoming and inclusive language
1815
* Being respectful of differing viewpoints and experiences
@@ -22,53 +19,42 @@ include:
2219

2320
Examples of unacceptable behavior by participants include:
2421

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
22+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
2723
* Trolling, insulting/derogatory comments, and personal or political attacks
2824
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
3327

3428
## Our Responsibilities
3529

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
30+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31+
appropriate and fair corrective action in response to any instances of unacceptable behavior.
3932

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
33+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34+
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35+
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
4536

4637
## Scope
4738

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
39+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40+
project or its community. Examples of representing a project or community include using an official project e-mail
41+
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42+
event. Representation of a project may be further defined and clarified by project maintainers.
5443

5544
## Enforcement
5645

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
46+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47+
[email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed
48+
necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
49+
the reporter of an incident. Further details of specific enforcement policies may be posted separately.
6350

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
51+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52+
repercussions as determined by other members of the project's leadership.
6753

6854
## Attribution
6955

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
56+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
57+
at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7258

7359
[homepage]: https://www.contributor-covenant.org
7460

CONTRIBUTING.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,23 @@ Review the following guidelines for submitting questions, issues, or changes to
44

55
## Questions
66

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.
910

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.
1113

1214
## Issues
1315

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.
1519

1620
## Changes
1721

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)
25+
.
1926

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# IBM Cloud Secrets Manager Python SDK
22

3-
A Python client library to interact with the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager).
3+
A Python client library to interact with
4+
the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager).
45

56
<details>
67
<summary>Table of Contents</summary>
@@ -14,21 +15,23 @@ A Python client library to interact with the [IBM Cloud® Secrets Manager APIs](
1415
* [Issues](#issues)
1516
* [Contributing](#contributing)
1617
* [License](#license)
18+
1719
</details>
1820

1921
## Overview
2022

21-
The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud services:
23+
The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud
24+
services:
2225

2326
Service name | Imported class name
2427
--- | ---
25-
[Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | IbmCloudSecretsManagerApiV1
28+
[Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV1
2629

2730
## Prerequisites
2831

2932
- An [IBM Cloud account](https://cloud.ibm.com/registration).
3033
- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager).
31-
- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account.
34+
- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account.
3235
- Python 3.5.3 or above.
3336

3437
## Installation
@@ -49,9 +52,13 @@ easy_install --upgrade "ibm-secrets-manager-sdk"
4952

5053
Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
5154

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.
5358

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`.
5562

5663
### Examples
5764

@@ -60,18 +67,20 @@ Authentication for this SDK is accomplished by using [IAM authenticators](https:
6067
```python
6168
from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
6269

63-
secretsManager = IbmCloudSecretsManagerApiV1(
70+
secretsManager = SecretsManagerV1(
6471
authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
6572
)
6673
```
6774

68-
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).
6977

7078
## Using the SDK
7179

7280
### Basic usage
7381

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.
7584

7685
#### Examples
7786

@@ -81,9 +90,9 @@ Here's an example `secrets_manager.py` file:
8190

8291
```python
8392
from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
84-
from ibm_secrets_manager_sdk.ibm_cloud_secrets_manager_api_v1 import *
93+
from ibm_secrets_manager_sdk.secrets_manager_v1 import *
8594

86-
secretsManager = IbmCloudSecretsManagerApiV1(
95+
secretsManager = SecretsManagerV1(
8796
authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
8897
)
8998

@@ -110,19 +119,25 @@ print('The arbitrary secret payload is: ' + secretPayload)
110119

111120
```
112121

113-
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.
114124

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).
116127

117128
## Questions
118129

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.
120133

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.
122136

123137
## Issues
124138

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.
126141

127142
## Contributing
128143

0 commit comments

Comments
 (0)