-
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.
runtimeconfig: prep docs for repo split. (#6023)
- Move contents of 'docs/runtimeconfig/' to 'runtimeconfig/docs'. - Rename 'runtimeconfig/docs/usage.rst' to 'runtimeconfig/docs/index.rst', and add a static redirect page, 'runtimeconfig/docs/usage.html'. - Harmonize / DRY 'runtimeconfig/README.rst' / 'runtimeconfig/docs/index.rst'. Toward #5912
- Loading branch information
Showing
12 changed files
with
92 additions
and
73 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
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 @@ | ||
../runtimeconfig/docs |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,59 +1,83 @@ | ||
Python Client for Google Cloud RuntimeConfig | ||
============================================ | ||
|
||
Python idiomatic client for `Google Cloud RuntimeConfig`_ | ||
|
||
.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/ | ||
|
||
|alpha| |pypi| |versions| | ||
|
||
- `Documentation`_ | ||
The `Google Cloud RuntimeConfig`_ API enables developers to dynamically | ||
configure and expose variables through Google Cloud Platform. In addition, you | ||
can also set Watchers and Waiters that will watch for changes to your data and | ||
return based on certain conditions. | ||
|
||
.. _Documentation: http://googlecloudplatform.github.io/google-cloud-python/ | ||
- `Client Library Documentation`_ | ||
- `Product Documentation`_ | ||
|
||
.. |alpha| image:: https://img.shields.io/badge/status-alpha-orange.svg | ||
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg | ||
:target: https://pypi.org/project/google-cloud-runtimeconfig/ | ||
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg | ||
:target: https://pypi.org/project/google-cloud-runtimeconfig/ | ||
.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/ | ||
.. _Client Library Documentation: http://googlecloudplatform.github.io/google-cloud-python/runtimeconfig/index.html | ||
.. _Product Documentation: https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/ | ||
|
||
**This client library is currently in alpha and may be subject to change.** | ||
|
||
Quick Start | ||
----------- | ||
|
||
:: | ||
In order to use this library, you first need to go through the following steps: | ||
|
||
$ pip install --upgrade google-cloud-runtimeconfig | ||
1. `Select or create a Cloud Platform project.`_ | ||
2. `Enable billing for your project.`_ | ||
3. `Enable the Google Cloud Datastore API.`_ | ||
4. `Setup Authentication.`_ | ||
|
||
For more information on setting up your Python development environment, | ||
such as installing ``pip`` and ``virtualenv`` on your system, please refer | ||
to `Python Development Environment Setup Guide`_ for Google Cloud Platform. | ||
.. _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 Google Cloud Datastore API.: https://cloud.google.com/runtimeconfig | ||
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html | ||
|
||
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup | ||
Installation | ||
~~~~~~~~~~~~ | ||
|
||
Authentication | ||
-------------- | ||
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 ``google-cloud-python`` we try to make authentication as painless as | ||
possible. Check out the `Authentication section`_ in our documentation to | ||
learn more. You may also find the `authentication document`_ shared by all | ||
the ``google-cloud-*`` libraries to be helpful. | ||
With `virtualenv`_, it's possible to install this library without needing system | ||
install permissions, and without clashing with the installed system | ||
dependencies. | ||
|
||
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html | ||
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication | ||
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ | ||
|
||
Using the API | ||
------------- | ||
|
||
The Google Cloud `RuntimeConfig`_ (`RuntimeConfig API docs`_) API enables | ||
developers to dynamically configure and expose variables through Google Cloud | ||
Platform. In addition, you can also set Watchers and Waiters that will watch | ||
for changes to your data and return based on certain conditions. | ||
Mac/Linux | ||
^^^^^^^^^ | ||
|
||
.. _RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/ | ||
.. _RuntimeConfig API docs: https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/ | ||
.. code-block:: console | ||
pip install virtualenv | ||
virtualenv <your-env> | ||
source <your-env>/bin/activate | ||
<your-env>/bin/pip install google-cloud-runtimeconfig | ||
Windows | ||
^^^^^^^ | ||
|
||
.. code-block:: console | ||
pip install virtualenv | ||
virtualenv <your-env> | ||
<your-env>\Scripts\activate | ||
<your-env>\Scripts\pip.exe install google-cloud-runtimeconfig | ||
Next Steps | ||
~~~~~~~~~~ | ||
|
||
- Read the `Client Library Documentation`_ for Google Cloud RuntimeConfig | ||
API to see other available methods on the client. | ||
- Read the `Product documentation`_ to learn | ||
more about the product and see How-to Guides. | ||
|
||
See the ``google-cloud-python`` API runtimeconfig `Documentation`_ to learn | ||
how to interact with Cloud RuntimeConfig using this Client Library. | ||
|
||
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg | ||
:target: https://pypi.org/project/google-cloud-runtimeconfig/ | ||
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg | ||
:target: https://pypi.org/project/google-cloud-runtimeconfig/ |
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 |
File renamed without changes.
File renamed without changes.
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,22 @@ | ||
.. include:: /../runtimeconfig/README.rst | ||
|
||
API Reference | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
client | ||
config | ||
variable | ||
|
||
Changelog | ||
--------- | ||
|
||
For a list of all ``google-cloud-runtimeconfig`` releases: | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
changelog | ||
|
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,8 @@ | ||
<html> | ||
<head> | ||
<meta http-equiv="refresh" content="1; url=./index.html:" /> | ||
<script> | ||
window.location.href = "./index.html" | ||
</script> | ||
</head> | ||
</html> |
File renamed without changes.