Skip to content

Commit 7624359

Browse files
runargsrsamborski
authored andcommitted
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
1 parent 656593d commit 7624359

File tree

3 files changed

+54
-117
lines changed

3 files changed

+54
-117
lines changed

kms/snippets/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
2+
[//]: # "To regenerate it, use `python -m synthtool`."
3+
4+
## Python Samples for Google Cloud Key Management Service
5+
6+
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.
7+
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/
8+
Samples, quickstarts, and other documentation are available at <a href="https://cloud.google.com/kms">cloud.google.com</a>.
9+
10+
11+
### Quickstart
12+
13+
This quickstart shows you how to create and use encryption keys with Cloud Key Management Service.
14+
15+
16+
<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">
17+
</a>
18+
19+
To run this sample:
20+
21+
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].
22+
23+
1. Make a fork of this repo and clone the branch locally, then navigate to the sample directory you want to use.
24+
25+
1. Install the dependencies needed to run the samples.
26+
27+
pip install -r requirements.txt
28+
29+
1. Run the sample using
30+
31+
python quickstart.py
32+
33+
34+
More information about the Cloud KMS quickstart is available at https://cloud.google.com/kms/docs/quickstart
35+
36+
## Additional Information
37+
38+
These samples use the [Google Cloud Client Library for Python][client_library_python].
39+
You can read the documentation for more details on API usage and use GitHub
40+
to [browse the source][source] and [report issues][issues].
41+
42+
### Contributing
43+
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>.
44+
45+
[authentication]: https://cloud.google.com/docs/authentication/getting-started
46+
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing
47+
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/
48+
[source]: https://github.com/GoogleCloudPlatform/google-cloud-python
49+
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues
50+
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst
51+
[py_style]: http://google.github.io/styleguide/pyguide.html
52+
[cloud_sdk]: https://cloud.google.com/sdk/docs
53+
[gcloud_shell]: https://cloud.google.com/shell/docs
54+
[gcloud_shell]: https://cloud.google.com/shell/docs

kms/snippets/README.rst

Lines changed: 0 additions & 98 deletions
This file was deleted.

kms/snippets/README.rst.in

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)