gcp-pilot 1.36.0

Google Cloud Platform Friendly Pilot

Google Cloud Pilot

Google Cloud Pilot (gcp-pilot) is a Python library that simplifies interaction with Google Cloud Platform services. It provides a high-level, user-friendly interface to various GCP APIs, handling authentication, error management, and parameter fallback automatically.

Documentation

Full documentation is available at gcp-pilot.flamingo.codes

Installation

pip install gcp-pilot

Some APIs need extra packages, thus you must use extras to add them:

• Cloud Tasks: pip install gcp-pilot[tasks]
• Cloud Build: pip install gcp-pilot[build]
• Cloud Storage: pip install gcp-pilot[storage]
• Big Query: pip install gcp-pilot[bigquery]
• Speech: pip install gcp-pilot[speech]
• Sheets: pip install gcp-pilot[sheets]
• Pub/Sub: pip install gcp-pilot[pubsub]
• Datastore: pip install gcp-pilot[datastore]
• Firestore: pip install gcp-pilot[firestore]
• Cloud DNS: pip install gcp-pilot[dns]
• Secret Manager: pip install gcp-pilot[secret]
• Healthcare Engine: pip install gcp-pilot[healthcare]
• IAM: pip install gcp-pilot[iam]

Basic Usage

from gcp_pilot.resource import ResourceManager

grm = ResourceManager()

Key Features

• Parameter Fallback: Automatically detects project_id and location based on your credentials
• Friendly Errors: Converts generic HttpExceptions into more specific exceptions like NotFound, AlreadyExists, etc.
• Auto-Authorization: Sets up required permissions for services that need specific authorizations
• Integration: Seamlessly integrates different GCP services
• Authentication Handling: Uses Application Default Credentials with support for impersonation and delegation

Firestore ORM

A powerful and intuitive Object-Relational Mapper (ORM) for Google Firestore.

• Model-Based Structure: Define your Firestore collections and documents as Python classes.
• Intuitive Querying: Build complex queries using a chained, Django-like syntax.
• Built-in Pagination: Easily paginate through large datasets.
• Atomic Operations: Support for transactions to ensure data consistency.
• Subcollections: Seamlessly work with nested data structures.

You can read more at the Firestore ORM Documentation.

Supported Services

gcp-pilot supports a wide range of Google Cloud Platform services, including:

• IAM and Identity Management
• Storage and Databases (Cloud Storage, BigQuery, Datastore, Firestore, etc.)
• Compute and Serverless (Cloud Functions, Cloud Run, App Engine)
• Messaging and Integration (Pub/Sub, Cloud Tasks, Cloud Scheduler)
• DevOps and CI/CD (Cloud Build, Source Repositories)
• Monitoring and Logging
• Google Workspace Integration (Directory, Calendar, Sheets, etc.)

For detailed documentation on each service, please refer to the documentation site.