-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6021)
Toward #5912.
- Loading branch information
Showing
3 changed files
with
19 additions
and
75 deletions.
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 @@ | ||
../CHANGELOG.md |
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 |
---|---|---|
@@ -1,84 +1,21 @@ | ||
Python Client for Cloud Key Management Service (KMS) API (`Alpha`_) | ||
=================================================================== | ||
.. include:: /../kms/README.rst | ||
|
||
`Cloud Key Management Service (KMS) API`_: Manages keys and performs cryptographic operations in a central cloud | ||
service, for direct use by other cloud resources and applications. | ||
|
||
- `Client Library Documentation`_ | ||
- `Product Documentation`_ | ||
|
||
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst | ||
.. _Cloud Key Management Service (KMS) API: https://cloud.google.com/kms | ||
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/kms/index.html | ||
.. _Product Documentation: https://cloud.google.com/kms | ||
|
||
Quick Start | ||
----------- | ||
|
||
In order to use this library, you first need to go through the following steps: | ||
|
||
1. `Select or create a Cloud Platform project.`_ | ||
2. `Enable billing for your project.`_ | ||
3. `Enable the Cloud Key Management Service (KMS) API.`_ | ||
4. `Setup Authentication.`_ | ||
|
||
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project | ||
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project | ||
.. _Enable the Cloud Key Management Service (KMS) API.: https://cloud.google.com/kms | ||
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html | ||
|
||
Installation | ||
~~~~~~~~~~~~ | ||
|
||
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to | ||
create isolated Python environments. The basic problem it addresses is one of | ||
dependencies and versions, and indirectly permissions. | ||
|
||
With `virtualenv`_, it's possible to install this library without needing system | ||
install permissions, and without clashing with the installed system | ||
dependencies. | ||
|
||
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ | ||
|
||
|
||
Mac/Linux | ||
^^^^^^^^^ | ||
|
||
.. code-block:: console | ||
pip install virtualenv | ||
virtualenv <your-env> | ||
source <your-env>/bin/activate | ||
<your-env>/bin/pip install google-cloud-kms | ||
Windows | ||
^^^^^^^ | ||
|
||
.. code-block:: console | ||
API Reference | ||
------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
pip install virtualenv | ||
virtualenv <your-env> | ||
<your-env>\Scripts\activate | ||
<your-env>\Scripts\pip.exe install google-cloud-kms | ||
gapic/v1/api | ||
gapic/v1/types | ||
|
||
Next Steps | ||
~~~~~~~~~~ | ||
|
||
- Read the `Client Library Documentation`_ for Cloud Key Management Service (KMS) API | ||
API to see other available methods on the client. | ||
- Read the `Cloud Key Management Service (KMS) API Product documentation`_ to learn | ||
more about the product and see How-to Guides. | ||
- View this `repository’s main README`_ to see the full list of Cloud | ||
APIs that we cover. | ||
Changelog | ||
--------- | ||
|
||
.. _Cloud Key Management Service (KMS) API Product documentation: https://cloud.google.com/kms | ||
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst | ||
For a list of all ``google-cloud-kms`` releases: | ||
|
||
Api Reference | ||
------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
:maxdepth: 2 | ||
|
||
gapic/v1/api | ||
gapic/v1/types | ||
changelog |