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 OS Config

OS Config: provides OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

• Client Library Documentation

• 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 OS Config.

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 google-cloud-os-config

Windows

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

Next Steps

• Read the Client Library Documentation for OS Config to see other available methods on the client.

• Read the OS Config 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.

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.

This package includes clients for multiple versions of OS Config. By default, you will get version osconfig_v1.

API Reference

• Services for Google Cloud Osconfig v1 API
  • OsConfigService
  • OsConfigZonalService
• Types for Google Cloud Osconfig v1 API

API Reference

• Services for Google Cloud Osconfig v1alpha API
  • OsConfigZonalService
• Types for Google Cloud Osconfig v1alpha API

Changelog

For a list of all google-cloud-os-config releases:

• Changelog
  • 1.18.1 (2024-11-11)
  • 1.18.0 (2024-10-24)
  • 1.17.5 (2024-07-30)
  • 1.17.4 (2024-07-08)
  • 1.17.3 (2024-03-05)
  • 1.17.2 (2024-02-22)
  • 1.17.1 (2024-02-06)
  • 1.17.0 (2024-02-01)
  • 1.16.0 (2023-12-07)
  • 1.15.3 (2023-09-30)
  • 1.15.2 (2023-07-04)
  • 1.15.1 (2023-03-23)
  • 1.15.0 (2023-02-21)
  • 1.14.1 (2023-01-20)
  • 1.14.0 (2023-01-10)
  • 1.13.0 (2022-12-13)
  • 1.12.4 (2022-10-07)
  • 1.12.3 (2022-09-29)
  • 1.12.2 (2022-08-11)
  • 1.12.1 (2022-07-13)
  • 1.12.0 (2022-07-07)
  • 1.11.2 (2022-06-03)
  • 1.11.1 (2022-03-05)
  • 1.11.0 (2022-02-26)
  • 1.10.0 (2022-02-08)
  • 1.9.0 (2021-11-11)
  • 1.8.0 (2021-11-04)
  • 1.7.1 (2021-11-02)
  • 1.7.0 (2021-10-18)
  • 1.6.0 (2021-10-08)
  • 1.5.2 (2021-09-30)
  • 1.5.1 (2021-09-24)
  • 1.5.0 (2021-09-07)
  • 1.4.0 (2021-08-30)
  • 1.3.2 (2021-07-28)
  • 1.3.1 (2021-07-20)
  • 1.3.0 (2021-07-14)
  • 1.2.0 (2021-06-09)
  • 1.1.0 (2021-02-12)
  • 1.0.0 (2020-11-18)
  • 0.1.2 (2020-06-11)
  • 0.1.1 (2020-06-11)
  • 0.1.0 (2020-06-10)