Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Minor formatting #11632

Merged
merged 8 commits into from
Sep 18, 2023
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion packages/google-cloud-dataproc-metastore/.flake8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-dataproc-metastore/noxfile.py


**********
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-dataproc-metastore/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
27 changes: 14 additions & 13 deletions packages/google-cloud-dataproc-metastore/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
Installation
~~~~~~~~~~~~

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.
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 `virtualenv`_, it's possible to install this library without needing system
With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
.. _`venv`: https://docs.python.org/3/library/venv.html


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

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

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-dataproc-metastore/samples


Supported Python Versions
Expand All @@ -77,21 +80,19 @@ Mac/Linux

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-dataproc-metastore
pip install google-cloud-dataproc-metastore


Windows
^^^^^^^

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-dataproc-metastore
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-dataproc-metastore

Next Steps
~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-dataproc-metastore/docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright 2021 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -550,6 +550,7 @@ async def sample_create_service():
service, which is used as the final
component of the metastore service's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down Expand Up @@ -1182,6 +1183,7 @@ async def sample_create_metadata_import():
Required. The ID of the metadata
import, which is used as the final
component of the metadata import's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down Expand Up @@ -1912,6 +1914,7 @@ async def sample_create_backup():
Required. The ID of the backup, which
is used as the final component of the
backup's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -858,6 +858,7 @@ def sample_create_service():
service, which is used as the final
component of the metastore service's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down Expand Up @@ -1490,6 +1491,7 @@ def sample_create_metadata_import():
Required. The ID of the metadata
import, which is used as the final
component of the metadata import's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down Expand Up @@ -2221,6 +2223,7 @@ def sample_create_backup():
Required. The ID of the backup, which
is used as the final component of the
backup's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -308,6 +308,7 @@ async def sample_list_federations():
Returns:
google.cloud.metastore_v1.services.dataproc_metastore_federation.pagers.ListFederationsAsyncPager:
Response message for ListFederations

Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -543,6 +544,7 @@ async def sample_create_federation():
federation, which is used as the final
component of the metastore federation's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -534,6 +534,7 @@ def sample_list_federations():
Returns:
google.cloud.metastore_v1.services.dataproc_metastore_federation.pagers.ListFederationsPager:
Response message for ListFederations

Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -769,6 +770,7 @@ def sample_create_federation():
federation, which is used as the final
component of the metastore federation's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1263,6 +1263,7 @@ class CreateServiceRequest(proto.Message):
Required. The ID of the metastore service,
which is used as the final component of the
metastore service's name.

This value must be between 2 and 63 characters
long inclusive, begin with a letter, end with a
letter or number, and consist of alpha-numeric
Expand Down Expand Up @@ -1523,6 +1524,7 @@ class CreateMetadataImportRequest(proto.Message):
Required. The ID of the metadata import,
which is used as the final component of the
metadata import's name.

This value must be between 1 and 64 characters
long, begin with a letter, end with a letter or
number, and consist of alpha-numeric ASCII
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,10 @@ class ListFederationsRequest(proto.Message):
Optional. A page token, received from a
previous ListFederationServices call. Provide
this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page
token.

When paginating, other parameters provided to
ListFederationServices must match the call that
provided the page token.
Expand Down Expand Up @@ -326,6 +328,7 @@ class CreateFederationRequest(proto.Message):
Required. The ID of the metastore federation,
which is used as the final component of the
metastore federation's name.

This value must be between 2 and 63 characters
long inclusive, begin with a letter, end with a
letter or number, and consist of alpha-numeric
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -552,6 +552,7 @@ async def sample_create_service():
service, which is used as the final
component of the metastore service's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down Expand Up @@ -1184,6 +1185,7 @@ async def sample_create_metadata_import():
Required. The ID of the metadata
import, which is used as the final
component of the metadata import's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down Expand Up @@ -1914,6 +1916,7 @@ async def sample_create_backup():
Required. The ID of the backup, which
is used as the final component of the
backup's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -880,6 +880,7 @@ def sample_create_service():
service, which is used as the final
component of the metastore service's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down Expand Up @@ -1512,6 +1513,7 @@ def sample_create_metadata_import():
Required. The ID of the metadata
import, which is used as the final
component of the metadata import's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down Expand Up @@ -2243,6 +2245,7 @@ def sample_create_backup():
Required. The ID of the backup, which
is used as the final component of the
backup's name.

This value must be between 1 and 64
characters long, begin with a letter,
end with a letter or number, and consist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -308,6 +308,7 @@ async def sample_list_federations():
Returns:
google.cloud.metastore_v1alpha.services.dataproc_metastore_federation.pagers.ListFederationsAsyncPager:
Response message for ListFederations

Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -543,6 +544,7 @@ async def sample_create_federation():
federation, which is used as the final
component of the metastore federation's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -534,6 +534,7 @@ def sample_list_federations():
Returns:
google.cloud.metastore_v1alpha.services.dataproc_metastore_federation.pagers.ListFederationsPager:
Response message for ListFederations

Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -769,6 +770,7 @@ def sample_create_federation():
federation, which is used as the final
component of the metastore federation's
name.

This value must be between 2 and 63
characters long inclusive, begin with a
letter, end with a letter or number, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Loading