As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Client for Cloud Tasks API

GA pypi versions

Cloud Tasks API: Manages the execution of large numbers of distributed requests.

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

  4. Setup Authentication.

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.

Supported Python Versions

Python >= 3.6

Deprecated Python Versions

Python == 2.7.

The last version of this library compatible with Python 2.7 is google-cloud-tasks==1.5.0.

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-tasks

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-tasks

Next Steps

Note

Because this client uses grpcio library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances after the invocation of os.fork() by multiprocessing.Pool or multiprocessing.Process.

API Reference

This package includes clients for multiple versions of the Tasks API. By default, you will get v2, the latest version.

The previous beta releases, spelled v2beta3 and v2beta2, are provided to continue to support code previously written against them. In order to use them, you will want to import from e.g. google.cloud.tasks_v2beta3 in lieu of google.cloud.tasks (or the equivalent google.cloud.tasks_v2).

v2beta3:

v2beta2:

Migration Guide

See the guide below for instructions on migrating to the 2.x release of this library.