Grafeas API Client Library for Python

Common errors

• ModuleNotFoundError: No module named 'grafeas'

  cause The `grafeas` package is not installed in your current Python environment, or there's a typo in the import statement, or your Python environment's path is incorrectly configured.
  fix Run `pip install grafeas` to install the library. Double-check the spelling of 'grafeas' in your `import` statements. If using a virtual environment, ensure it is activated.

• google.api_core.exceptions.PermissionDenied: 403 Permission denied on resource project projects/your-project-id

  cause The authenticated identity (service account or user) does not have the necessary IAM permissions to access Grafeas resources in the specified project. This often happens if the 'Grafeas Viewer' or 'Grafeas Editor' role is missing.
  fix Grant the appropriate IAM role (e.g., `roles/containeranalysis.viewer` for read-only, `roles/containeranalysis.editor` for read/write) to the service account or user interacting with Grafeas on the Google Cloud project.

• AttributeError: module 'grafeas' has no attribute 'GrafeasClient'

  cause This usually indicates that you are trying to import `GrafeasClient` directly from the top-level `grafeas` package, or you are using an outdated import pattern from a pre-1.0.0 version of the library.
  fix Update your import statement to `from grafeas import grafeas_v1` and then instantiate the client using `client = grafeas_v1.GrafeasClient()`. For asynchronous operations, use `grafeas_v1.GrafeasAsyncClient()`.

Warnings

• breaking The `grafeas` library underwent significant breaking changes in version 1.0.0 due to a complete regeneration using Google's microgenerator. This resulted in a change to the client surface and package structure compared to older versions (e.g., `grafeas<1.0.0`).
  Fix: Upgrade to `grafeas>=1.0.0` and update import paths and client instantiation as per the latest documentation, typically using `from grafeas import grafeas_v1`.
• breaking Support for older Python versions (Python <= 3.8) has been dropped. If you are using an unsupported Python version, you may encounter installation or runtime errors.
  Fix: Upgrade your Python environment to version 3.9 or higher. For Python 2.7, the last compatible version was `grafeas==0.4.1`.
• gotcha Incorrect or missing authentication setup is a common issue when using Google Cloud client libraries. Without proper authentication, API calls will result in `Unauthorized` errors.
  Fix: Ensure that `GOOGLE_APPLICATION_CREDENTIALS` environment variable points to a valid service account key file, or that your execution environment (e.g., GCE, Cloud Run, Cloud Functions) has appropriate service account permissions. Alternatively, provide credentials explicitly during client instantiation.

Install

• pip install grafeas Install stable version

Imports

• GrafeasClient

  from grafeas import grafeas_v1
  client = grafeas_v1.GrafeasClient()

  The primary synchronous client for interacting with the Grafeas API.
• GrafeasAsyncClient

  from grafeas import grafeas_v1
  client = grafeas_v1.GrafeasAsyncClient()

  The asynchronous client for non-blocking operations.

Quickstart

This quickstart demonstrates how to instantiate the Grafeas client and list all notes within a specified Google Cloud project. Ensure your `GOOGLE_CLOUD_PROJECT` environment variable is set or replace `'your-project-id'` with your actual project ID. Authentication is handled implicitly if `GOOGLE_APPLICATION_CREDENTIALS` is set or if running in a Google Cloud environment.

import os
from grafeas import grafeas_v1

# Your Google Cloud Project ID
project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', 'your-project-id')

def list_all_notes(project_id):
    """Lists all notes in a given project."""
    client = grafeas_v1.GrafeasClient()
    parent = f"projects/{project_id}"
    
    print(f"Listing notes for project: {project_id}")
    try:
        for note in client.list_notes(parent=parent):
            print(f"  Note: {note.name} (Kind: {note.kind.name})")
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == '__main__':
    list_all_notes(project_id)