{"author":"Google LLC","author_email":"googleapis-packages@google.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Internet"],"description":"Python Client for AlloyDB\n=========================\n\n|preview| |pypi| |versions|\n\n`AlloyDB`_: \n\n- `Client Library Documentation`_\n- `Product Documentation`_\n\n.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg\n :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels\n.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-alloydb.svg\n :target: https://pypi.org/project/google-cloud-alloydb/\n.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-alloydb.svg\n :target: https://pypi.org/project/google-cloud-alloydb/\n.. _AlloyDB: https://cloud.google.com/alloydb/\n.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/alloydb/latest/summary_overview\n.. _Product Documentation: https://cloud.google.com/alloydb/\n\nQuick Start\n-----------\n\nIn order to use this library, you first need to go through the following steps:\n\n1. `Select or create a Cloud Platform project.`_\n2. `Enable billing for your project.`_\n3. `Enable the AlloyDB.`_\n4. `Set up Authentication.`_\n\n.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project\n.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project\n.. _Enable the AlloyDB.: https://cloud.google.com/alloydb/\n.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html\n\nInstallation\n~~~~~~~~~~~~\n\nInstall this library in a virtual environment using `venv`_. `venv`_ is a tool that\ncreates isolated Python environments. These isolated environments can have separate\nversions of Python packages, which allows you to isolate one project's dependencies\nfrom the dependencies of other projects.\n\nWith `venv`_, it's possible to install this library without needing system\ninstall permissions, and without clashing with the installed system\ndependencies.\n\n.. _`venv`: https://docs.python.org/3/library/venv.html\n\n\nCode samples and snippets\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCode samples and snippets live in the `samples/`_ folder.\n\n.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-alloydb/samples\n\n\nSupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^\nOur client libraries are compatible with all current `active`_ and `maintenance`_ versions of\nPython.\n\nPython >= 3.7\n\n.. _active: https://devguide.python.org/devcycle/#in-development-main-branch\n.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches\n\nUnsupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\nPython <= 3.6\n\nIf you are using an `end-of-life`_\nversion of Python, we recommend that you update as soon as possible to an actively supported version.\n\n.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches\n\nMac/Linux\n^^^^^^^^^\n\n.. code-block:: console\n\n python3 -m venv \n source /bin/activate\n pip install google-cloud-alloydb\n\n\nWindows\n^^^^^^^\n\n.. code-block:: console\n\n py -m venv \n .\\\\Scripts\\activate\n pip install google-cloud-alloydb\n\nNext Steps\n~~~~~~~~~~\n\n- Read the `Client Library Documentation`_ for AlloyDB\n to see other available methods on the client.\n- Read the `AlloyDB Product documentation`_ to learn\n more about the product and see How-to Guides.\n- View this `README`_ to see the full list of Cloud\n APIs that we cover.\n\n.. _AlloyDB Product documentation: https://cloud.google.com/alloydb/\n.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst\n\nLogging\n-------\n\nThis library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.\nNote the following:\n\n#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.\n#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.\n#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.\n\nSimple, environment-based configuration\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google\nlogging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged\nmessages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging\nevent.\n\nA logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.\n\n- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.\n- Invalid logging scopes: :code:`foo`, :code:`123`, etc.\n\n**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.\n\nEnvironment-Based Examples\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n- Enabling the default handler for all Google-based loggers\n\n.. code-block:: console\n\n export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google\n\n- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):\n\n.. code-block:: console\n\n export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1\n\n\nAdvanced, code-based configuration\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can also configure a valid logging scope using Python's standard `logging` mechanism.\n\nCode-Based Examples\n^^^^^^^^^^^^^^^^^^^\n\n- Configuring a handler for all Google-based loggers\n\n.. code-block:: python\n\n import logging\n \n from google.cloud import library_v1\n \n base_logger = logging.getLogger(\"google\")\n base_logger.addHandler(logging.StreamHandler())\n base_logger.setLevel(logging.DEBUG)\n\n- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):\n\n.. code-block:: python\n\n import logging\n \n from google.cloud import library_v1\n \n base_logger = logging.getLogger(\"google.cloud.library_v1\")\n base_logger.addHandler(logging.StreamHandler())\n base_logger.setLevel(logging.DEBUG)\n\nLogging details\n~~~~~~~~~~~~~~~\n\n#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root\n logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set\n :code:`logging.getLogger(\"google\").propagate = True` in your code.\n#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for\n one library, but decide you need to also set up environment-based logging configuration for another library.\n\n #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual\n if the code -based configuration gets applied first.\n\n#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get\n executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.\n (This is the reason for 2.i. above.)\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-alloydb","keywords":null,"license":"Apache 2.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"google-cloud-alloydb","package_url":"https://pypi.org/project/google-cloud-alloydb/","platform":"Posix; MacOS X; Windows","project_url":"https://pypi.org/project/google-cloud-alloydb/","project_urls":{"Homepage":"https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-alloydb"},"provides_extra":null,"release_url":"https://pypi.org/project/google-cloud-alloydb/0.4.6/","requires_dist":["google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.0,>=1.34.1","google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1","proto-plus<2.0.0,>=1.22.3","protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2","grpc-google-iam-v1<1.0.0,>=0.14.0","proto-plus<2.0.0,>=1.25.0; python_version >= \"3.13\""],"requires_python":">=3.7","summary":"Google Cloud Alloydb API client library","version":"0.4.6","yanked":false,"yanked_reason":null}

Dependency	Optional
google-api-core	false
google-auth	false
grpc-google-iam-v1	false
proto-plus	false
protobuf	false

Package search

google-cloud-alloydb

project_urls

Dependencies

All package metadata

Releases