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 Compute Engine

stable pypi versions

Compute Engine: delivers virtual machines running in Google’s innovative data centers and worldwide fiber network. Compute Engine’s tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing. Compute Engine’s VMs boot quickly, come with persistent disk storage, deliver consistent performance and are available in many configurations.

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

  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.

PyCharm/JetBrains IDEs

This library has now grown in size past the JetBrains default size limit of ~2.5Mb. As a result, code completion in JetBrains products can fail to work with the classes from our library. To fix this, you need to update the idea.max.intellisense.filesize setting in custom properties (Help -> Edit custom properties…). Just add the line idea.max.intellisense.filesize = 10000 to change this limit to ~10Mb.

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 google-cloud-compute

Windows

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-compute

Next Steps

Note

Because this client uses grpc 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.Pool or multiprocessing.Process.

API Reference

Changelog

For a list of all google-cloud-compute releases: