# gPS Solutions - Python Library Repository
**This is not an official Google product.**
This repository contains modules and tools useful for use with advanced data
solutions on Google Ads, Google Marketing Platform and Google Cloud. It is
maintained by a team of Customer Solutions Engineers (CSE) and Data Scientists
(DS) working within Google's Technical Solutions (gTech) Professional Services
organization (gPS).
Contributions are highly encouraged; see [CONTRIBUTING.md](../CONTRIBUTING.md).
## Installation
### For Consumers
Install via pip:
```
pip install gps-building-blocks
```
### For Contributors
The following assumes you have successfully created and started a clean
virtual environment. For more information, see the documentation for
[`venv`](https://docs.python.org/3/library/venv.html).
Install dependencies via pip:
```sh
#in gps_building_blocks root folder in the GitHub repo, clean virtualenv
cd py
pip install -r requirements.txt
```
#### Package Dependency Management
IMPORTANT: Please verify that you update any external dependencies on
[```setup.py```](setup.py). [```requirements.txt```](requirements.txt) should be
generated from `setup.py` and _not_ edited manually. See instructions below.
[```setup.py```](setup.py) and [```requirements.txt```](requirements.txt) both
contain a list of dependencies. Both of these list serve a similar purpose, but
differ in a fundamental way. Basically, `setup.py` is used for dependency
management during deployment, and `requirements.txt` is used for development.
`setup.py` is edited manually and `requirements.txt` is automatically generated
from the contents of `setup.py` using `pip-compile`
- `setup.py`: When the user executes `pip install gps-building-blocks`,
this package and all packages listed in setuptools.install_requires()` will
be installed. This list should not include any libraries needed for
development, and version requirements should generally be as generic as
possible to reduce the chance that the end user is installing multiple
versions of the same libraries.
- `requirements.txt`: When the user executes `pip install -r requirements.txt`,
all packages listed in the file will be installed. This command is generally
used when the user has cloned the project and is planning to modify it.
Therefore, `requirements.txt` should include all packages that are necessary
to develop and test your code. Version requirements can be as strict as
necessary.
##### Updating dependencies
If need to import a new package or update a dependency:
1. Add it to [```setup.py```](setup.py).
* Make sure you pin your dependency to a particular version to ensure
replicable builds. E.g.: `package_name==1.2.3`.
1. Run
`pip-compile --allow-unsafe --generate-hashes --resolver=backtracking` to update
[```requirements.txt```](requirements.txt).
1. Test your code and submit the changes on both files.
Raw data
{
"_id": null,
"home_page": "https://github.com/google/gps_building_blocks",
"name": "gps-building-blocks",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "gPS Team",
"author_email": "no-reply@google.com",
"download_url": null,
"platform": null,
"description": "# gPS Solutions - Python Library Repository\n\n**This is not an official Google product.**\n\nThis repository contains modules and tools useful for use with advanced data\nsolutions on Google Ads, Google Marketing Platform and Google Cloud. It is\nmaintained by a team of Customer Solutions Engineers (CSE) and Data Scientists\n(DS) working within Google's Technical Solutions (gTech) Professional Services\norganization (gPS).\n\nContributions are highly encouraged; see [CONTRIBUTING.md](../CONTRIBUTING.md).\n\n## Installation\n\n### For Consumers\n\nInstall via pip:\n\n```\npip install gps-building-blocks\n```\n\n### For Contributors\n\nThe following assumes you have successfully created and started a clean\nvirtual environment. For more information, see the documentation for\n[`venv`](https://docs.python.org/3/library/venv.html).\n\nInstall dependencies via pip:\n\n```sh\n#in gps_building_blocks root folder in the GitHub repo, clean virtualenv\n\ncd py\npip install -r requirements.txt\n```\n\n#### Package Dependency Management\n\nIMPORTANT: Please verify that you update any external dependencies on \n[```setup.py```](setup.py). [```requirements.txt```](requirements.txt) should be\ngenerated from `setup.py` and _not_ edited manually. See instructions below.\n\n[```setup.py```](setup.py) and [```requirements.txt```](requirements.txt) both\ncontain a list of dependencies. Both of these list serve a similar purpose, but\ndiffer in a fundamental way. Basically, `setup.py` is used for dependency\nmanagement during deployment, and `requirements.txt` is used for development.\n`setup.py` is edited manually and `requirements.txt` is automatically generated\nfrom the contents of `setup.py` using `pip-compile`\n\n- `setup.py`: When the user executes `pip install gps-building-blocks`,\n this package and all packages listed in setuptools.install_requires()` will\n be installed. This list should not include any libraries needed for\n development, and version requirements should generally be as generic as\n possible to reduce the chance that the end user is installing multiple\n versions of the same libraries.\n- `requirements.txt`: When the user executes `pip install -r requirements.txt`,\n all packages listed in the file will be installed. This command is generally\n used when the user has cloned the project and is planning to modify it.\n Therefore, `requirements.txt` should include all packages that are necessary\n to develop and test your code. Version requirements can be as strict as\n necessary.\n\n##### Updating dependencies\nIf need to import a new package or update a dependency:\n\n 1. Add it to [```setup.py```](setup.py).\n * Make sure you pin your dependency to a particular version to ensure\n replicable builds. E.g.: `package_name==1.2.3`.\n 1. Run \n`pip-compile --allow-unsafe --generate-hashes --resolver=backtracking` to update\n[```requirements.txt```](requirements.txt).\n 1. Test your code and submit the changes on both files.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Modules and tools useful for use with advanced data solutions on Google Ads, Google Marketing Platform and Google Cloud.",
"version": "1.159.0",
"project_urls": {
"Homepage": "https://github.com/google/gps_building_blocks"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07509504893e0caa242c1036b85b03a8cf995301aee07d8e0a116297912d467c",
"md5": "46c6f32b13ea1f17e70517f7c65de60c",
"sha256": "f91750e9cc9b59e55c9f9f748de5e5fb65f443322c45da71b5e45a844be16c2c"
},
"downloads": -1,
"filename": "gps_building_blocks-1.159.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46c6f32b13ea1f17e70517f7c65de60c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 322477,
"upload_time": "2024-04-15T13:19:47",
"upload_time_iso_8601": "2024-04-15T13:19:47.297558Z",
"url": "https://files.pythonhosted.org/packages/07/50/9504893e0caa242c1036b85b03a8cf995301aee07d8e0a116297912d467c/gps_building_blocks-1.159.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 13:19:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "google",
"github_project": "gps_building_blocks",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gps-building-blocks"
}
JSON
