Python Client for Google Cloud RuntimeConfig
============================================

|alpha| |pypi| |versions| |compat_check_pypi| |compat_check_github|

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.

- `Client Library Documentation`_
- `Product Documentation`_

.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg
   :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support
.. |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/
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-cloud-runtimeconfig
   :target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-cloud-runtimeconfig
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Druntimeconfig
   :target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Druntimeconfig
.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/
.. _Client Library Documentation: https://googleapis.dev/python/runtimeconfig/latest
.. _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:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Google Cloud RuntimeConfig 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 Google Cloud RuntimeConfig API.:  https://cloud.google.com/runtimeconfig
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/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/


Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Python >= 3.5

Deprecated Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.


Mac/Linux
^^^^^^^^^

.. 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.


