https://github.com/flamingo-run/gcp-pilot
https://github.com/flamingo-run/gcp-pilot
api bigquery calendar cloud-scheduler cloud-tasks gcs google google-cloud-platform pubsub sheets speech
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flamingo-run/gcp-pilot
- Owner: flamingo-run
- License: apache-2.0
- Created: 2020-12-11T12:11:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-08-22T15:49:59.000Z (10 months ago)
- Last Synced: 2025-08-22T17:55:00.988Z (10 months ago)
- Topics: api, bigquery, calendar, cloud-scheduler, cloud-tasks, gcs, google, google-cloud-platform, pubsub, sheets, speech
- Language: Python
- Size: 3.09 MB
- Stars: 21
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://qlty.sh/gh/flamingo-run/projects/gcp-pilot)
[](https://qlty.sh/gh/flamingo-run/projects/gcp-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](https://gcp-pilot.flamingo.codes)**
## Installation
```bash
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
```python
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](https://gcp-pilot.flamingo.codes/services/firestore).
## 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](https://github.com/flamingo-run/gcp-pilot/tree/main/docs).