Description

Python Client for Cloud Workflows ================================= |stable| |pypi| |versions| `Cloud Workflows`_: Orchestrate and automate Google Cloud and HTTP-based API services with serverless workflows. - `Client Library Documentation`_ - `Product Documentation`_ .. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-workflows.svg :target: https://pypi.org/project/google-cloud-workflows/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-workflows.svg :target: https://pypi.org/project/google-cloud-workflows/ .. _Cloud Workflows: https://cloud.google.com/workflows/ .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/workflows/latest/summary_overview .. _Product Documentation: https://cloud.google.com/workflows/ 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 Workflows.`_ 4. `Set up 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 Workflows.: https://cloud.google.com/workflows/ .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html 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. .. _`venv`: https://docs.python.org/3/library/venv.html Code samples and snippets ~~~~~~~~~~~~~~~~~~~~~~~~~ Code samples and snippets live in the `samples/`_ folder. .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-workflows/samples Supported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^ Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of Python. Python >= 3.9, including 3.14 .. _active: https://devguide.python.org/devcycle/#in-development-main-branch .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches Unsupported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Python <= 3.8 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. .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches Mac/Linux ^^^^^^^^^ .. code-block:: console python3 -m venv <your-env> source <your-env>/bin/activate pip install google-cloud-workflows Windows ^^^^^^^ .. code-block:: console py -m venv <your-env> .\<your-env>\Scripts\activate pip install google-cloud-workflows Next Steps ~~~~~~~~~~ - Read the `Client Library Documentation`_ for Cloud Workflows to see other available methods on the client. - Read the `Cloud Workflows 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. .. _Cloud Workflows Product documentation: https://cloud.google.com/workflows/ .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst Logging ------- This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. Note the following: #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. Simple, environment-based configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers