README.rst

Python Client for {{ metadata['repo']['name_pretty'] }} =================={% for i in range(metadata['repo']['name_pretty']|length) %}={% endfor %}

{{ metadata['repo']['name_pretty'] }}: {% if metadata['repo']['api_description'] %}{{metadata['repo']['api_description'] }}{% endif %}

• `Client Library Documentation`_
• `Product Documentation`_

{%- if is_google_cloud_api %} .. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }}/summary_overview {% else %} .. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }} {% endif -%} .. _Product Documentation: {{ metadata['repo']['product_documentation'] }}

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 {{ metadata['repo']['name_pretty'] }}.
4. Setup Authentication.

Installation

Install this library in a virtual environment using venv. venv is a tool that creates isolated Python environments. These isolated environments can have separate versions of Python packages, which allows you to isolate one project's dependencies from the dependencies of other projects.

With venv, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Code samples and snippets

Code samples and snippets live in the samples/ folder.

Supported Python Versions

Our client libraries are compatible with all current active and maintenance versions of Python.

Python >= 3.7

Unsupported Python Versions

Python <= 3.6

If you are using an end-of-life version of Python, we recommend that you update as soon as possible to an actively supported version.

Mac/Linux

python3 -m venv <your-env>
source <your-env>/bin/activate
pip install {{ metadata['repo']['distribution_name'] }}

Windows

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install {{ metadata['repo']['distribution_name'] }}

Next Steps

• Read the `Client Library Documentation`_ for {{ metadata['repo']['name_pretty'] }} to see other available methods on the client.
• Read the {{ metadata['repo']['name_pretty'] }} Product documentation to learn more about the product and see How-to Guides.
• View this README to see the full list of Cloud APIs that we cover.