-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Generate using new common.py_samples() synthtool functionality (#…
…35) * docs: Generate using new common.py_samples() synthtool functionality * docs: Generate using new common.py_samples() synthtool functionality * Delete old README * Updated README to remove duplicate info * Minor change
- Loading branch information
Showing
3 changed files
with
54 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
|
||
## Python Samples for Google Cloud Key Management Service | ||
|
||
This directory contains samples for Google Cloud Key Management Service, which may be used as a refererence for how to use Google Cloud Key Management Service. | ||
The Google Cloud KMS API is a service that allows you to keep encryption keys centrally in the cloud, for direct use by cloud services. More info about Cloud KMS can be found at https://cloud.google.com/kms/docs/ | ||
Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/kms">cloud.google.com</a>. | ||
|
||
|
||
### Quickstart | ||
|
||
This quickstart shows you how to create and use encryption keys with Cloud Key Management Service. | ||
|
||
|
||
<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-kms&page=editor&open_in_editor=quickstart.py"><img alt="Open in Cloud Shell" src="http://gstatic.com/cloudssh/images/open-btn.png"> | ||
</a> | ||
|
||
To run this sample: | ||
|
||
1. If this is your first time working with GCP products, you will need to set up [the Cloud SDK][cloud_sdk] or utilize [Google Cloud Shell][gcloud_shell]. This sample may [require authetication][authentication] and you will need to [enable billing][enable_billing]. | ||
|
||
1. Make a fork of this repo and clone the branch locally, then navigate to the sample directory you want to use. | ||
|
||
1. Install the dependencies needed to run the samples. | ||
|
||
pip install -r requirements.txt | ||
|
||
1. Run the sample using | ||
|
||
python quickstart.py | ||
|
||
|
||
More information about the Cloud KMS quickstart is available at https://cloud.google.com/kms/docs/quickstart | ||
|
||
## Additional Information | ||
|
||
These samples use the [Google Cloud Client Library for Python][client_library_python]. | ||
You can read the documentation for more details on API usage and use GitHub | ||
to [browse the source][source] and [report issues][issues]. | ||
|
||
### Contributing | ||
For [contributing guidelines][contrib_guide], the [Python style guide][py_style], and more information on prerequisite steps to contribute, view the source code at <a href="https://github.com/googleapis/python-kms">googleapis/python-kms</a>. | ||
|
||
[authentication]: https://cloud.google.com/docs/authentication/getting-started | ||
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/ | ||
[source]: https://github.com/GoogleCloudPlatform/google-cloud-python | ||
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst | ||
[py_style]: http://google.github.io/styleguide/pyguide.html | ||
[cloud_sdk]: https://cloud.google.com/sdk/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs | ||
[gcloud_shell]: https://cloud.google.com/shell/docs |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.