Skip to content

Commit 645822f

Browse files
authored
docs: refresh list of libraries and CONTRIBUTING.rst (googleapis#9387)
1 parent e4b9800 commit 645822f

3 files changed

Lines changed: 137 additions & 83 deletions

File tree

CONTRIBUTING.rst

Lines changed: 29 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You'll have to create a development environment to hack on
4949
$ cd hack-on-google-cloud-python
5050
# Configure remotes such that you can pull changes from the google-cloud-python
5151
# repository into your local repository.
52-
$ git remote add upstream git@github.com:GoogleCloudPlatform/google-cloud-python.git
52+
$ git remote add upstream git@github.com:googleapis/google-cloud-python.git
5353
# fetch and merge changes from upstream into master
5454
$ git fetch upstream
5555
$ git merge upstream/master
@@ -60,23 +60,25 @@ repo, from which you can submit a pull request.
6060
To work on the codebase and run the tests, we recommend using ``nox``,
6161
but you can also use a ``virtualenv`` of your own creation.
6262

63-
.. _repo: https://github.com/GoogleCloudPlatform/google-cloud-python
63+
.. _repo: https://github.com/googleapis/google-cloud-python
6464

6565
Using ``nox``
6666
=============
6767

6868
We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
6969

70-
- To test your changes, run unit tests with ``nox``::
70+
You must install nox using Python 3.
7171

72-
$ nox -f datastore/noxfile.py -s unit-2.7
73-
$ nox -f datastore/noxfile.py -s unit-3.7
72+
- To test your changes, go to the package directory and run ``nox``::
73+
74+
$ nox -s unit-2.7
75+
$ nox -s unit-3.7
7476
$ ...
7577

7678
.. note::
7779

7880
The unit tests and system tests are contained in the individual
79-
``nox.py`` files in each directory; substitute ``datastore`` in the
81+
``noxfile.py`` files in each directory; substitute ``datastore`` in the
8082
example above with the package of your choice.
8183

8284

@@ -85,7 +87,7 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
8587

8688
$ export GIT_ROOT=$(pwd)
8789
$ cd ${GIT_ROOT}/datastore/
88-
$ nox -s "unit(py='3.7')"
90+
$ nox -s unit-3.7
8991

9092
.. nox: https://pypi.org/project/nox-automation/
9193
@@ -122,9 +124,13 @@ On Debian/Ubuntu::
122124
Coding Style
123125
************
124126

125-
- PEP8 compliance, with exceptions defined in the linter configuration.
126-
If you have ``nox`` installed, you can test that you have not introduced
127-
any non-compliant code via::
127+
- We use the automatic code formatter ``black``. You can run it using
128+
the nox session ``blacken``. This will eliminate many lint errors.
129+
130+
$ nox -s blacken
131+
132+
- PEP8 compliance is required, with exceptions defined in the linter configuration.
133+
You can test for non-compliant code via::
128134

129135
$ nox -s lint
130136

@@ -135,8 +141,8 @@ Coding Style
135141
export GOOGLE_CLOUD_TESTING_BRANCH="master"
136142

137143
By doing this, you are specifying the location of the most up-to-date
138-
version of ``google-cloud-python``. The the suggested remote name ``upstream``
139-
should point to the official ``GoogleCloudPlatform`` checkout and the
144+
version of ``google-cloud-python``. The suggested remote name ``upstream``
145+
should point to the official ``googleapis`` checkout and the
140146
the branch should be the main branch on that remote (``master``).
141147

142148
Exceptions to PEP8:
@@ -149,10 +155,11 @@ Exceptions to PEP8:
149155
Running System Tests
150156
********************
151157

152-
- To run system tests for a given package, you can execute::
158+
- To run system tests for a given package, go to the package directory
159+
and execute::
153160

154-
$ nox -f datastore/noxfile.py -s system-3.7
155-
$ nox -f datastore/noxfile.py -s system-2.7
161+
$ nox -s system-3.7
162+
$ nox -s system-2.7
156163

157164
.. note::
158165

@@ -216,9 +223,10 @@ Running System Tests
216223
Running Generated Sample Tests
217224
******************************
218225

219-
- To run system tests for a given package, you can execute::
226+
- To run system tests for a given package, go to the package directory
227+
and execute::
220228

221-
$ nox -f speech/noxfile.py -s samples
229+
$ nox -s samples
222230

223231
.. note::
224232

@@ -246,33 +254,13 @@ documentation in this package which references that API or behavior must be
246254
changed to reflect the bug fix, ideally in the same commit that fixes the bug
247255
or adds the feature.
248256

249-
To build and review docs (where ``${VENV}`` refers to the virtualenv you're
250-
using to develop ``google-cloud-python``):
251-
252-
#. After following the steps above in "Using a Development Checkout", install
253-
Sphinx and all development requirements in your virtualenv::
254-
255-
$ cd ${HOME}/hack-on-google-cloud-python
256-
$ ${VENV}/bin/pip install Sphinx
257+
To build and review docs go to the package directory and execute::
257258

258-
#. Change into the ``docs`` directory within your ``google-cloud-python`` checkout and
259-
execute the ``make`` command with some flags::
260-
261-
$ cd ${HOME}/hack-on-google-cloud-python/google-cloud-python/docs
262-
$ make clean html SPHINXBUILD=${VENV}/bin/sphinx-build
263-
264-
The ``SPHINXBUILD=...`` argument tells Sphinx to use the virtualenv Python,
265-
which will have both Sphinx and ``google-cloud-python`` (for API documentation
266-
generation) installed.
259+
$ nox -s docs
267260

268261
#. Open the ``docs/_build/html/index.html`` file to see the resulting HTML
269262
rendering.
270263

271-
As an alternative to 1. and 2. above, if you have ``nox`` installed, you
272-
can build the docs via::
273-
274-
$ nox -s docs
275-
276264
********************************************
277265
Note About ``README`` as it pertains to PyPI
278266
********************************************
@@ -287,13 +275,10 @@ may cause problems creating links or rendering the description.
287275
.. _description on PyPI: https://pypi.org/project/google-cloud/
288276

289277
**********************
290-
CircleCI Configuration
278+
Kokoro Configuration
291279
**********************
292280

293-
All build scripts in the ``.circleci/config.yml`` configuration file which have
294-
Python dependencies are specified in the ``nox.py`` configuration.
295-
They are executed in the Travis build via ``nox -s ${ENV}`` where
296-
``${ENV}`` is the environment being tested.
281+
Build scripts and configurations are in the ``.kokoro`` directory.
297282

298283

299284
*************************

README.rst

Lines changed: 107 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -28,46 +28,71 @@ priority.
2828

2929
The following client libraries have **GA** support:
3030

31-
- `Google BigQuery`_ (`BigQuery README`_)
32-
- `Google Cloud Bigtable`_ (`Bigtable README`_)
33-
- `Google Cloud Datastore`_ (`Datastore README`_)
34-
- `Google Cloud KMS`_ (`KMS README`_)
35-
- `Google Cloud Natural Language`_ (`Natural Language README`_)
36-
- `Google Cloud Pub/Sub`_ (`Pub/Sub README`_)
37-
- `Google Cloud Scheduler`_ (`Scheduler README`_)
38-
- `Google Cloud Spanner`_ (`Spanner README`_)
39-
- `Google Cloud Speech`_ (`Speech README`_)
40-
- `Google Cloud Storage`_ (`Storage README`_)
41-
- `Google Cloud Tasks`_ (`Tasks README`_)
42-
- `Google Cloud Translation`_ (`Translation README`_)
43-
- `Stackdriver Logging`_ (`Logging README`_)
31+
- `Google BigQuery`_ (`BigQuery README`_, `BigQuery Documentation`_)
32+
- `Google Cloud Bigtable`_ (`Bigtable README`_, `Bigtable Documentation`_)
33+
- `Google Cloud Datastore`_ (`Datastore README`_, `Datastore Documentation`_)
34+
- `Google Cloud KMS`_ (`KMS README`_, `KMS Documentation`_)
35+
- `Google Cloud Natural Language`_ (`Natural Language README`_, `Natural Language Documentation`_)
36+
- `Google Cloud Pub/Sub`_ (`Pub/Sub README`_, `Pub/Sub Documentation`_)
37+
- `Google Cloud Scheduler`_ (`Scheduler README`_, `Scheduler Documentation`_)
38+
- `Google Cloud Spanner`_ (`Spanner README`_, `Spanner Documentation`_)
39+
- `Google Cloud Speech to Text`_ (`Speech to Text README`_, `Speech to Text Documentation`_)
40+
- `Google Cloud Storage`_ (`Storage README`_, `Storage Documentation`_)
41+
- `Google Cloud Tasks`_ (`Tasks README`_, `Tasks Documentation`_)
42+
- `Google Cloud Translation`_ (`Translation README`_, `Translation Documentation`_)
43+
- `Stackdriver Logging`_ (`Logging README`_, `Logging Documentation`_)
4444

4545
.. _Google BigQuery: https://pypi.org/project/google-cloud-bigquery/
4646
.. _BigQuery README: https://github.com/googleapis/google-cloud-python/tree/master/bigquery
47+
.. _BigQuery Documentation: https://googleapis.dev/python/bigquery/latest
48+
4749
.. _Google Cloud Bigtable: https://pypi.org/project/google-cloud-bigtable/
4850
.. _Bigtable README: https://github.com/googleapis/google-cloud-python/tree/master/bigtable
51+
.. _Bigtable Documentation: https://googleapis.dev/python/bigtable/latest
52+
4953
.. _Google Cloud Datastore: https://pypi.org/project/google-cloud-datastore/
5054
.. _Datastore README: https://github.com/googleapis/google-cloud-python/tree/master/datastore
55+
.. _Datastore Documentation: https://googleapis.dev/python/datastore/latest
56+
5157
.. _Google Cloud KMS: https://pypi.org/project/google-cloud-kms/
5258
.. _KMS README: https://github.com/googleapis/google-cloud-python/tree/master/kms
59+
.. _KMS Documentation: https://googleapis.dev/python/cloudkms/latest
60+
5361
.. _Google Cloud Natural Language: https://pypi.org/project/google-cloud-language/
5462
.. _Natural Language README: https://github.com/googleapis/google-cloud-python/tree/master/language
63+
.. _Natural Language Documentation: https://googleapis.dev/python/language/latest
64+
5565
.. _Google Cloud Pub/Sub: https://pypi.org/project/google-cloud-pubsub/
5666
.. _Pub/Sub README: https://github.com/googleapis/google-cloud-python/tree/master/pubsub
67+
.. _Pub/Sub Documentation: https://googleapis.dev/python/pubsub/latest
68+
5769
.. _Google Cloud Spanner: https://pypi.org/project/google-cloud-spanner
5870
.. _Spanner README: https://github.com/googleapis/google-cloud-python/tree/master/spanner
59-
.. _Google Cloud Speech: https://pypi.org/project/google-cloud-speech/
60-
.. _Speech README: https://github.com/googleapis/google-cloud-python/tree/master/speech
71+
.. _Spanner Documentation: https://googleapis.dev/python/spanner/latest
72+
73+
.. _Google Cloud Speech to Text: https://pypi.org/project/google-cloud-speech/
74+
.. _Speech to Text README: https://github.com/googleapis/google-cloud-python/tree/master/speech
75+
.. _Speech to Text Documentation: https://googleapis.dev/python/speech/latest
76+
6177
.. _Google Cloud Storage: https://pypi.org/project/google-cloud-storage/
6278
.. _Storage README: https://github.com/googleapis/google-cloud-python/tree/master/storage
79+
.. _Storage Documentation: https://googleapis.dev/python/storage/latest
80+
6381
.. _Google Cloud Tasks: https://pypi.org/project/google-cloud-tasks/
6482
.. _Tasks README: https://github.com/googleapis/google-cloud-python/tree/master/tasks
83+
.. _Tasks Documentation: https://googleapis.dev/python/cloudtasks/latest
84+
6585
.. _Google Cloud Translation: https://pypi.org/project/google-cloud-translate/
6686
.. _Translation README: https://github.com/googleapis/google-cloud-python/tree/master/translate
87+
.. _Translation Documentation: https://googleapis.dev/python/translation/latest
88+
6789
.. _Google Cloud Scheduler: https://pypi.org/project/google-cloud-scheduler/
6890
.. _Scheduler README: https://github.com/googleapis/google-cloud-python/tree/master/scheduler
91+
.. _Scheduler Documentation: https://googleapis.dev/python/cloudscheduler/latest
92+
6993
.. _Stackdriver Logging: https://pypi.org/project/google-cloud-logging/
7094
.. _Logging README: https://github.com/googleapis/google-cloud-python/tree/master/logging
95+
.. _Logging Documentation: https://googleapis.dev/python/logging/latest
7196

7297
Beta Support
7398
------------
@@ -78,16 +103,21 @@ against beta libraries are addressed with a higher priority.
78103

79104
The following client libraries have **beta** support:
80105

81-
- `Google Cloud Firestore`_ (`Firestore README`_)
82-
- `Google Cloud Video Intelligence`_ (`Video Intelligence README`_)
83-
- `Google Cloud Vision`_ (`Vision README`_)
106+
- `Google Cloud Firestore`_ (`Firestore README`_, `Firestore Documentation`_)
107+
- `Google Cloud Video Intelligence`_ (`Video Intelligence README`_, `Video Intelligence Documentation`_)
108+
- `Google Cloud Vision`_ (`Vision README`_, `Vision Documentation`_)
84109

85110
.. _Google Cloud Firestore: https://pypi.org/project/google-cloud-firestore/
86111
.. _Firestore README: https://github.com/googleapis/google-cloud-python/tree/master/firestore
112+
.. _Firestore Documentation: https://googleapis.dev/python/firestore/latest
113+
87114
.. _Google Cloud Video Intelligence: https://pypi.org/project/google-cloud-videointelligence
88115
.. _Video Intelligence README: https://github.com/googleapis/google-cloud-python/tree/master/videointelligence
116+
.. _Video Intelligence Documentation: https://googleapis.dev/python/videointelligence/latest
117+
89118
.. _Google Cloud Vision: https://pypi.org/project/google-cloud-vision/
90119
.. _Vision README: https://github.com/googleapis/google-cloud-python/tree/master/vision
120+
.. _Vision Documentation: https://googleapis.dev/python/vision/latest
91121

92122

93123
Alpha Support
@@ -99,67 +129,106 @@ updates. See `versioning`_ for more details.
99129

100130
The following client libraries have **alpha** support:
101131

102-
- `Google Cloud Asset`_ (`Asset README`_)
103-
- `Google Cloud AutoML`_ (`AutoML README`_)
104-
- `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_)
105-
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
106-
- `Google Cloud Container`_ (`Container README`_)
107-
- `Google Cloud Container Analysis`_ (`Container Analysis README`_)
108-
- `Google Cloud Dataproc`_ (`Dataproc README`_)
109-
- `Google Cloud DLP`_ (`DLP README`_)
110-
- `Google Cloud DNS`_ (`DNS README`_)
111-
- `Google Cloud IoT`_ (`IoT README`_)
112-
- `Google Cloud Memorystore for Redis`_ (`Redis README`_)
113-
- `Google Cloud Recommender`_ (`Recommender README`_)
114-
- `Google Cloud Resource Manager`_ (`Resource Manager README`_)
115-
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_)
116-
- `Google Cloud Security Scanner`_ (`Security Scanner README`_ )
117-
- `Google Cloud Trace`_ (`Trace README`_)
118-
- `Google Cloud Text-to-Speech`_ (`Text-to-Speech README`_)
119-
- `Grafeas`_ (`Grafeas README`_)
120-
- `Stackdriver Error Reporting`_ (`Error Reporting README`_)
121-
- `Stackdriver Monitoring`_ (`Monitoring README`_)
132+
- `Google Cloud Asset`_ (`Asset README`_, `Asset Documentation`_)
133+
- `Google Cloud AutoML`_ (`AutoML README`_, `AutoML Documentation`_)
134+
- `Google BigQuery Data Transfer`_ (`BigQuery Data Transfer README`_, `BigQuery Documentation`_)
135+
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_, `HappyBase Documentation`_)
136+
- `Google Cloud Container`_ (`Container README`_, `Container Documentation`_)
137+
- `Google Cloud Container Analysis`_ (`Container Analysis README`_, `Container Analysis Documentation`_)
138+
- `Google Cloud Dataproc`_ (`Dataproc README`_, `Dataproc Documentation`_)
139+
- `Google Cloud DLP`_ (`DLP README`_, `DLP Documentation`_)
140+
- `Google Cloud DNS`_ (`DNS README`_, `DNS Documentation`_)
141+
- `Google Cloud IoT`_ (`IoT README`_, `IoT Documentation`_)
142+
- `Google Cloud Memorystore for Redis`_ (`Redis README`_, `Redis Documentation`_)
143+
- `Google Cloud Recommender`_ (`Recommender README`_, `Recommender Documentation`_)
144+
- `Google Cloud Resource Manager`_ (`Resource Manager README`_, `Resource Manager Documentation`_)
145+
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_, `Runtime Config Documentation`_)
146+
- `Google Cloud Security Scanner`_ (`Security Scanner README`_ , `Security Scanner Documentation`_)
147+
- `Google Cloud Trace`_ (`Trace README`_, `Trace Documentation`_)
148+
- `Google Cloud Text-to-Speech`_ (`Text-to-Speech README`_, `Text-to-Speech Documentation`_)
149+
- `Grafeas`_ (`Grafeas README`_, `Grafeas Documentation`_)
150+
- `Stackdriver Error Reporting`_ (`Error Reporting README`_, `Error Reporting Documentation`_)
151+
- `Stackdriver Monitoring`_ (`Monitoring README`_, `Monitoring Documentation`_)
122152

123153
.. _Google Cloud Asset: https://pypi.org/project/google-cloud-asset/
124154
.. _Asset README: https://github.com/googleapis/google-cloud-python/blob/master/asset
155+
.. _Asset Documentation: https://googleapis.dev/python/cloudasset/latest
156+
125157
.. _Google Cloud AutoML: https://pypi.org/project/google-cloud-automl/
126158
.. _AutoML README: https://github.com/googleapis/google-cloud-python/blob/master/automl
159+
.. _AutoML Documentation: https://googleapis.dev/python/automl/latest
160+
127161
.. _Google BigQuery Data Transfer: https://pypi.org/project/google-cloud-bigquery-datatransfer/
128162
.. _BigQuery Data Transfer README: https://github.com/googleapis/google-cloud-python/tree/master/bigquery_datatransfer
163+
.. _BigQuery Documentation: https://googleapis.dev/python/bigquery/latest
164+
129165
.. _Google Cloud Bigtable - HappyBase: https://pypi.org/project/google-cloud-happybase/
130166
.. _HappyBase README: https://github.com/googleapis/google-cloud-python-happybase
167+
.. _HappyBase Documentation: https://google-cloud-python-happybase.readthedocs.io/en/latest/
168+
131169
.. _Google Cloud Container: https://pypi.org/project/google-cloud-container/
132170
.. _Container README: https://github.com/googleapis/google-cloud-python/tree/master/container
171+
.. _Container Documentation: https://googleapis.dev/python/container/latest
172+
133173
.. _Google Cloud Container Analysis: https://pypi.org/project/google-cloud-containeranalysis/
134174
.. _Container Analysis README: https://github.com/googleapis/google-cloud-python/tree/master/containeranalysis
175+
.. _Container Analysis Documentation: https://googleapis.dev/python/containeranalysis/latest
176+
135177
.. _Google Cloud Dataproc: https://pypi.org/project/google-cloud-dataproc/
136178
.. _Dataproc README: https://github.com/googleapis/google-cloud-python/tree/master/dataproc
179+
.. _Dataproc Documentation: https://googleapis.dev/python/dataproc/latest
180+
137181
.. _Google Cloud DLP: https://pypi.org/project/google-cloud-dlp/
138182
.. _DLP README: https://github.com/googleapis/google-cloud-python/tree/master/dlp
183+
.. _DLP Documentation: https://googleapis.dev/python/dlp/latest
184+
139185
.. _Google Cloud DNS: https://pypi.org/project/google-cloud-dns/
140186
.. _DNS README: https://github.com/googleapis/google-cloud-python/tree/master/dns
187+
.. _DNS Documentation: https://googleapis.dev/python/dns/latest
188+
141189
.. _Google Cloud IoT: https://pypi.org/project/google-cloud-iot/
142190
.. _IoT README: https://github.com/googleapis/google-cloud-python/tree/master/iot
191+
.. _IoT Documentation: https://googleapis.dev/python/cloudiot/latest
192+
143193
.. _Google Cloud Memorystore for Redis: https://pypi.org/project/google-cloud-redis/
144194
.. _Redis README: https://github.com/googleapis/google-cloud-python/tree/master/redis
195+
.. _Redis Documentation: https://googleapis.dev/python/redis/latest
196+
145197
.. _Google Cloud Recommender: https://pypi.org/project/google-cloud-recommender/
146198
.. _Recommender README: https://github.com/googleapis/google-cloud-python/tree/master/recommender
199+
.. _Recommender Documentation: https://googleapis.dev/python/recommender/latest
200+
147201
.. _Google Cloud Resource Manager: https://pypi.org/project/google-cloud-resource-manager/
148202
.. _Resource Manager README: https://github.com/googleapis/google-cloud-python/tree/master/resource_manager
203+
.. _Resource Manager Documentation: https://googleapis.dev/python/cloudresourcemanager/latest
204+
149205
.. _Google Cloud Runtime Configuration: https://pypi.org/project/google-cloud-runtimeconfig/
150206
.. _Runtime Config README: https://github.com/googleapis/google-cloud-python/tree/master/runtimeconfig
207+
.. _Runtime Config Documentation: https://googleapis.dev/python/runtimeconfig/latest
208+
151209
.. _Google Cloud Security Scanner: https://pypi.org/project/google-cloud-websecurityscanner/
152210
.. _Security Scanner README: https://github.com/googleapis/google-cloud-python/blob/master/websecurityscanner
211+
.. _Security Scanner Documentation: https://googleapis.dev/python/websecurityscanner/latest
212+
153213
.. _Google Cloud Text-to-Speech: https://pypi.org/project/google-cloud-texttospeech/
154214
.. _Text-to-Speech README: https://github.com/googleapis/google-cloud-python/tree/master/texttospeech
215+
.. _Text-to-Speech Documentation: https://googleapis.dev/python/texttospeech/latest
216+
155217
.. _Google Cloud Trace: https://pypi.org/project/google-cloud-trace/
156218
.. _Trace README: https://github.com/googleapis/google-cloud-python/tree/master/trace
219+
.. _Trace Documentation: https://googleapis.dev/python/cloudtrace/latest
220+
157221
.. _Grafeas: https://pypi.org/project/grafeas/
158222
.. _Grafeas README: https://github.com/googleapis/google-cloud-python/tree/master/grafeas
223+
.. _Grafeas Documentation: https://googleapis.dev/python/grafeas/latest
224+
159225
.. _Stackdriver Error Reporting: https://pypi.org/project/google-cloud-error-reporting/
160226
.. _Error Reporting README: https://github.com/googleapis/google-cloud-python/tree/master/error_reporting
227+
.. _Error Reporting Documentation: https://googleapis.dev/python/clouderrorreporting/latest
228+
161229
.. _Stackdriver Monitoring: https://pypi.org/project/google-cloud-monitoring/
162230
.. _Monitoring README: https://github.com/googleapis/google-cloud-python/tree/master/monitoring
231+
.. _Monitoring Documentation: https://googleapis.dev/python/monitoring/latest
163232

164233
.. _versioning: https://github.com/googleapis/google-cloud-python/blob/master/CONTRIBUTING.rst#versioning
165234

0 commit comments

Comments
 (0)