Python client for the Cloud Foundry deployment tracker
This is the source code for cf-deployment-tracker, a pip package that can track and report details of a demo/tutorial that has been deployed to Cloud Foundry.
## How To Use
Open a terminal and run
`bash pip install cf-deployment-tracker `
Import the package at the entry point of your app and call the track() function.
`python import cf_deployment_tracker cf_deployment_tracker.track() `
Add a copy of the Privacy Notice to the readme file.
Note: All apps that have deployment tracker must include the Privacy Notice.
## Example app
To see how to include this into your app please visit [Bluemix Hello World](https://github.com/IBM-Bluemix/python-hello-world-flask). You will want to pay attention to [setup.py](https://github.com/IBM-Bluemix/python-hello-world-flask/blob/master/setup.py) and [hello.py](https://github.com/IBM-Bluemix/python-hello-world-flask/blob/master/hello.py).
## Privacy Notice
Sample web applications that include this package may be configured to track deployments to [IBM Bluemix](https://www.bluemix.net/) and other Cloud Foundry platforms. The following information is sent to a [Deployment Tracker](https://github.com/IBM-Bluemix/cf-deployment-tracker-service) service on each deployment:
- Python package version
- Python repository URL
- Application Name (application_name)
- Application GUID (application_id)
- Application instance index number (instance_index)
- Space ID (space_id)
- Application Version (application_version)
- Application URIs (application_uris)
- Labels of bound services
- Number of instances for each bound service and associated plan information
This data is collected from the setup.py file in the sample application and the VCAP_APPLICATION and VCAP_SERVICES environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.
## Disabling Deployment Tracking
Please see the README for the sample application that includes this package for instructions on disabling deployment tracking, as the instructions may vary based on the sample application in which this package is included.
See [License.txt](License.txt) for license information.