Merge pull request #2430 from dhermes/make-monitoring-subpackage

Move monitoring code into a subpackage

.travis.yml

@@ -17,6 +17,7 @@ script:
   - (cd language && tox -e py27)
   - (cd error_reporting && tox -e py27)
   - (cd resource_manager && tox -e py27)
+  - (cd monitoring && tox -e py27)
   - tox -e py34
   - (cd core && tox -e py34)
   - (cd bigtable && tox -e py34)
@@ -29,6 +30,7 @@ script:
   - (cd language && tox -e py34)
   - (cd error_reporting && tox -e py34)
   - (cd resource_manager && tox -e py34)
+  - (cd monitoring && tox -e py34)
   - tox -e lint
   - tox -e cover
   - (cd core && tox -e cover)
@@ -42,6 +44,7 @@ script:
   - (cd language && tox -e cover)
   - (cd error_reporting && tox -e cover)
   - (cd resource_manager && tox -e cover)
+  - (cd monitoring && tox -e cover)
   - tox -e system-tests
   - tox -e system-tests3
   - scripts/update_docs.sh

monitoring/.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__

monitoring/MANIFEST.in

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

monitoring/README.rst

@@ -0,0 +1,68 @@
+Python Client for Stackdriver Monitoring
+========================================
+
+    Python idiomatic client for `Stackdriver Monitoring`_
+
+.. _Stackdriver Monitoring: https://cloud.google.com/monitoring/
+
+-  `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-monitoring
+
+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
+-------------
+
+`Stackdriver Monitoring`_ (`Monitoring API docs`_) collects metrics,
+events, and metadata from Google Cloud Platform, Amazon Web Services (AWS),
+hosted uptime probes, application instrumentation, and a variety of common
+application components including Cassandra, Nginx, Apache Web Server,
+Elasticsearch and many others. Stackdriver ingests that data and generates
+insights via dashboards, charts, and alerts.
+
+This package currently supports all Monitoring API operations other than
+writing custom metrics.
+
+.. _Stackdriver Monitoring: https://cloud.google.com/monitoring/
+.. _Monitoring API docs: https://cloud.google.com/monitoring/api/ref_v3/rest/
+
+List available metric types:
+
+.. code:: python
+
+    from google.cloud import monitoring
+    client = monitoring.Client()
+    for descriptor in client.list_metric_descriptors():
+        print(descriptor.type)
+
+Display CPU utilization across your GCE instances during the last five minutes:
+
+.. code:: python
+
+    metric = 'compute.googleapis.com/instance/cpu/utilization'
+    query = client.query(metric, minutes=5)
+    print(query.as_dataframe())
+
+See the ``google-cloud-python`` API `monitoring documentation`_ to learn how
+to connect to Stackdriver Monitoring using this Client Library.
+
+.. _monitoring documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring-usage.html

monitoring/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__)

monitoring/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__)

monitoring/setup.py

@@ -0,0 +1,68 @@
+# 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.
+
+import os
+
+from setuptools import find_packages
+from setuptools import setup
+
+
+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 = [
+    'google-cloud-core',
+]
+
+setup(
+    name='google-cloud-monitoring',
+    version='0.20.0dev',
+    description='Python Client for Stackdriver Monitoring',
+    long_description=README,
+    namespace_packages=[
+        'google',
+        'google.cloud',
+    ],
+    packages=find_packages(),
+    install_requires=REQUIREMENTS,
+    **SETUP_BASE
+)

monitoring/tox.ini

@@ -0,0 +1,30 @@
+[tox]
+envlist =
+    py27,py34,py35,cover
+
+[testing]
+deps =
+    {toxinidir}/../core
+    pytest
+covercmd =
+    py.test --quiet \
+      --cov=google.cloud.monitoring \
+      --cov=unit_tests \
+      --cov-config {toxinidir}/.coveragerc \
+      unit_tests
+
+[testenv]
+commands =
+    py.test --quiet {posargs} unit_tests
+deps =
+    {[testing]deps}
+
+[testenv:cover]
+basepython =
+    python2.7
+commands =
+    {[testing]covercmd}
+deps =
+    {[testenv]deps}
+    coverage
+    pytest-cov

scripts/verify_included_modules.py

@@ -67,6 +67,7 @@
     'error_reporting',
     'language',
     'logging',
+    'monitoring',
     'pubsub',
     'resource_manager',
     'storage',

setup.py

@@ -58,6 +58,7 @@
     'google-cloud-error-reporting',
     'google-cloud-language',
     'google-cloud-logging',
+    'google-cloud-monitoring',
     'google-cloud-pubsub',
     'google-cloud-resource-manager',
     'google-cloud-storage',

tox.ini

@@ -15,6 +15,7 @@ deps =
     {toxinidir}/language
     {toxinidir}/error_reporting
     {toxinidir}/resource_manager
+    {toxinidir}/monitoring
     pytest
 covercmd =
     py.test --quiet \
@@ -88,6 +89,12 @@ covercmd =
       --cov-append \
       --cov-config {toxinidir}/.coveragerc \
       resource_manager/unit_tests
+    py.test --quiet \
+      --cov=google.cloud \
+      --cov=unit_tests \
+      --cov-append \
+      --cov-config {toxinidir}/.coveragerc \
+      monitoring/unit_tests
     coverage report --show-missing --fail-under=100
 
 [testenv]