# GCP Python Client Functions
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Installation
Launch a terminal and install by entering:
``` sh
conda install gcp_python_client_functions
```
…or
``` sh
pip install gcp_python_client_functions
```
## Usage Prerequisites
### 1. GCP environment
- Create a GCP project by going to the [Resource
Manager](https://console.cloud.google.com/project?_ga=2.198902124.2143434848.1693760593-97706481.1691864848)
page in the cloud console ([cloud resources naming
convention](https://stepan.wtf/cloud-naming-convention/#:~:text=The%20rule%20of%20thumb%20is,or%20within%20a%20given%20scope.)).
- Enable billing for the project you’ll work with by going to the [Cloud
Billing](https://console.cloud.google.com/billing/) page and selecting
your project on the top right corner (300 USD free credits are
associated with new billing accounts + a [big list of free tier
products](https://cloud.google.com/free?_ga=2.49992806.-1313173218.1693453955)).
- Enable BigQuery API by going to [APIs &
Services](https://console.cloud.google.com/apis/) page on the cloud
console and looking for the BigQuery API.
### 2. Authentication
[Authenticating](https://googleapis.dev/python/google-api-core/latest/auth.html)
by… - (locally) using the [Google Cloud
SDK](http://cloud.google.com/sdk)(installation needed). Launch a
terminal enter:
``` sh
gcloud auth login --update-adc
```
- (elsewhere) [downloading a service account JSON
keyfile](https://cloud.google.com/iam/docs/keys-create-delete#creating)
and point to it using an environment variable:
``` sh
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/keyfile.json"
```
- or through [Workflow Identity
Provider](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform)
(what we used to authenticate within GitHub Actions, see [Cloud
Advocate’s video](https://www.youtube.com/watch?v=zRF5uTWXV8Y) and
[stackoverflow
question](https://stackoverflow.com/questions/75573270/github-action-doesnt-work-with-gcp-403-permission-iam-serviceaccounts-getacc)
for additional support).
## How to use
``` python
from gcp_python_client_functions.clients import *
PROJECT_ID = 'dz-learning-d'
# BigQuery
bq_obj = BigQuery(PROJECT_ID)
# Cloud Storage
stg_obj = Storage(PROJECT_ID)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/datasciencedani/gcp-python-client-functions",
"name": "gcp-python-client-functions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python google api bigquery storage",
"author": "Daniela Zamora",
"author_email": "danizhorta24@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bf/af/9b4ce83f85009dc4fd020e03d7a54929add9cd5176e1d73e8b8949932080/gcp-python-client-functions-0.0.1.tar.gz",
"platform": null,
"description": "# GCP Python Client Functions\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Installation\n\nLaunch a terminal and install by entering:\n\n``` sh\nconda install gcp_python_client_functions\n```\n\n\u2026or\n\n``` sh\npip install gcp_python_client_functions\n```\n\n## Usage Prerequisites\n\n### 1. GCP environment\n\n- Create a GCP project by going to the [Resource\n Manager](https://console.cloud.google.com/project?_ga=2.198902124.2143434848.1693760593-97706481.1691864848)\n page in the cloud console ([cloud resources naming\n convention](https://stepan.wtf/cloud-naming-convention/#:~:text=The%20rule%20of%20thumb%20is,or%20within%20a%20given%20scope.)).\n- Enable billing for the project you\u2019ll work with by going to the [Cloud\n Billing](https://console.cloud.google.com/billing/) page and selecting\n your project on the top right corner (300 USD free credits are\n associated with new billing accounts + a [big list of free tier\n products](https://cloud.google.com/free?_ga=2.49992806.-1313173218.1693453955)).\n- Enable BigQuery API by going to [APIs &\n Services](https://console.cloud.google.com/apis/) page on the cloud\n console and looking for the BigQuery API.\n\n### 2. Authentication\n\n[Authenticating](https://googleapis.dev/python/google-api-core/latest/auth.html)\nby\u2026 - (locally) using the [Google Cloud\nSDK](http://cloud.google.com/sdk)(installation needed). Launch a\nterminal enter:\n\n``` sh\ngcloud auth login --update-adc\n```\n\n- (elsewhere) [downloading a service account JSON\n keyfile](https://cloud.google.com/iam/docs/keys-create-delete#creating)\n and point to it using an environment variable:\n\n``` sh\nexport GOOGLE_APPLICATION_CREDENTIALS=\"/path/to/keyfile.json\"\n```\n\n- or through [Workflow Identity\n Provider](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform)\n (what we used to authenticate within GitHub Actions, see [Cloud\n Advocate\u2019s video](https://www.youtube.com/watch?v=zRF5uTWXV8Y) and\n [stackoverflow\n question](https://stackoverflow.com/questions/75573270/github-action-doesnt-work-with-gcp-403-permission-iam-serviceaccounts-getacc)\n for additional support).\n\n## How to use\n\n``` python\nfrom gcp_python_client_functions.clients import *\n\nPROJECT_ID = 'dz-learning-d'\n\n# BigQuery\nbq_obj = BigQuery(PROJECT_ID)\n\n# Cloud Storage\nstg_obj = Storage(PROJECT_ID)\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "One package that will handle the installation and client generation for the most used GCP Python Client Libraries + methods that avoid repetitive processes.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/datasciencedani/gcp-python-client-functions"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"google",
"api",
"bigquery",
"storage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0056d6a21ad98843a27cbae583fa7932bf55f742b8ad3826356ef65f9025e52d",
"md5": "c71a8e1556f2a6d10ff1c9f731e6b2f9",
"sha256": "c6e2f387f79b1ebb37354c9fa22a495cd8b5015395a1e3749ef208fa0ee055fd"
},
"downloads": -1,
"filename": "gcp_python_client_functions-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c71a8e1556f2a6d10ff1c9f731e6b2f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9425,
"upload_time": "2023-09-05T08:42:10",
"upload_time_iso_8601": "2023-09-05T08:42:10.329986Z",
"url": "https://files.pythonhosted.org/packages/00/56/d6a21ad98843a27cbae583fa7932bf55f742b8ad3826356ef65f9025e52d/gcp_python_client_functions-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfaf9b4ce83f85009dc4fd020e03d7a54929add9cd5176e1d73e8b8949932080",
"md5": "253070e554981e2186aeacff8e85c5d9",
"sha256": "d437a6e00af8d073f2822011bed9582461ec9302f00c43cb43e1172d48b9d63b"
},
"downloads": -1,
"filename": "gcp-python-client-functions-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "253070e554981e2186aeacff8e85c5d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9614,
"upload_time": "2023-09-05T08:42:11",
"upload_time_iso_8601": "2023-09-05T08:42:11.587621Z",
"url": "https://files.pythonhosted.org/packages/bf/af/9b4ce83f85009dc4fd020e03d7a54929add9cd5176e1d73e8b8949932080/gcp-python-client-functions-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-05 08:42:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "datasciencedani",
"github_project": "gcp-python-client-functions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gcp-python-client-functions"
}
JSON
