commit | aff037a2a2f75018dd297e16d4d41f07758cd4cf | [log] [tgz] |
---|---|---|
author | Anthonios Partheniou <partheniou@google.com> | Wed Apr 21 11:00:09 2021 -0400 |
committer | GitHub <noreply@github.com> | Wed Apr 21 15:00:09 2021 +0000 |
tree | 4a87d82b520caab70421e1753ab8601003a806fd | |
parent | ff1e9364e61a7a353827f8e966ea0cbc5e9300c7 [diff] |
chore: add scripts to update discovery artifacts (#1286) These PR add the scripts from #1187 that are needed to update discovery artifacts using a Github action. The scripts will be removed from #1187 once all of the review comments from #1187 have been resolved. This PR adds the following files under the `scripts/` folder - `README.md` to provide instructions on manually updating discovery artifacts and API reference documentation. - `buildprbody.py` creates a summary of the changes detected in discovery artifacts and writes them to `allapis.summary`. - `changesummary.py` creates verbose change information for each API with discovery artifact changes. - `createcommits.sh` creates git commits for each API with discovery artifact changes or reference document changes. - `updatediscoveryartifacts.py` is the python file that can be used to update discovery artifacts. I also moved `describe.py` under the scripts folder and modified it to save the discovery artifacts that are fetched. TODO: - [x] Add tests for scripts - [x] Address review comments in #1187
This is the Google API Python client library for Google's discovery based APIs. To get started, please see the docs folder.
This library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
This library is officially supported by Google. However, the maintainers of this repository recommend using Cloud Client Libraries for Python, where possible, for new code development. For more information, please visit Client Libraries Explained.
The 2.0 release of google-api-python-client
is a significant upgrade compared to v1. Please see the Migration Guide for more information. As a result of caching the discovery documents, the size of this package is at least 50 MB larger compared to the previous version.
See the docs folder for more detailed instructions and additional documentation.
The maintainers of this repository recommend using Cloud Client Libraries for Python, where possible, for new code development due to the following reasons:
With Cloud Client Libraries for Python:
google-api-python-client
is a single client library for all APIs. As a result, the total package size for google-api-python-client
exceeds 50MB.For more information, please visit Client Libraries Explained.
Although there are many benefits to moving to Cloud Client Libraries for Python, the maintainers want to emphasize that google-api-python-client
will continue to be supported.
For Google Ads API, we recommend using Google Ads API Client Library for Python.
For Google Firebase Admin API, we recommend using Firebase Admin Python SDK.
Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.
With virtualenv, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.
pip install virtualenv virtualenv <your-env> source <your-env>/bin/activate <your-env>/bin/pip install google-api-python-client
pip install virtualenv virtualenv <your-env> <your-env>\Scripts\activate <your-env>\Scripts\pip.exe install google-api-python-client
Python 3.6, 3.7, 3.8, and 3.9 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions.
Python < 3.6
The following libraries will be installed when you install the client library:
For development you will also need the following libraries:
Please see our Contribution Guide. In particular, we love pull requests - but please make sure to sign the contributor license agreement.