NOTE

This github repository is archived. The repository contents and history have moved to google-cloud-python.

Python Client for Container Analysis API

Container Analysis API: is a service that provides vulnerability scanning and metadata storage for software artifacts. The service performs vulnerability scans on built software artifacts, such as the images in Container Registry, then stores the resulting metadata and makes it available for consumption through an API. The metadata may come from several sources, including vulnerability scanning, other Cloud services, and third-party providers.

• 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 Container Analysis 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-containeranalysis

Windows

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

Next Steps

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