Skip to content
This repository was archived by the owner on Nov 8, 2023. It is now read-only.

Commit 3528a72

Browse files
docs: add multiprocessing (#11)
1 parent dabeec7 commit 3528a72

File tree

11 files changed

+64
-22
lines changed

11 files changed

+64
-22
lines changed

.flake8

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Copyright 2020 Google LLC
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
117
# Generated by synthtool. DO NOT EDIT!
218
[flake8]
319
ignore = E203, E266, E501, W503, F401, F821, F841, W291

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ Thanks for stopping by to let us know something could be better!
1111
Please run down the following list and make sure you've tried the usual "quick fixes":
1212

1313
- Search the issues already opened: https://github.com/googleapis/python-game-servers/issues
14-
- Search the issues on our "catch-all" repository: https://github.com/googleapis/google-cloud-python
15-
- Search StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform+python
14+
- Search StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-platform+python
1615

1716
If you are still having issues, please be sure to include as much information as possible:
1817

.kokoro/publish-docs.sh

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16-
#!/bin/bash
17-
1816
set -eo pipefail
1917

2018
# Disable buffering, so that the logs stream through.

.kokoro/release.sh

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16-
#!/bin/bash
17-
1816
set -eo pipefail
1917

2018
# Start the releasetool reporter

CONTRIBUTING.rst

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In order to add a feature:
2222
documentation.
2323

2424
- The feature must work fully on the following CPython versions: 2.7,
25-
3.5, 3.6, and 3.7 on both UNIX and Windows.
25+
3.5, 3.6, 3.7 and 3.8 on both UNIX and Windows.
2626

2727
- The feature must not add unnecessary dependencies (where
2828
"unnecessary" is of course subjective, but new dependencies should
@@ -214,26 +214,18 @@ We support:
214214
- `Python 3.5`_
215215
- `Python 3.6`_
216216
- `Python 3.7`_
217+
- `Python 3.8`_
217218

218219
.. _Python 3.5: https://docs.python.org/3.5/
219220
.. _Python 3.6: https://docs.python.org/3.6/
220221
.. _Python 3.7: https://docs.python.org/3.7/
222+
.. _Python 3.8: https://docs.python.org/3.8/
221223

222224

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

225227
.. _config: https://github.com/googleapis/python-game-servers/blob/master/noxfile.py
226228

227-
We explicitly decided not to support `Python 2.5`_ due to `decreased usage`_
228-
and lack of continuous integration `support`_.
229-
230-
.. _Python 2.5: https://docs.python.org/2.5/
231-
.. _decreased usage: https://caremad.io/2013/10/a-look-at-pypi-downloads/
232-
.. _support: https://blog.travis-ci.com/2013-11-18-upcoming-build-environment-updates/
233-
234-
We have `dropped 2.6`_ as a supported version as well since Python 2.6 is no
235-
longer supported by the core development team.
236-
237229
Python 2.7 support is deprecated. All code changes should maintain Python 2.7 compatibility until January 1, 2020.
238230

239231
We also explicitly decided to support Python 3 beginning with version
@@ -247,7 +239,6 @@ We also explicitly decided to support Python 3 beginning with version
247239
.. _prominent: https://docs.djangoproject.com/en/1.9/faq/install/#what-python-version-can-i-use-with-django
248240
.. _projects: http://flask.pocoo.org/docs/0.10/python3/
249241
.. _Unicode literal support: https://www.python.org/dev/peps/pep-0414/
250-
.. _dropped 2.6: https://github.com/googleapis/google-cloud-python/issues/995
251242

252243
**********
253244
Versioning

MANIFEST.in

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Copyright 2020 Google LLC
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
117
# Generated by synthtool. DO NOT EDIT!
218
include README.rst LICENSE
319
recursive-include google *.json *.proto

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. include:: README.rst
22

3+
.. include:: multiprocessing.rst
4+
35
API Reference
46
-------------
57
.. toctree::

docs/multiprocessing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. note::
2+
3+
Because this client uses :mod:`grpcio` library, it is safe to
4+
share instances across threads. In multiprocessing scenarios, the best
5+
practice is to create client instances *after* the invocation of
6+
:func:`os.fork` by :class:`multiprocessing.Pool` or
7+
:class:`multiprocessing.Process`.

noxfile.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,7 @@ def system(session):
110110

111111
# Install all test dependencies, then install this package into the
112112
# virtualenv's dist-packages.
113-
session.install("mock", "pytest")
114-
113+
session.install("mock", "pytest", "google-cloud-testutils")
115114
session.install("-e", ".")
116115

117116
# Run py.test against the system tests.
@@ -139,7 +138,7 @@ def docs(session):
139138
"""Build the docs for this library."""
140139

141140
session.install("-e", ".")
142-
session.install("sphinx", "alabaster", "recommonmark")
141+
session.install("sphinx<3.0.0", "alabaster", "recommonmark")
143142

144143
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
145144
session.run(

setup.cfg

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Copyright 2020 Google LLC
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
117
# Generated by synthtool. DO NOT EDIT!
218
[bdist_wheel]
319
universal = 1

0 commit comments

Comments
 (0)