| Name | gcp-pilot JSON |
| Version |
1.38.0
JSON |
| download |
| home_page | None |
| Summary | Google Cloud Platform Friendly Pilot |
| upload_time | 2025-08-26 07:47:34 |
| maintainer | Rodolfo Stangherlin, Diego Freire, Guilherme Araujo, Lucas Gomide |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
firestore orm
gcp
google cloud python
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](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).
Raw data
{
"_id": null,
"home_page": null,
"name": "gcp-pilot",
"maintainer": "Rodolfo Stangherlin, Diego Freire, Guilherme Araujo, Lucas Gomide",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "firestore orm, gcp, google cloud python",
"author": null,
"author_email": "Joao Daher <joao@daher.dev>",
"download_url": "https://files.pythonhosted.org/packages/a3/a5/71a041ce7387adc9e47c111a1835f5263572742e65a677693b13e5348691/gcp_pilot-1.38.0.tar.gz",
"platform": null,
"description": "\n\n\n[](https://qlty.sh/gh/flamingo-run/projects/gcp-pilot)\n[](https://qlty.sh/gh/flamingo-run/projects/gcp-pilot)\n\n[]() []() []()\n\n# Google Cloud Pilot\n\nGoogle 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.\n\n## Documentation\n\n**Full documentation is available at [gcp-pilot.flamingo.codes](https://gcp-pilot.flamingo.codes)**\n\n## Installation\n\n```bash\npip install gcp-pilot\n```\n\nSome APIs need extra packages, thus you must use `extras` to add them:\n\n- Cloud Tasks: `pip install gcp-pilot[tasks]`\n- Cloud Build: `pip install gcp-pilot[build]`\n- Cloud Storage: `pip install gcp-pilot[storage]`\n- Big Query: `pip install gcp-pilot[bigquery]`\n- Speech: `pip install gcp-pilot[speech]`\n- Sheets: `pip install gcp-pilot[sheets]`\n- Pub/Sub: `pip install gcp-pilot[pubsub]`\n- Datastore: `pip install gcp-pilot[datastore]`\n- Firestore: `pip install gcp-pilot[firestore]`\n- Cloud DNS: `pip install gcp-pilot[dns]`\n- Secret Manager: `pip install gcp-pilot[secret]`\n- Healthcare Engine: `pip install gcp-pilot[healthcare]`\n- IAM: `pip install gcp-pilot[iam]`\n\n## Basic Usage\n\n```python\nfrom gcp_pilot.resource import ResourceManager\n\ngrm = ResourceManager()\n```\n\n## Key Features\n\n- **Parameter Fallback**: Automatically detects project_id and location based on your credentials\n- **Friendly Errors**: Converts generic HttpExceptions into more specific exceptions like NotFound, AlreadyExists, etc.\n- **Auto-Authorization**: Sets up required permissions for services that need specific authorizations\n- **Integration**: Seamlessly integrates different GCP services\n- **Authentication Handling**: Uses Application Default Credentials with support for impersonation and delegation\n\n### Firestore ORM\n\nA powerful and intuitive Object-Relational Mapper (ORM) for Google Firestore.\n\n- **Model-Based Structure**: Define your Firestore collections and documents as Python classes.\n- **Intuitive Querying**: Build complex queries using a chained, Django-like syntax.\n- **Built-in Pagination**: Easily paginate through large datasets.\n- **Atomic Operations**: Support for transactions to ensure data consistency.\n- **Subcollections**: Seamlessly work with nested data structures.\n\nYou can read more at the [Firestore ORM Documentation](https://gcp-pilot.flamingo.codes/services/firestore).\n\n## Supported Services\n\ngcp-pilot supports a wide range of Google Cloud Platform services, including:\n\n- IAM and Identity Management\n- Storage and Databases (Cloud Storage, BigQuery, Datastore, Firestore, etc.)\n- Compute and Serverless (Cloud Functions, Cloud Run, App Engine)\n- Messaging and Integration (Pub/Sub, Cloud Tasks, Cloud Scheduler)\n- DevOps and CI/CD (Cloud Build, Source Repositories)\n- Monitoring and Logging\n- Google Workspace Integration (Directory, Calendar, Sheets, etc.)\n\nFor detailed documentation on each service, please refer to the [documentation site](https://github.com/flamingo-run/gcp-pilot/tree/main/docs).\n",
"bugtrack_url": null,
"license": null,
"summary": "Google Cloud Platform Friendly Pilot",
"version": "1.38.0",
"project_urls": null,
"split_keywords": [
"firestore orm",
" gcp",
" google cloud python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b1e5e4d774f6b390d015194643d6de41144fda6913e47ae03af4afe8efad381b",
"md5": "03a91138eef8b323ec5f318849f6dc61",
"sha256": "1552240ecb170ddaeb3da76384c0fa3d129c940810d9aee21ec7a21746d09bdb"
},
"downloads": -1,
"filename": "gcp_pilot-1.38.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03a91138eef8b323ec5f318849f6dc61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 81535,
"upload_time": "2025-08-26T07:47:32",
"upload_time_iso_8601": "2025-08-26T07:47:32.442131Z",
"url": "https://files.pythonhosted.org/packages/b1/e5/e4d774f6b390d015194643d6de41144fda6913e47ae03af4afe8efad381b/gcp_pilot-1.38.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a3a571a041ce7387adc9e47c111a1835f5263572742e65a677693b13e5348691",
"md5": "0ff88b6db22558d24938dd9cc5839824",
"sha256": "4534c236d34e9dc369c501ebf88c969bb61e090fd034bf53a84d6f85a4aff7d4"
},
"downloads": -1,
"filename": "gcp_pilot-1.38.0.tar.gz",
"has_sig": false,
"md5_digest": "0ff88b6db22558d24938dd9cc5839824",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 189179,
"upload_time": "2025-08-26T07:47:34",
"upload_time_iso_8601": "2025-08-26T07:47:34.034484Z",
"url": "https://files.pythonhosted.org/packages/a3/a5/71a041ce7387adc9e47c111a1835f5263572742e65a677693b13e5348691/gcp_pilot-1.38.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 07:47:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gcp-pilot"
}
