Skip to content

Commit 804e44a

Browse files
bkuangBenson Kuang
authored andcommitted
chore: update README and fix typos in attestation scripts (#203)
Remove the README.rst.in until the README gen templates have been updated Co-authored-by: Benson Kuang <[email protected]>
1 parent 4b8836d commit 804e44a

File tree

3 files changed

+10
-30
lines changed

3 files changed

+10
-30
lines changed

kms/attestations/README.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. This file is automatically generated. Do not edit this file directly.
2-
31
Google Cloud Key Management Service Python Samples
42
===============================================================================
53

@@ -12,7 +10,7 @@ This directory contains samples for Google Cloud Key Management Service. The `Cl
1210

1311

1412

15-
.. _Google Cloud Key Management Service: https://cloud.google.com/kms/docs/
13+
.. _Cloud Key Management Service: https://cloud.google.com/kms/docs/
1614

1715

1816

@@ -25,11 +23,11 @@ Setup
2523
Install Dependencies
2624
++++++++++++++++++++
2725

28-
#. Clone python-docs-samples and change directory to the sample directory you want to use.
26+
#. Clone python-kms and change directory to the sample directory you want to use.
2927

3028
.. code-block:: bash
3129
32-
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
30+
$ git clone https://github.com/googleapis/python-kms.git
3331
3432
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
3533

@@ -43,6 +41,11 @@ Install Dependencies
4341
$ virtualenv env
4442
$ source env/bin/activate
4543
44+
#. Install the dependencies needed to run the samples.
45+
46+
.. code-block:: bash
47+
48+
$ pip install -r requirements.txt
4649
4750
.. _pip: https://pip.pypa.io/
4851
.. _virtualenv: https://virtualenv.pypa.io/
@@ -86,7 +89,7 @@ Verify attestations for keys generated by Cloud HSM
8689
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8790

8891
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
89-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=samples/attestations/verify_attestation.py,samples/attestations/README.rst
92+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-kms&page=editor&open_in_editor=samples/attestations/verify_attestation.py,samples/attestations/README.rst
9093

9194

9295

kms/attestations/README.rst.in

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

kms/attestations/verify_attestation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def verify(attestation_file, bundle_file):
5656
cert_obj = x509.load_pem_x509_certificate(
5757
str(cert).encode('utf-8'), backends.default_backend())
5858
try:
59-
# Check if the data was signed by the private key assosicated
59+
# Check if the data was signed by the private key associated
6060
# with the public key in the certificate. The data should have
6161
# been signed with PKCS1v15 padding.
6262
cert_obj.public_key().verify(

0 commit comments

Comments
 (0)