|
1 | | -Python Client for Cloud Key Management Service (KMS) API (`Alpha`_) |
2 | | -=================================================================== |
| 1 | +.. include:: /../kms/README.rst |
3 | 2 |
|
4 | | -`Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud |
5 | | -service, for direct use by other cloud resources and applications. |
6 | 3 |
|
7 | | -- `Client Library Documentation`_ |
8 | | -- `Product Documentation`_ |
9 | | - |
10 | | -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst |
11 | | -.. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms |
12 | | -.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html |
13 | | -.. _Product Documentation: https://cloud.google.com/kms |
14 | | - |
15 | | -Quick Start |
16 | | ------------ |
17 | | - |
18 | | -In order to use this library, you first need to go through the following steps: |
19 | | - |
20 | | -1. `Select or create a Cloud Platform project.`_ |
21 | | -2. `Enable billing for your project.`_ |
22 | | -3. `Enable the Cloud Key Management Service (KMS) API.`_ |
23 | | -4. `Setup Authentication.`_ |
24 | | - |
25 | | -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project |
26 | | -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project |
27 | | -.. _Enable the Cloud Key Management Service (KMS) API.: https://cloud.google.com/kms |
28 | | -.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html |
29 | | - |
30 | | -Installation |
31 | | -~~~~~~~~~~~~ |
32 | | - |
33 | | -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to |
34 | | -create isolated Python environments. The basic problem it addresses is one of |
35 | | -dependencies and versions, and indirectly permissions. |
36 | | - |
37 | | -With `virtualenv`_, it's possible to install this library without needing system |
38 | | -install permissions, and without clashing with the installed system |
39 | | -dependencies. |
40 | | - |
41 | | -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ |
42 | | - |
43 | | - |
44 | | -Mac/Linux |
45 | | -^^^^^^^^^ |
46 | | - |
47 | | -.. code-block:: console |
48 | | -
|
49 | | - pip install virtualenv |
50 | | - virtualenv <your-env> |
51 | | - source <your-env>/bin/activate |
52 | | - <your-env>/bin/pip install google-cloud-kms |
53 | | -
|
54 | | -
|
55 | | -Windows |
56 | | -^^^^^^^ |
57 | | - |
58 | | -.. code-block:: console |
| 4 | +API Reference |
| 5 | +------------- |
| 6 | +.. toctree:: |
| 7 | + :maxdepth: 2 |
59 | 8 |
|
60 | | - pip install virtualenv |
61 | | - virtualenv <your-env> |
62 | | - <your-env>\Scripts\activate |
63 | | - <your-env>\Scripts\pip.exe install google-cloud-kms |
| 9 | + gapic/v1/api |
| 10 | + gapic/v1/types |
64 | 11 |
|
65 | | -Next Steps |
66 | | -~~~~~~~~~~ |
67 | 12 |
|
68 | | -- Read the `Client Library Documentation`_ for Cloud Key Management Service (KMS) API |
69 | | - API to see other available methods on the client. |
70 | | -- Read the `Cloud Key Management Service (KMS) API Product documentation`_ to learn |
71 | | - more about the product and see How-to Guides. |
72 | | -- View this `repository’s main README`_ to see the full list of Cloud |
73 | | - APIs that we cover. |
| 13 | +Changelog |
| 14 | +--------- |
74 | 15 |
|
75 | | -.. _Cloud Key Management Service (KMS) API Product documentation: https://cloud.google.com/kms |
76 | | -.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst |
| 16 | +For a list of all ``google-cloud-kms`` releases: |
77 | 17 |
|
78 | | -Api Reference |
79 | | -------------- |
80 | 18 | .. toctree:: |
81 | | - :maxdepth: 2 |
| 19 | + :maxdepth: 2 |
82 | 20 |
|
83 | | - gapic/v1/api |
84 | | - gapic/v1/types |
| 21 | + changelog |
0 commit comments