Skip to content

Commit f0e6faf

Browse files
1 parent ab321e3 commit f0e6faf

File tree

63 files changed

+3262
-1776
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+3262
-1776
lines changed

‎owl-bot-staging/google-cloud-locationfinder/v1/docs/index.rst‎

Lines changed: 0 additions & 10 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog
File renamed without changes.
File renamed without changes.

owl-bot-staging/google-cloud-locationfinder/v1/README.rst renamed to packages/google-cloud-locationfinder/README.rst

Lines changed: 82 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
1-
Python Client for Google Cloud Locationfinder API
2-
=================================================
1+
Python Client for
2+
==================
3+
4+
|preview| |pypi| |versions|
5+
6+
``_:
7+
8+
- `Client Library Documentation`_
9+
- `Product Documentation`_
10+
11+
.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-locationfinder.svg
14+
:target: https://pypi.org/project/google-cloud-locationfinder/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-locationfinder.svg
16+
:target: https://pypi.org/project/google-cloud-locationfinder/
17+
.. _:
18+
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-locationfinder/latest/summary_overview
19+
.. _Product Documentation:
320
421
Quick Start
522
-----------
@@ -8,26 +25,55 @@ In order to use this library, you first need to go through the following steps:
825
926
1. `Select or create a Cloud Platform project.`_
1027
2. `Enable billing for your project.`_
11-
3. Enable the Google Cloud Locationfinder API.
12-
4. `Setup Authentication.`_
28+
3. `Enable the .`_
29+
4. `Set up Authentication.`_
1330
1431
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
1532
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
16-
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
33+
.. _Enable the .:
34+
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
1735
1836
Installation
1937
~~~~~~~~~~~~
2038
21-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
22-
create isolated Python environments. The basic problem it addresses is one of
23-
dependencies and versions, and indirectly permissions.
39+
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
40+
creates isolated Python environments. These isolated environments can have separate
41+
versions of Python packages, which allows you to isolate one project's dependencies
42+
from the dependencies of other projects.
2443
25-
With `virtualenv`_, it's possible to install this library without needing system
44+
With `venv`_, it's possible to install this library without needing system
2645
install permissions, and without clashing with the installed system
2746
dependencies.
2847
29-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
48+
.. _`venv`: https://docs.python.org/3/library/venv.html
49+
50+
51+
Code samples and snippets
52+
~~~~~~~~~~~~~~~~~~~~~~~~~
53+
54+
Code samples and snippets live in the `samples/`_ folder.
55+
56+
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-locationfinder/samples
57+
58+
59+
Supported Python Versions
60+
^^^^^^^^^^^^^^^^^^^^^^^^^
61+
Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
62+
Python.
63+
64+
Python >= 3.7
65+
66+
.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
67+
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
68+
69+
Unsupported Python Versions
70+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
71+
Python <= 3.6
3072
73+
If you are using an `end-of-life`_
74+
version of Python, we recommend that you update as soon as possible to an actively supported version.
75+
76+
.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
3177
3278
Mac/Linux
3379
^^^^^^^^^
@@ -36,18 +82,30 @@ Mac/Linux
3682
3783
python3 -m venv <your-env>
3884
source <your-env>/bin/activate
39-
<your-env>/bin/pip install /path/to/library
85+
pip install google-cloud-locationfinder
4086
4187
4288
Windows
4389
^^^^^^^
4490
4591
.. code-block:: console
4692
47-
python3 -m venv <your-env>
48-
<your-env>\Scripts\activate
49-
<your-env>\Scripts\pip.exe install \path\to\library
93+
py -m venv <your-env>
94+
.\<your-env>\Scripts\activate
95+
pip install google-cloud-locationfinder
96+
97+
Next Steps
98+
~~~~~~~~~~
5099
100+
- Read the `Client Library Documentation`_ for
101+
to see other available methods on the client.
102+
- Read the ` Product documentation`_ to learn
103+
more about the product and see How-to Guides.
104+
- View this `README`_ to see the full list of Cloud
105+
APIs that we cover.
106+
107+
.. _ Product documentation:
108+
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
51109
52110
Logging
53111
-------
@@ -59,7 +117,6 @@ Note the following:
59117
#. 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**.
60118
#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
61119
62-
63120
Simple, environment-based configuration
64121
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65122
@@ -75,9 +132,8 @@ A logging scope is a period-separated namespace that begins with :code:`google`,
75132
76133
**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
77134
78-
79-
Examples
80-
^^^^^^^^
135+
Environment-Based Examples
136+
^^^^^^^^^^^^^^^^^^^^^^^^^^
81137
82138
- Enabling the default handler for all Google-based loggers
83139
@@ -97,18 +153,17 @@ Advanced, code-based configuration
97153
98154
You can also configure a valid logging scope using Python's standard `logging` mechanism.
99155
100-
101-
Examples
102-
^^^^^^^^
156+
Code-Based Examples
157+
^^^^^^^^^^^^^^^^^^^
103158
104159
- Configuring a handler for all Google-based loggers
105160
106161
.. code-block:: python
107162
108163
import logging
109-
110-
from google.cloud.translate_v3 import translate
111-
164+
165+
from google.cloud import library_v1
166+
112167
base_logger = logging.getLogger("google")
113168
base_logger.addHandler(logging.StreamHandler())
114169
base_logger.setLevel(logging.DEBUG)
@@ -118,14 +173,13 @@ Examples
118173
.. code-block:: python
119174
120175
import logging
121-
122-
from google.cloud.translate_v3 import translate
123-
176+
177+
from google.cloud import library_v1
178+
124179
base_logger = logging.getLogger("google.cloud.library_v1")
125180
base_logger.addHandler(logging.StreamHandler())
126181
base_logger.setLevel(logging.DEBUG)
127182
128-
129183
Logging details
130184
~~~~~~~~~~~~~~~
131185
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.rst
File renamed without changes.

0 commit comments

Comments
 (0)