Moving core into designated package.

googleapis · Sep 20, 2016 · d24c138 · d24c138
1 parent 52e6263
commit d24c138
Show file tree

Hide file tree

Showing 23 changed files with 186 additions and 35 deletions.
diff --git a/core/README.rst b/core/README.rst
@@ -0,0 +1,20 @@
+Core Helpers for Google Cloud Python Client Library
+===================================================
+
+This library is not meant to stand-alone. Instead it defines
+common helpers (e.g. base ``Client`` and ``Connection`` classes)
+used by all of the ``google-cloud-*``.
+
+
+-  `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-core
diff --git a/core/google/__init__.py b/core/google/__init__.py
@@ -0,0 +1,22 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+
+"""Base ``google`` namespace package."""
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/core/google/cloud/__init__.py b/core/google/cloud/__init__.py
@@ -0,0 +1,22 @@
+# Copyright 2014 Google Inc. All rights reserved.
+#
+# 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.
+
+"""Google Cloud API access in idiomatic Python."""
+
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)
diff --git a/google/cloud/_helpers.py → core/google/cloud/_helpers.py b/google/cloud/_helpers.py → core/google/cloud/_helpers.py
diff --git a/google/cloud/client.py → core/google/cloud/client.py b/google/cloud/client.py → core/google/cloud/client.py
diff --git a/google/cloud/connection.py → core/google/cloud/connection.py b/google/cloud/connection.py → core/google/cloud/connection.py
diff --git a/google/cloud/credentials.py → core/google/cloud/credentials.py b/google/cloud/credentials.py → core/google/cloud/credentials.py
diff --git a/google/cloud/environment_vars.py → core/google/cloud/environment_vars.py b/google/cloud/environment_vars.py → core/google/cloud/environment_vars.py
diff --git a/google/cloud/exceptions.py → core/google/cloud/exceptions.py b/google/cloud/exceptions.py → core/google/cloud/exceptions.py
diff --git a/google/cloud/iterator.py → core/google/cloud/iterator.py b/google/cloud/iterator.py → core/google/cloud/iterator.py
diff --git a/google/cloud/operation.py → core/google/cloud/operation.py b/google/cloud/operation.py → core/google/cloud/operation.py
diff --git a/google/cloud/streaming/__init__.py → core/google/cloud/streaming/__init__.py b/google/cloud/streaming/__init__.py → core/google/cloud/streaming/__init__.py
diff --git a/google/cloud/streaming/buffered_stream.py → ...google/cloud/streaming/buffered_stream.py b/google/cloud/streaming/buffered_stream.py → ...google/cloud/streaming/buffered_stream.py
diff --git a/google/cloud/streaming/exceptions.py → core/google/cloud/streaming/exceptions.py b/google/cloud/streaming/exceptions.py → core/google/cloud/streaming/exceptions.py
diff --git a/google/cloud/streaming/http_wrapper.py → core/google/cloud/streaming/http_wrapper.py b/google/cloud/streaming/http_wrapper.py → core/google/cloud/streaming/http_wrapper.py
diff --git a/google/cloud/streaming/stream_slice.py → core/google/cloud/streaming/stream_slice.py b/google/cloud/streaming/stream_slice.py → core/google/cloud/streaming/stream_slice.py
diff --git a/google/cloud/streaming/transfer.py → core/google/cloud/streaming/transfer.py b/google/cloud/streaming/transfer.py → core/google/cloud/streaming/transfer.py
diff --git a/google/cloud/streaming/util.py → core/google/cloud/streaming/util.py b/google/cloud/streaming/util.py → core/google/cloud/streaming/util.py
diff --git a/core/setup.py b/core/setup.py
@@ -0,0 +1,72 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+
+import os
+
+from setuptools import setup
+from setuptools import find_packages
+
+
+PACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))
+
+with open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:
+    README = file_obj.read()
+
+# NOTE: This is duplicated throughout and we should try to
+#       consolidate.
+SETUP_BASE = {
+    'author': 'Google Cloud Platform',
+    'author_email': 'jjg+google-cloud-python@google.com',
+    'scripts': [],
+    'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',
+    'license': 'Apache 2.0',
+    'platforms': 'Posix; MacOS X; Windows',
+    'include_package_data': True,
+    'zip_safe': False,
+    'classifiers': [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Topic :: Internet',
+    ],
+}
+
+
+REQUIREMENTS = [
+    'httplib2 >= 0.9.1',
+    'googleapis-common-protos',
+    'oauth2client >= 2.0.1, < 3.0.0',
+    'protobuf >= 3.0.0',
+    'six',
+]
+
+setup(
+    name='google-cloud-core',
+    version='0.19.0',
+    description='API Client library for Google Cloud: Core Helpers',
+    long_description=README,
+    namespace_packages=[
+        'google',
+        'google.cloud',
+    ],
+    packages=find_packages(),
+    install_requires=REQUIREMENTS,
+    **SETUP_BASE
+)
diff --git a/scripts/run_pylint.py b/scripts/run_pylint.py
@@ -33,10 +33,11 @@
 IGNORED_DIRECTORIES = [
     os.path.join('google', 'cloud', 'bigtable', '_generated'),
     os.path.join('google', 'cloud', 'datastore', '_generated'),
-    'scripts/verify_included_modules.py',
 ]
 IGNORED_FILES = [
     os.path.join('docs', 'conf.py'),
+]
+IGNORED_POSTFIXES = [
     'setup.py',
 ]
 SCRIPTS_DIR = os.path.abspath(os.path.dirname(__file__))
@@ -113,6 +114,9 @@ def make_test_rc(base_rc_filename, additions_dict,
 
 def valid_filename(filename):
     """Checks if a file is a Python file and is not ignored."""
+    for postfix in IGNORED_POSTFIXES:
+        if filename.endswith(postfix):
+            return False
     for directory in IGNORED_DIRECTORIES:
         if filename.startswith(directory):
             return False

diff --git a/scripts/verify_included_modules.py b/scripts/verify_included_modules.py
@@ -56,6 +56,10 @@
     'google.cloud.vision.__init__',
     'google.cloud.vision.fixtures',
 ])
+PACKAGES = (
+    '',
+    'core',
+)
 
 
 class SphinxApp(object):
@@ -126,17 +130,24 @@ def main(build_root='_build'):
     :param build_root: The root of the directory where docs are built into.
                        Defaults to ``_build``.
     """
+    if build_root is None:
+        parser = get_parser()
+        args = parser.parse_args()
+        build_root = args.build_root
+
     object_inventory_relpath = os.path.join(build_root, 'html', 'objects.inv')
 
     mock_uri = ''
     inventory = fetch_inventory(SphinxApp, mock_uri,
                                 object_inventory_relpath)
     sphinx_mods = set(inventory['py:module'].keys())
 
-    library_dir = os.path.join(BASE_DIR, 'google', 'cloud')
-    public_mods = get_public_modules(library_dir,
-                                     base_package='google.cloud')
-    public_mods = set(public_mods)
+    public_mods = set()
+    for package in PACKAGES:
+        library_dir = os.path.join(BASE_DIR, package, 'google', 'cloud')
+        package_mods = get_public_modules(library_dir,
+                                          base_package='google.cloud')
+        public_mods.update(package_mods)
 
     if not sphinx_mods <= public_mods:
         unexpected_mods = sphinx_mods - public_mods
@@ -172,6 +183,4 @@ def get_parser():
 
 
 if __name__ == '__main__':
-    parser = get_parser()
-    args = parser.parse_args()
-    main(build_root=args.build_root)
+    main(build_root=None)
diff --git a/setup.py b/setup.py
@@ -1,22 +1,42 @@
 import os
-import sys
 
-from setuptools import setup
 from setuptools import find_packages
+from setuptools import setup
 
 
 PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
 
 with open(os.path.join(PROJECT_ROOT, 'README.rst')) as file_obj:
     README = file_obj.read()
 
+# NOTE: This is duplicated throughout and we should try to
+#       consolidate.
+SETUP_BASE = {
+    'author': 'Google Cloud Platform',
+    'author_email': 'jjg+google-cloud-python@google.com',
+    'scripts': [],
+    'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',
+    'license': 'Apache 2.0',
+    'platforms': 'Posix; MacOS X; Windows',
+    'include_package_data': True,
+    'zip_safe': False,
+    'classifiers': [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Topic :: Internet',
+    ],
+}
+
 
 REQUIREMENTS = [
-    'httplib2 >= 0.9.1',
-    'googleapis-common-protos',
-    'oauth2client >= 2.0.1',
-    'protobuf >= 3.0.0',
-    'six',
+    'google-cloud-core',
 ]
 
 GRPC_PACKAGES = [
@@ -36,31 +56,12 @@
     name='google-cloud',
     version='0.19.0',
     description='API Client library for Google Cloud',
-    author='Google Cloud Platform',
-    author_email='jjg+google-cloud-python@google.com',
     long_description=README,
-    scripts=[],
-    url='https://github.com/GoogleCloudPlatform/google-cloud-python',
     namespace_packages=[
         'google',
         'google.cloud',
     ],
     packages=find_packages(),
-    license='Apache 2.0',
-    platforms='Posix; MacOS X; Windows',
-    include_package_data=True,
-    zip_safe=False,
     install_requires=REQUIREMENTS,
-    classifiers=[
-        'Development Status :: 4 - Beta',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: Apache Software License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Topic :: Internet',
-    ]
+    **SETUP_BASE
 )
diff --git a/tox.ini b/tox.ini
@@ -4,6 +4,7 @@ envlist =
 
 [testing]
 deps =
+    {toxinidir}/core
     pytest
 covercmd =
     py.test --quiet \