Skip to content

Commit 5457564

Browse files
committed
Merge pull request #401 from dhermes/document-apitools-code
Adding description of "borrowed" vendor code.
2 parents ef50cc7 + 2d831cd commit 5457564

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,33 @@ should either be:
285285
``EXTRA_TOX_ENVS``. This value is unencrypted in ``gcloud-python-wheels``
286286
to make ongoing maintenance easier.
287287

288+
Shared Code with External Projects
289+
----------------------------------
290+
291+
In order to enable high-quality HTTP transfer of large data (for Cloud
292+
Storage), we have temporarily included some code from the
293+
`apitools <https://github.com/craigcitro/apitools>`__ library.
294+
295+
We have chosen to partially include it, rather than include it as
296+
a dependency because
297+
298+
- The library is not yet included on PyPI.
299+
- The library's ``protorpc`` dependency is not Python 3 friendly, so
300+
would block us from Python 3 support if fully included.
301+
302+
The included code in lives in the
303+
`_gcloud_vendor <https://github.com/GoogleCloudPlatform/gcloud-python/tree/master/_gcloud_vendor>`__
304+
directory. It is a snapshot of the ``e5a5c36e24926310712d20b93b4cdd02424a81f5``
305+
commit from the main project imported in
306+
``4c27079cf6d7f9814b36cfd16f3402455f768094``. In addition to the raw import,
307+
we have customized (e.g. rewriting imports) for our library:
308+
309+
- ``334961054d875641d150eec4d6938f6f824ea655``
310+
- ``565750ee7d19742b520dd62e2a4ff38325987284``
311+
- ``67b06019549a4db8168ff4c5171c9d701ac94a15``
312+
- ``f4a53ee64fad5f3d7f29a0341e6a72a060edfcc2``
313+
314+
288315
Contributor License Agreements
289316
------------------------------
290317

0 commit comments

Comments
 (0)