Skip to content
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
merged 6 commits into from Aug 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion .repo-metadata.json
Expand Up @@ -9,5 +9,15 @@
"repo": "googleapis/python-kms",
"distribution_name": "google-cloud-kms",
"api_id": "cloudkms.googleapis.com",
"requires_billing": true
"requires_billing": true,
"client_library": true,
"custom_content": "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/",
"sample_project_dir": "samples/snippets/",
"samples": [
{"name": "Quickstart",
"description": "This quickstart shows you how to create and use encryption keys with Cloud Key Management Service.",
"file": "quickstart.py",
"runnable": true,
"custom_content": "More information about the Cloud KMS quickstart is available at https://cloud.google.com/kms/docs/quickstart"}
]
}
54 changes: 54 additions & 0 deletions samples/snippets/README.md
@@ -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
98 changes: 0 additions & 98 deletions samples/snippets/README.rst

This file was deleted.

19 changes: 0 additions & 19 deletions samples/snippets/README.rst.in

This file was deleted.

3 changes: 2 additions & 1 deletion synth.py
Expand Up @@ -97,6 +97,7 @@
# Samples templates
# ----------------------------------------------------------------------------

python.py_samples()
sample_files = common.py_samples(unit_cov_level=97, cov_level=99, samples=True)
s.move(sample_files, excludes=['noxfile.py'])

s.shell.run(["nox", "-s", "blacken"], hide_output=False)