Merge pull request #26 from PredixDev/develop

Release Candidate 1.0.0rc1

Author: j12y

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 
 # Distribution / packaging
 build/
+_build/
 dist/
 eggs/
 .eggs/

LICENSE.md

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017, General Electric Company
+Copyright (c) 2018, General Electric Company
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -0,0 +1,78 @@
+
+PredixPy
+========
+
+The Predix Python SDK has been crafted to help Python developers have quick
+success writing applications using Predix Services.
+
+Install it from PyPI::
+
+    pip install predix
+
+If that isn't working for you, we highly recommend `The Hitchiker's Guide to
+Properly Installing Python`_ to learn about installing ``python``,
+``pip``, and ``virtualenv`` for your environment.  For industrial environments, you
+may also need to learn how to set your proxies.
+
+.. _The Hitchiker's Guide to Properly Installing Python: http://docs.python-guide.org/en/latest/starting/installation/
+
+See the `Predix Volcano App`_ for a full demonstration of the SDK
+used in a Python Flask App.
+
+.. _Predix Volcano App: https://github.com/PredixDev/predix-volcano-app
+
+Getting Started
+---------------
+
+Please see the `Getting Started Guide`_ for a walkthrough and introduction to
+basic usage of the Python SDK.
+
+.. _Getting Started Guide: https://predixpy.run.aws-usw02-pr.ice.predix.io/getting-started/index.html
+
+- [x] `User Account and Authentication`_ (UAA)
+- [x] `Predix Asset`_
+- [x] `Predix Time Series`_
+- [x] `Predix Access Control`_ (ACS)
+- [x] `Predix Blob Store`_
+- [x] `Predix Cache`_ (Redis)
+- [x] `Predix Database as a Service`_ (PostgreSQL)
+- [x] `Predix Event Hub`_
+- [x] `Logging`_
+- more...
+
+.. _User Account and Authentication: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#user-accounts-and-authentication
+.. _Predix Asset: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#asset
+.. _Predix Time Series: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#time-series
+.. _Predix Access Control: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#access-control
+.. _Predix Blob Store: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#blob-store
+.. _Predix Cache: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#predix-cache
+.. _Predix Database as a Service: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#predix-dbaas
+.. _Predix Event Hub: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#event-hub
+.. _Logging: https://predixpy.run.aws-usw02-pr.ice.predix.io/services/index.html#logging
+
+Getting Help
+------------
+
+If something doesn't work as expected and you want help:
+
+- Create a `GitHub Issue`_ in this project
+- Ask on the `Predix Developer Forum`_
+- Send email to [email protected] and we'll respond as soon as we can
+
+.. _GitHub Issue: https://github.com/PredixDev/predixpy/issues
+.. _Predix Developer Forum: https://forum.predix.io/index.html
+
+Contributors
+------------
+
+See the `Developing PredixPy Guide`_ if you want to contribute or
+modify the SDK itself.
+
+If you send a PR it will be reviewed as soon as possible but contribution
+guidelines and agreements for external parties have not been finalized.
+
+.. _Developing PredixPy Guide: https://predixpy.run.aws-usw02-pr.ice.predix.io/devguide/index.html
+
+.. image:: https://ga-beacon.appspot.com/UA-82773213-1/predixpy/readme?pixel
+   :target: https://github.com/PredixDev/predixpy
+

README.rst

@@ -57,7 +57,7 @@
 
 # General information about the project.
 project = u'PredixPy'
-copyright = u'2017, GE Digital'
+copyright = u'2018, General Electric Company'
 author = u'Jayson DeLancey'
 
 # The version info for the project you're documenting, acts as replacement for

docs/Contributor-License-Agreement.pdf

@@ -16,7 +16,7 @@ The Predix Asset Service requires a ``uri`` as part of the body whenever you
 post a collection.  The ``predix.data.asset.AssetCollection`` class will help
 generate this for you but sometimes you want to do that for yourself.
 
-..
+::
 
     import predix.app
     app = predix.app.Manifest()

docs/_build/html/Staticfile

@@ -0,0 +1,41 @@
+
+.. _cache-cookbook:
+
+Predix Cache Recipes
+--------------------
+
+Recipes for working with Predix Python SDK and the Predix Cache service.
+
+It is expected you used the SDK to create the service so that it is configured
+by Manifest.
+
+How-To Use the Redis CLI
+........................
+
+Predix Cache can only be used from within the Predix Cloud Foundry environment
+so you won't be able to use Redis CLI running on your local machine.  As an
+alternative, you can install an app into your space called GoTTY and then
+install the Redis CLI.
+
+First, see :ref:`gotty-setup` for instructions on setting up GoTTY.  Once
+deployed to Predix Cloud, log into that environment and run the following
+commands.
+
+::
+
+    ./redis-cli
+
+This is an alias to a script that will lookup the host, port, and password from
+your VCAP environment variables to launch ``redis-cli``.
+
+See the official redis-cli docs for more details on how to use it once you
+are connected.
+
+How-To Build a Web App with Cache
+.................................
+
+See the following demo application for an example of a Flask app that uses
+Predix Cache with PredixPy.
+
+https://github.com/j12y/predixpy-flask-cache
+