Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions .librarian/state.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:39628f6e89c9cad27973b9a39a50f7052bec0435ee58c7027b4fa6b655943e31
image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:c8612d3fffb3f6a32353b2d1abd16b61e87811866f7ec9d65b59b02eb452a620
libraries:
- id: google-ads-admanager
version: 0.6.0
Expand Down Expand Up @@ -272,7 +272,7 @@ libraries:
tag_format: '{id}-v{version}'
- id: google-cloud-access-context-manager
version: 0.3.0
last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd
last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea
apis:
- path: google/identity/accesscontextmanager/v1
service_config: accesscontextmanager_v1.yaml
Expand All @@ -282,7 +282,10 @@ libraries:
- packages/google-cloud-access-context-manager
preserve_regex: []
remove_regex:
- ^packages/google-cloud-access-context-manager/google/.*/.*_pb2\.(?:py|pyi)$/
- ^packages/google-cloud-access-context-manager/google/.*/.*(?:\.proto|_pb2\.(?:py|pyi))$
- .repo-metadata.json
- README.rst
- docs/summary_overview.md
tag_format: '{id}-v{version}'
- id: google-cloud-advisorynotifications
version: 0.4.0
Expand Down Expand Up @@ -566,7 +569,10 @@ libraries:
- packages/google-cloud-audit-log
preserve_regex: []
remove_regex:
- ^packages/google-cloud-audit-log/google/.*/.*_pb2\.(?:py|pyi)$/
- ^packages/google-cloud-audit-log/google/.*/.*(?:\.proto|_pb2\.(?:py|pyi))$
- .repo-metadata.json
- README.rst
- docs/summary_overview.md
tag_format: '{id}-v{version}'
- id: google-cloud-automl
version: 2.17.0
Expand Down Expand Up @@ -4493,7 +4499,7 @@ libraries:
tag_format: '{id}-v{version}'
- id: grafeas
version: 1.16.0
last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd
last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea
apis:
- path: grafeas/v1
service_config: grafeas_v1.yaml
Expand All @@ -4506,21 +4512,24 @@ libraries:
- scripts/client-post-processing
- samples/snippets/README.rst
- tests/system
- grafeas/grafeas.py
- grafeas/grafeas/__init__.py
- grafeas/grafeas\.py
- ^packages/grafeas/grafeas/__init__.py
- grafeas/grafeas/grafeas_v1/types.py
remove_regex:
- packages/grafeas
tag_format: '{id}-v{version}'
- id: grpc-google-iam-v1
version: 0.14.2
last_generated_commit: 55319b058f8a0e46bbeeff30e374e4b1f081f494
last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea
apis:
- path: google/iam/v1
service_config: iam_meta_api.yaml
source_roots:
- packages/grpc-google-iam-v1/
preserve_regex: []
remove_regex:
- ^packages/grpc-google-iam-v1/google/.*/.*_pb2\.(?:py|pyi)$/
- ^packages/grpc-google-iam-v1/google/iam/v1/[^/]*(?:\.proto|_pb2\.(?:py|pyi))$
- .repo-metadata.json
- README.rst
- docs/summary_overview.md
tag_format: '{id}-v{version}'

This file was deleted.

197 changes: 197 additions & 0 deletions packages/google-cloud-access-context-manager/docs/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
Python Client for Access Context Manager
========================================

|preview| |pypi| |versions|

`Access Context Manager`_:

- `Client Library Documentation`_
- `Product Documentation`_

.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-access-context-manager.svg
:target: https://pypi.org/project/google-cloud-access-context-manager/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-access-context-manager.svg
:target: https://pypi.org/project/google-cloud-access-context-manager/
.. _Access Context Manager: https://cloud.google.com/access-context-manager/docs/overview
.. _Client Library Documentation: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-access-context-manager
.. _Product Documentation: https://cloud.google.com/access-context-manager/docs/overview

Quick Start
-----------

In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Access Context Manager.`_
4. `Set up Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Access Context Manager.: https://cloud.google.com/access-context-manager/docs/overview
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~

Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.

With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`venv`: https://docs.python.org/3/library/venv.html


Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~

Code samples and snippets live in the `samples/`_ folder.

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-access-context-manager/samples


Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
Python.

Python >= 3.7, including 3.14

.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches

Unsupported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python <= 3.6

If you are using an `end-of-life`_
version of Python, we recommend that you update as soon as possible to an actively supported version.

.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches

Mac/Linux
^^^^^^^^^

.. code-block:: console

python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-access-context-manager


Windows
^^^^^^^

.. code-block:: console

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-access-context-manager

Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Access Context Manager
to see other available methods on the client.
- Read the `Access Context Manager Product documentation`_ to learn
more about the product and see How-to Guides.
- View this `README`_ to see the full list of Cloud
APIs that we cover.

.. _Access Context Manager Product documentation: https://cloud.google.com/access-context-manager/docs/overview
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

Logging
-------

This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
Note the following:

#. 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.
#. 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**.
#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.

Simple, environment-based configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To 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
logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
event.

A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.

- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
- Invalid logging scopes: :code:`foo`, :code:`123`, etc.

**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.

Environment-Based Examples
^^^^^^^^^^^^^^^^^^^^^^^^^^

- Enabling the default handler for all Google-based loggers

.. code-block:: console

export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google

- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):

.. code-block:: console

export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1


Advanced, code-based configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also configure a valid logging scope using Python's standard `logging` mechanism.

Code-Based Examples
^^^^^^^^^^^^^^^^^^^

- Configuring a handler for all Google-based loggers

.. code-block:: python

import logging

from google.cloud import library_v1

base_logger = logging.getLogger("google")
base_logger.addHandler(logging.StreamHandler())
base_logger.setLevel(logging.DEBUG)

- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):

.. code-block:: python

import logging

from google.cloud import library_v1

base_logger = logging.getLogger("google.cloud.library_v1")
base_logger.addHandler(logging.StreamHandler())
base_logger.setLevel(logging.DEBUG)

Logging details
~~~~~~~~~~~~~~~

#. 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
logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
:code:`logging.getLogger("google").propagate = True` in your code.
#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
one library, but decide you need to also set up environment-based logging configuration for another library.

#. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
if the code -based configuration gets applied first.

#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
(This is the reason for 2.i. above.)
1 change: 0 additions & 1 deletion packages/google-cloud-audit-log/docs/README.rst

This file was deleted.

Loading
Loading