0.0.4

Author: j12y

.gitignore

@@ -0,0 +1,32 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+build/
+dist/
+eggs/
+.eggs/
+*.egg-info/
+*.egg
+
+# Shell Environment
+.bash_history
+.cache/
+.cf/
+
+# Project-specific
+environment.sh
+
+# Testing
+.tox/
+.coverage
+coverage/
+.coverage.*
+nosetests.xml
+coverage.xml
+*,cover

LICENSE

@@ -0,0 +1,43 @@
+Copyright (c) 2016 General Electric Company operating through GE Digital LLC
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+Other than the license expressly provided herein no license to or grant of any
+other intellectual property owned, controlled or licensed by General Electric
+Company or its affiliates (“GE”) is expressly or impliedly granted.  GE
+reserves all rights with respect to all such intellectual property and nothing
+in this license shall be deemed a waiver of such rights.
+
+It is expressly understood, acknowledged and agreed that you may provide
+General Electric reasonable suggestions, comments and feedback regarding the
+Software, including but not limited to usability, bug reports and test results,
+with respect to Software testing (collectively, "Feedback"). If you provide
+such Feedback to GE, you shall grant GE worldwide, non-exclusive, perpetual,
+irrevocable, royalty free, fully paid up rights to utilize such Feedback in any
+GE product or service in GE’s sole discretion.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.  NO GUARANTEE OF UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE
+OPERATION IS MADE.
+
+THESE LICENSED PROGRAMS MAY BE USED AS PART OF A DEVELOPMENT ENVIRONMENT, AND
+MAY BE COMBINED WITH OTHER CODE BY END-USERS. LICENSOR IS NOT ABLE TO GUARANTEE
+THAT THE LICENSED PROGRAMS WILL OPERATE WITHOUT DEFECTS WHEN USED IN
+COMBINATION WITH END-USER SOFTWARE. LICENSEE IS ADVISED TO SAFEGUARD IMPORTANT
+DATA, TO USE CAUTION, AND NOT TO RELY IN ANY WAY ON THE CORRECT FUNCTIONING OR
+PERFORMANCE OF ANY COMBINATION OF END-USER SOFTWARE AND THE LICENSED PROGRAMS
+AND/OR ACCOMPANYING MATERIALS. LICENSEE IS ADVISED NOT TO USE ANY COMBINATION
+OF LICENSED PROGRAMS AND END-USER PROVIDED SOFTWARE IN A PRODUCTION ENVIRONMENT
+WITHOUT PRIOR SUITABILITY AND DEFECT TESTING.

README.md

@@ -0,0 +1,116 @@
+
+# PredixPy
+
+The Predix Python SDK aims to help accelerate application development with
+client libraries for commonly used Predix Platform Services.  This framework
+provides helper methods and classes.
+
+You can find out more about services in the [Predix Service Catalog][catalog].
+
+## Installation
+
+To start using the SDK downloaded from PyPI:
+
+```
+$ pip install predix
+```
+
+If you want to install from source, see developer section below.
+
+# Basic Usage
+
+## Administration
+
+When you have done a `cf login` to a Cloud Foundry endpoint you can begin
+creating services in Python.
+
+```
+# Create a UAA service instance as most services require it
+# and create a client for your application
+import predix.admin.uaa
+uaa = predix.admin.uaa.UserAccountAuthentication()
+uaa.create('admin-secret')
+
+# Cloud Foundry applications require client authorization and a
+# manifest helps for when you `cf push`.
+uaa.create_client('my-client', 'my-client-secret')
+uaa.add_to_manifest('./manifest.yml')
+uaa.add_client_to_manifest('my-client', 'my-client-secret', './manifest.yml')
+
+# Create a Time Series service instance
+import predix.admin.timeseries
+ts = predix.admin.timeseries.TimeSeries()
+ts.create()
+
+# Let client use this service
+ts.grant_client('my-client')
+ts.add_to_manifest('./manifest.yml')
+
+```
+
+## Applications
+
+Once your space has been configured, you can use PredixPy to work with
+the services in your applications.
+
+```
+# If not in a Cloud Foundry deployed environment and testing locally,
+# you can use this manifest utility to load environment variables
+# into your process.
+
+import predix.app
+manifest = predix.app.Manifest('./manifest.yml')
+
+# Start using the services
+
+import predix.data.timeseries
+
+ts = predix.data.timeseries.TimeSeries()
+ts.send('test', 12)
+print(ts.get_values('test'))
+```
+
+# Developing PredixPy
+
+## Setup Environment
+
+To install into your environment for use in editable mode:
+
+```
+$ pip install -e .
+```
+
+Recommend using `virtualenv` or `venv`.  If you prefer to use a docker
+environment there is one with cloud foundry pre-installed:
+
+```
+$ docker run -it --rm --volume=$(pwd):/home/app j12y/cf-ade-py
+```
+
+## Quality
+
+To check coding style:
+```
+$ python setup.py flake8
+```
+
+To check test coverage:
+```
+$ python setup.py nosetests --with-coverage --cover-xml
+```
+
+## Distribution
+
+Running setuptools sdist will produce a file `dist/predix-x.y.z.tar.gz` which
+can be useful.  It is not only the file needed to publish to PyPI, it can be
+used in the **vendor/** folder used by the python_buildpack when deploying an
+app to Cloud Foundry.
+```
+$ python setup.py sdist
+```
+
+
+
+---
+[catalog]: https://www.predix.io/catalog/services
+

__init__.py

@@ -0,0 +1,71 @@
+
+import os
+
+import predix.app
+import predix.security.uaa
+import predix.admin.service
+
+
+class AccessControl(object):
+    """
+    Access Control provides attribute based access control.
+    """
+    def __init__(self, name=None, uaa=None, *args, **kwargs):
+        super(AccessControl, self).__init__(*args, **kwargs)
+        self.service_name = 'predix-acs'
+        self.plan_name = 'Free'
+        self.service = predix.admin.service.PredixService(self.service_name,
+                self.plan_name, name=name, uaa=uaa)
+
+    def exists(self):
+        """
+        Returns whether or not this service already exists.
+        """
+        return self.service.exists()
+
+    def create(self):
+        """
+        Create an instance of the Access Control Service with the typical
+        starting settings.
+        """
+        self.service.create()
+        os.environ['PREDIX_ACS_URI'] = self.service.settings.data['uri']
+        os.environ['PREDIX_ACS_ZONE_ID'] = self.service.serttings.data['zone']['http-header-value']
+
+    def grant_client(self, client_id):
+        """
+        Grant the given client id all the scopes and authorities
+        needed to work with the access control service.
+        """
+        zone = self.service.settings.data['zone']['oauth-scope']
+
+        scopes = ['openid', zone,
+                  'acs.policies.read', 'acs.attributes.read',
+                  'acs.policies.write', 'acs.attributes.write']
+
+        authorities = ['uaa.resource', zone,
+                  'acs.policies.read', 'acs.policies.write',
+                  'acs.attributes.read', 'acs.attributes.write']
+
+        self.service.uaa.uaac.update_client_grants(client_id, scope=scopes,
+                authorities=authorities)
+
+        return self.service.uaa.uaac.get_client(client_id)
+
+    def add_to_manifest(self, manifest_path):
+        """
+        Add details to the manifest that applications using
+        this service may need to consume.
+        """
+        manifest = predix.app.Manifest(manifest_path)
+
+        # Add this service to list of services
+        manifest.add_service(self.service.name)
+
+        # Add environment variables
+        manifest.add_env_var('PREDIX_ACS_URI',
+                self.service.settings.data['uri'])
+        manifest.add_env_var('PREDIX_ACS_ZONE_ID',
+                self.service.settings.data['zone']['http-header-value'])
+
+        manifest.write_manifest()

predix/__init__.py

@@ -0,0 +1,48 @@
+
+import predix.app
+import predix.security.uaa
+import predix.admin.service
+
+
+class AnalyticsFramework(predix.admin.spaces.SpaceManager):
+    """
+    Analytics framework.
+    """
+    def __init__(self, plan_name=None, name=None, uaa=None, *args, **kwargs):
+        super(AnalyticsFramework, self).__init__(*args, **kwargs)
+        self.service_name = 'predix-analytics-framework'
+        self.plan_name = plan_name or 'Free'
+        self.service = predix.admin.service.PredixService(self.service_name,
+                self.plan_name, name=name, uaa=uaa)
+
+    def exists(self):
+        """
+        Returns whether or not this service already exists.
+        """
+        return self.service.exists()
+
+    def create(self, asset, timeseries, client_id, client_secret,
+            ui_client_id=None, ui_client_secret=None):
+        """
+        Create an instance of the Analytics Framework Service with the
+        typical starting settings.
+
+        If not provided, will reuse the runtime client for the ui
+        as well.
+        """
+        assert isinstance(asset, predix.admin.asset.Asset), \
+            "Require an existing predix.admin.asset.Asset instance"
+        assert isinstance(timeseries, predix.admin.timeseries.TimeSeries), \
+            "Require an existing predix.admin.timeseries.TimeSeries instance"
+
+        parameters = {
+            'predixAssetZoneId': asset.get_zone_id(),
+            'predixTimeseriesZoneId': timeseries.get_query_zone_id(),
+            'runtimeClientId': client_id,
+            'runtimeClientSecret': client_secret,
+            'uiClientId': ui_client_id or client_id,
+            'uiClientSecret': ui_client_secret or client_secret,
+            'uiDomainPrefix': self.service.name,
+        }
+
+        self.service.create(parameters=parameters)

predix/admin/__init__.py

@@ -0,0 +1,72 @@
+
+import os
+
+import predix.app
+import predix.security.uaa
+import predix.admin.service
+
+
+class Asset(object):
+    """
+    Asset Service provides asset management functionality.
+    """
+    def __init__(self, plan_name=None, name=None, uaa=None, *args, **kwargs):
+        super(Asset, self).__init__(*args, **kwargs)
+        self.service_name = 'predix-asset'
+        self.plan_name = plan_name or 'Free'
+        self.service = predix.admin.service.PredixService(self.service_name,
+                self.plan_name, name=name, uaa=uaa)
+
+    def exists(self):
+        """
+        Returns whether or not this service already exists.
+        """
+        return self.service.exists()
+
+    def create(self):
+        """
+        Create an instance of the Asset Service with the typical
+        starting settings.
+        """
+        self.service.create()
+        os.environ['PREDIX_ASSET_URI'] = self.service.settings.data['uri']
+        os.environ['PREDIX_ASSET_ZONE_ID'] = self.get_zone_id()
+
+    def grant_client(self, client_id):
+        """
+        Grant the given client id all the scopes and authorities
+        needed to work with the asset service.
+        """
+        zone = self.service.settings.data['zone']['oauth-scope']
+
+        scopes = ['openid', zone]
+
+        authorities = ['uaa.resource', zone]
+
+        self.service.uaa.uaac.update_client_grants(client_id, scope=scopes,
+                authorities=authorities)
+
+        return self.service.uaa.uaac.get_client(client_id)
+
+    def get_zone_id(self):
+        """
+        Returns the Predix-Zone-Id used for this service.
+        """
+        return self.service.settings.data['zone']['http-header-value']
+
+    def add_to_manifest(self, manifest_path):
+        """
+        Add details to the manifest that applications using
+        this service may need to consume.
+        """
+        manifest = predix.app.Manifest(manifest_path)
+
+        # Add this service to list of services
+        manifest.add_service(self.service.name)
+
+        # Add environment variables
+        manifest.add_env_var('PREDIX_ASSET_URI',
+                self.service.settings.data['uri'])
+        manifest.add_env_var('PREDIX_ASSET_ZONE_ID', self.get_zone_id())
+
+        manifest.write_manifest()