This repository has been archived by the owner on Dec 31, 2023. It is now read-only.
docs: Generate using new common.py_samples() synthtool functionality #35
Merged
kolea2
merged 6 commits into
googleapis:master
from
runargs:08052020-pysamples-generation
Aug 7, 2020
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4e92923
docs: Generate using new common.py_samples() synthtool functionality
runargs ec67c26
docs: Generate using new common.py_samples() synthtool functionality
runargs 030f24b
Merge branch '08052020-pysamples-generation' of github.com:runargs/py…
runargs 11c54f4
Delete old README
runargs 1f7de85
Updated README to remove duplicate info
runargs da6ad2e
Minor change
runargs File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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. | ||
This directory contains snippets for Google Cloud KMS API. 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 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can remove the first sentence in your
custom_content
.