renovate-bot / python-debugger-client Goto Github PK

Python Client for Cloud Debugger API

Cloud Debugger API: is a feature of Google Cloud Platform that lets you inspect the state of an application, at any code location, without stopping or slowing down the running app. Cloud Debugger makes it easier to view the application state without adding logging statements.

• 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 Cloud Debugger API.
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-debugger-client

Windows

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

Next Steps

• Read the Client Library Documentation for Cloud Debugger API to see other available methods on the client.
• Read the Cloud Debugger API 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.