Merge pull request #2416 from dhermes/make-storage-subpackage

Move storage code into a subpackage

Author: dhermes

.travis.yml

@@ -8,13 +8,16 @@ script:
   - tox -e py27
   - (cd core && tox -e py27)
   - (cd bigtable && tox -e py27)
+  - (cd storage && tox -e py27)
   - tox -e py34
   - (cd core && tox -e py34)
   - (cd bigtable && tox -e py34)
+  - (cd storage && tox -e py34)
   - tox -e lint
   - tox -e cover
   - (cd core && tox -e cover)
   - (cd bigtable && tox -e cover)
+  - (cd storage && tox -e cover)
   - tox -e system-tests
   - tox -e system-tests3
   - scripts/update_docs.sh

scripts/verify_included_modules.py

@@ -61,6 +61,7 @@
     '',
     'bigtable',
     'core',
+    'storage',
 )
 
 

setup.py

@@ -50,8 +50,9 @@
 
 
 REQUIREMENTS = [
-    'google-cloud-core',
     'google-cloud-bigtable',
+    'google-cloud-core',
+    'google-cloud-storage',
 ]
 
 GRPC_PACKAGES = [

storage/.coveragerc

@@ -0,0 +1,11 @@
+[run]
+branch = True
+
+[report]
+fail_under = 100
+show_missing = True
+exclude_lines =
+    # Re-enable the standard pragma
+    pragma: NO COVER
+    # Ignore debug-only repr
+    def __repr__

storage/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.rst
+graft google
+graft unit_tests
+global-exclude *.pyc

storage/README.rst

@@ -0,0 +1,64 @@
+Python Client for Google Cloud Storage
+======================================
+
+    Python idiomatic client for `Google Cloud Storage`_
+
+.. _Google Cloud Storage: https://cloud.google.com/storage/docs
+
+-  `Homepage`_
+-  `API Documentation`_
+
+.. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
+.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/
+
+Quick Start
+-----------
+
+::
+
+    $ pip install --upgrade google-cloud-storage
+
+Authentication
+--------------
+
+With ``google-cloud-python`` we try to make authentication as painless as
+possible. Check out the `Authentication section`_ in our documentation to
+learn more. You may also find the `authentication document`_ shared by all
+the ``google-cloud-*`` libraries to be helpful.
+
+.. _Authentication section: http://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html
+.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication
+
+Using the API
+-------------
+
+Google `Cloud Storage`_ (`Storage API docs`_) allows you to store data on
+Google infrastructure with very high reliability, performance and
+availability, and can be used to distribute large data objects to users
+via direct download.
+
+.. _Cloud Storage: https://cloud.google.com/storage/docs
+.. _Storage API docs: https://cloud.google.com/storage/docs/json_api/v1
+
+See the ``google-cloud-python`` API `storage documentation`_ to learn how to
+connect to Cloud Storage using this Client Library.
+
+.. _storage documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/storage-client.html
+
+You need to create a Google Cloud Storage bucket to use this client library.
+Follow along with the `official Google Cloud Storage documentation`_ to learn
+how to create a bucket.
+
+.. _official Google Cloud Storage documentation: https://cloud.google.com/storage/docs/cloud-console#_creatingbuckets
+
+.. code:: python
+
+    from google.cloud import storage
+    client = storage.Client()
+    bucket = client.get_bucket('bucket-id-here')
+    # Then do other things...
+    blob = bucket.get_blob('remote/path/to/file.txt')
+    print(blob.download_as_string())
+    blob.upload_from_string('New contents!')
+    blob2 = bucket.blob('remote/path/storage.txt')
+    blob2.upload_from_filename(filename='/local/path.txt')

storage/google/__init__.py

@@ -0,0 +1,20 @@
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)

storage/google/cloud/__init__.py

@@ -0,0 +1,20 @@
+# Copyright 2014 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)