diff options
Diffstat (limited to 'python-ibm-secrets-manager-sdk.spec')
| -rw-r--r-- | python-ibm-secrets-manager-sdk.spec | 526 |
1 files changed, 526 insertions, 0 deletions
diff --git a/python-ibm-secrets-manager-sdk.spec b/python-ibm-secrets-manager-sdk.spec new file mode 100644 index 0000000..596371a --- /dev/null +++ b/python-ibm-secrets-manager-sdk.spec @@ -0,0 +1,526 @@ +%global _empty_manifest_terminate_build 0 +Name: python-ibm-secrets-manager-sdk +Version: 2.0.0 +Release: 1 +Summary: IBM Cloud Secrets Manager Python SDK +License: Apache 2.0 +URL: https://github.com/IBM/secrets-manager-python-sdk +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/8b/48/50a5824d4384a896f98e8fa4f5b6bccf6560a7cf5892cdd5a97d75e7ffdb/ibm-secrets-manager-sdk-2.0.0.tar.gz +BuildArch: noarch + +Requires: python3-requests +Requires: python3-urllib3 +Requires: python3-dateutil +Requires: python3-ibm-cloud-sdk-core + +%description +# IBM Cloud Secrets Manager Python SDK + +A Python client library to interact with +the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager). + +<details> +<summary>Table of Contents</summary> + +* [Overview](#overview) +* [Prerequisites](#prerequisites) +* [Installation](#installation) +* [Authentication](#authentication) +* [Using the SDK](#using-the-sdk) +* [Questions](#questions) +* [Issues](#issues) +* [Contributing](#contributing) +* [License](#license) + +</details> + +## Overview + +The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud +services: + +| Service name | Imported class name | +|------------------------------------------------------------------|----------------------| +| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV1 | + +## Prerequisites + +- An [IBM Cloud account](https://cloud.ibm.com/registration). +- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager). +- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account. +- Python 3.9 or above. + +## Installation + +To install, use `pip` or `easy_install`: + +```bash +pip install --upgrade "ibm-secrets-manager-sdk" +``` + +or + +```bash +easy_install --upgrade "ibm-secrets-manager-sdk" +``` + +## Authentication + +Secrets Manager uses token-based Identity and Access Management (IAM) authentication. + +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. + +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`. + +### Examples + +#### Programmatic credentials + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) +``` + +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). + +## Using the SDK + +### Basic usage + +- 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. + +#### Examples + +Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance. + +Here's an example `secrets_manager.py` file: + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator +from ibm_secrets_manager_sdk.secrets_manager_v1 import * + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) + +secretsManager.set_service_url('<SERVICE_URL>') + +# create arbitrary secret +response = secretsManager.create_secret( + 'arbitrary', + {'collection_type': 'application/vnd.ibm.secrets-manager.secret+json', 'collection_total': 1}, + [{'name': 'example-arbitrary-secret', 'description': 'Extended description for this secret.', + 'payload': 'secret-data'}] +) + +secretId = response.result['resources'][0]['id'] + +# get arbitrary secret +response = secretsManager.get_secret( + 'arbitrary', + secretId +) + +secretPayload = response.result['resources'][0]['secret_data']['payload'] +print('The arbitrary secret payload is: ' + secretPayload) + +``` + +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. + +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). + +## Questions + +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 `ibm-secrets-manager` tags. + +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. + +## Issues + +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. + +## Contributing + +For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md). + +## License + +This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE). + +dummy_PR #2 + + +%package -n python3-ibm-secrets-manager-sdk +Summary: IBM Cloud Secrets Manager Python SDK +Provides: python-ibm-secrets-manager-sdk +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-ibm-secrets-manager-sdk +# IBM Cloud Secrets Manager Python SDK + +A Python client library to interact with +the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager). + +<details> +<summary>Table of Contents</summary> + +* [Overview](#overview) +* [Prerequisites](#prerequisites) +* [Installation](#installation) +* [Authentication](#authentication) +* [Using the SDK](#using-the-sdk) +* [Questions](#questions) +* [Issues](#issues) +* [Contributing](#contributing) +* [License](#license) + +</details> + +## Overview + +The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud +services: + +| Service name | Imported class name | +|------------------------------------------------------------------|----------------------| +| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV1 | + +## Prerequisites + +- An [IBM Cloud account](https://cloud.ibm.com/registration). +- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager). +- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account. +- Python 3.9 or above. + +## Installation + +To install, use `pip` or `easy_install`: + +```bash +pip install --upgrade "ibm-secrets-manager-sdk" +``` + +or + +```bash +easy_install --upgrade "ibm-secrets-manager-sdk" +``` + +## Authentication + +Secrets Manager uses token-based Identity and Access Management (IAM) authentication. + +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. + +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`. + +### Examples + +#### Programmatic credentials + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) +``` + +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). + +## Using the SDK + +### Basic usage + +- 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. + +#### Examples + +Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance. + +Here's an example `secrets_manager.py` file: + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator +from ibm_secrets_manager_sdk.secrets_manager_v1 import * + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) + +secretsManager.set_service_url('<SERVICE_URL>') + +# create arbitrary secret +response = secretsManager.create_secret( + 'arbitrary', + {'collection_type': 'application/vnd.ibm.secrets-manager.secret+json', 'collection_total': 1}, + [{'name': 'example-arbitrary-secret', 'description': 'Extended description for this secret.', + 'payload': 'secret-data'}] +) + +secretId = response.result['resources'][0]['id'] + +# get arbitrary secret +response = secretsManager.get_secret( + 'arbitrary', + secretId +) + +secretPayload = response.result['resources'][0]['secret_data']['payload'] +print('The arbitrary secret payload is: ' + secretPayload) + +``` + +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. + +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). + +## Questions + +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 `ibm-secrets-manager` tags. + +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. + +## Issues + +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. + +## Contributing + +For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md). + +## License + +This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE). + +dummy_PR #2 + + +%package help +Summary: Development documents and examples for ibm-secrets-manager-sdk +Provides: python3-ibm-secrets-manager-sdk-doc +%description help +# IBM Cloud Secrets Manager Python SDK + +A Python client library to interact with +the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager). + +<details> +<summary>Table of Contents</summary> + +* [Overview](#overview) +* [Prerequisites](#prerequisites) +* [Installation](#installation) +* [Authentication](#authentication) +* [Using the SDK](#using-the-sdk) +* [Questions](#questions) +* [Issues](#issues) +* [Contributing](#contributing) +* [License](#license) + +</details> + +## Overview + +The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud +services: + +| Service name | Imported class name | +|------------------------------------------------------------------|----------------------| +| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV1 | + +## Prerequisites + +- An [IBM Cloud account](https://cloud.ibm.com/registration). +- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager). +- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account. +- Python 3.9 or above. + +## Installation + +To install, use `pip` or `easy_install`: + +```bash +pip install --upgrade "ibm-secrets-manager-sdk" +``` + +or + +```bash +easy_install --upgrade "ibm-secrets-manager-sdk" +``` + +## Authentication + +Secrets Manager uses token-based Identity and Access Management (IAM) authentication. + +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. + +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`. + +### Examples + +#### Programmatic credentials + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) +``` + +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). + +## Using the SDK + +### Basic usage + +- 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. + +#### Examples + +Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance. + +Here's an example `secrets_manager.py` file: + +```python +from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator +from ibm_secrets_manager_sdk.secrets_manager_v1 import * + +secretsManager = SecretsManagerV1( + authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>') +) + +secretsManager.set_service_url('<SERVICE_URL>') + +# create arbitrary secret +response = secretsManager.create_secret( + 'arbitrary', + {'collection_type': 'application/vnd.ibm.secrets-manager.secret+json', 'collection_total': 1}, + [{'name': 'example-arbitrary-secret', 'description': 'Extended description for this secret.', + 'payload': 'secret-data'}] +) + +secretId = response.result['resources'][0]['id'] + +# get arbitrary secret +response = secretsManager.get_secret( + 'arbitrary', + secretId +) + +secretPayload = response.result['resources'][0]['secret_data']['payload'] +print('The arbitrary secret payload is: ' + secretPayload) + +``` + +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. + +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). + +## Questions + +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 `ibm-secrets-manager` tags. + +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. + +## Issues + +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. + +## Contributing + +For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md). + +## License + +This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE). + +dummy_PR #2 + + +%prep +%autosetup -n ibm-secrets-manager-sdk-2.0.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-ibm-secrets-manager-sdk -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.0-1 +- Package Spec generated |