GitHunt
VK

vkedia/google-cloud-python

Google Cloud Client Library for Python

Google Cloud Python Client

Python idiomatic client for `Google Cloud Platform`_ services.

.. _Google Cloud Platform: https://cloud.google.com/

|pypi| |circleci| |appveyor| |coverage| |versions|

  • Homepage_
  • API Documentation_
  • Read The Docs Documentation_

.. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
.. _API Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/
.. _Read The Docs Documentation: https://google-cloud-python.readthedocs.io/en/latest/

.. note::

These libraries currently do not run on Google App Engine Standard.
We are actively working on adding this support.

The following client libraries have GA support:

  • Google Cloud Datastore_ (Datastore README_)
  • Google Cloud Natural Language_ (Natural Language README_)
  • Google Cloud Storage_ (Storage README_)
  • Google Cloud Translation_ (Translation README_)
  • Stackdriver Logging_ (Logging README_)

GA (general availability) indicates that the client library for a
particular service is stable, and that the code surface will not change in
backwards-incompatible ways unless either absolutely necessary (e.g. because
of critical security issues) or with an extensive deprecation period.
Issues and requests against GA libraries are addressed with the highest
priority.

.. note::

Sub-components of GA libraries explicitly marked as beta in the
import path (e.g. ``google.cloud.language_v1beta2``) should be considered
to be beta.

The following client libraries have beta support:

  • Google BigQuery_ (BigQuery README_)
  • Google Cloud Firestore_ (Firestore README_)
  • Google Cloud Pub/Sub_ (Pub/Sub README_)
  • Google Cloud Spanner_ (Spanner README_)
  • Google Cloud Speech_ (Speech README_)
  • Google Cloud Video Intelligence_ (Video Intelligence README_)
  • Google Cloud Vision_ (Vision README_)

Beta indicates that the client library for a particular service is
mostly stable and is being prepared for release. Issues and requests
against beta libraries are addressed with a higher priority.

This client library has alpha support for the following Google
Cloud Platform services:

  • Google BigQuery Data Transfer_ (BigQuery Data Transfer README_)
  • Google Cloud Bigtable_ (Bigtable README_)
  • Google Cloud Bigtable - HappyBase_ (HappyBase README_)
  • Google Cloud Container_ (Container README_)
  • Google Cloud DNS_ (DNS README_)
  • Google Cloud Resource Manager_ (Resource Manager README_)
  • Google Cloud Runtime Configuration_ (Runtime Config README_)
  • Stackdriver Error Reporting_ (Error Reporting README_)
  • Stackdriver Monitoring_ (Monitoring README_)

Alpha indicates that the client library for a particular service is
still a work-in-progress and is more likely to get backwards-incompatible
updates. See versioning_ for more details.

.. _Google Cloud Datastore: https://pypi.org/project/google-cloud-datastore/
.. _Datastore README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/datastore
.. _Google Cloud Storage: https://pypi.org/project/google-cloud-storage/
.. _Storage README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/storage
.. _Google Cloud Pub/Sub: https://pypi.org/project/google-cloud-pubsub/
.. _Pub/Sub README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/pubsub
.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/
.. _BigQuery README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery
.. _Google BigQuery Data Transfer: https://pypi.org/project/google-cloud-bigquery-datatransfer/
.. _BigQuery Data Transfer README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigquery_datatransfer
.. _Google Cloud Container: https://pypi.org/project/google-cloud-container/
.. _Container README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/container
.. _Google Cloud Resource Manager: https://pypi.org/project/google-cloud-resource-manager/
.. _Resource Manager README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/resource_manager
.. _Stackdriver Logging: https://pypi.org/project/google-cloud-logging/
.. _Logging README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/logging
.. _Stackdriver Monitoring: https://pypi.org/project/google-cloud-monitoring/
.. _Monitoring README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/monitoring
.. _Google Cloud Bigtable: https://pypi.org/project/google-cloud-bigtable/
.. _Bigtable README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/bigtable
.. _Google Cloud DNS: https://pypi.org/project/google-cloud-dns/
.. _DNS README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/dns
.. _Stackdriver Error Reporting: https://pypi.org/project/google-cloud-error-reporting/
.. _Error Reporting README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/error_reporting
.. _Google Cloud Natural Language: https://pypi.org/project/google-cloud-language/
.. _Natural Language README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/language
.. _Google Cloud Translation: https://pypi.org/project/google-cloud-translate/
.. _Translation README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/translate
.. _Google Cloud Speech: https://pypi.org/project/google-cloud-speech/
.. _Speech README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/speech
.. _Google Cloud Vision: https://pypi.org/project/google-cloud-vision/
.. _Vision README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/vision
.. _Google Cloud Bigtable - HappyBase: https://pypi.org/project/google-cloud-happybase/
.. _HappyBase README: https://github.com/GoogleCloudPlatform/google-cloud-python-happybase
.. _Google Cloud Runtime Configuration: https://cloud.google.com/deployment-manager/runtime-configurator/
.. _Runtime Config README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/runtimeconfig
.. _Google Cloud Spanner: https://pypi.python.org/pypi/google-cloud-spanner
.. _Spanner README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/spanner
.. _Google Cloud Video Intelligence: https://pypi.python.org/pypi/google-cloud-videointelligence
.. _Video Intelligence README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/videointelligence
.. _versioning: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst#versioning
.. _Google Cloud Firestore: https://pypi.org/project/google-cloud-firestore/
.. _Firestore README: https://github.com/GoogleCloudPlatform/google-cloud-python/tree/master/firestore

If you need support for other Google APIs, check out the
Google APIs Python Client library_.

.. _Google APIs Python Client library: https://github.com/google/google-api-python-client

Quick Start

.. code-block:: console

$ pip install --upgrade google-cloud

For more information on setting up your Python development environment,
such as installing pip and virtualenv on your system, please refer
to Python Development Environment Setup Guide_ for Google Cloud Platform.

.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup

Example Applications

  • getting-started-python_ - A sample and tutorial_ that demonstrates how to build a complete web application using Cloud Datastore, Cloud Storage, and Cloud Pub/Sub and deploy it to Google App Engine or Google Compute Engine.
  • google-cloud-python-expenses-demo_ - A sample expenses demo using Cloud Datastore and Cloud Storage

.. _getting-started-python: https://github.com/GoogleCloudPlatform/getting-started-python
.. _tutorial: https://cloud.google.com/python
.. _google-cloud-python-expenses-demo: https://github.com/GoogleCloudPlatform/google-cloud-python-expenses-demo

Authentication

With google-cloud-python we try to make authentication as painless as possible.
Check out the Authentication section_ in our documentation to learn more.
You may also find the authentication document_ shared by all the
google-cloud-* libraries to be helpful.

.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication

Contributing

Contributions to this library are always welcome and highly encouraged.

See the CONTRIBUTING doc_ for more information on how to get started.

.. _CONTRIBUTING doc: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst

Community

Google Cloud Platform Python developers hang out in Slack_ in the #python
channel, click here to get an invitation_.

.. _Slack: https://googlecloud-community.slack.com
.. _get an invitation: https://gcp-slack.appspot.com/

License

Apache 2.0 - See the LICENSE_ for more information.

.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE

.. |circleci| image:: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python.svg?style=shield
:target: https://circleci.com/gh/GoogleCloudPlatform/google-cloud-python
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/googlecloudplatform/google-cloud-python?branch=master&svg=true
:target: https://ci.appveyor.com/project/GoogleCloudPlatform/google-cloud-python
.. |coverage| image:: https://coveralls.io/repos/GoogleCloudPlatform/google-cloud-python/badge.svg?branch=master
:target: https://coveralls.io/r/GoogleCloudPlatform/google-cloud-python?branch=master
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud.svg
:target: https://pypi.org/project/google-cloud/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud.svg
:target: https://pypi.org/project/google-cloud/

Languages

Python99.9%Shell0.1%Makefile0.0%
Apache License 2.0
Created January 3, 2018
Updated September 28, 2018