Initial commit

Author: VladaPetrovic

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <year> <copyright holders>
+
+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.
+
+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.

README.md

@@ -1 +1,35 @@
-# push-api-python
+Databox bindings for Python
+===========================
+
+Setup
+-----
+
+You can install this package by cloning this directory and running:
+
+   ```$ python setup.py install```
+
+Getting Databox access tokens
+-----------------------------
+
+When in Databox Designer go to Account > Access tokens, then either create a new token or get already existing one.
+
+
+Using the Databox Python library
+--------------------------------
+
+    from databox import PushClient
+
+    # instantiate PushClient
+    client = PushClient('<access token>')
+
+    # push metric "answer1" with value 42 for today
+    client.add(42, "answer1")
+
+    # push metric "answer1" with value 42 for any other day
+    client.add(42, "answer1", "2015-05-01 10:10:10")
+
+    # send to Databox
+    print client.send()
+
+    # get last push
+    print client.lastPush()

databox/__init__.py

@@ -0,0 +1,11 @@
+# Databox Python bindings
+# Authors:
+# Vlada Petrovic <[email protected]>
+
+__package_name__ = 'databox'
+__version__ = '0.1'
+__author__ = 'Vlada Petrovic'
+__author_email__ = '[email protected]'
+__description__ = (
+    '''Push metrics to Databox. ''')
+__url__ = 'https://github.com/databox/databox-python'

databox/__init__.pyc

@@ -0,0 +1,59 @@
+import json
+import requests
+from requests.auth import HTTPBasicAuth
+
+class PushClient(object):
+    metrics = {"data":[]}
+
+    def __init__(self, api_key):
+        self.api_key = api_key
+        self.host = "https://push2new.databox.com"
+
+    def add(self, value, metric_key, date=None):
+        item = {}
+
+        # Add date if provided
+        if date is not None:
+            item["date"] = date
+
+        # Add value
+        item["$" + metric_key] = value
+
+        # Add to metrics
+        self.metrics["data"].append(item)
+
+    def addWithAttribute(self, value, metric_key, attribute_value, attribute_name, date=None):
+        item = {}
+
+        # Add date if provided
+        if date is not None:
+            item["date"] = date
+
+        # Add value
+        item["$" + metric_key] = value
+
+        # Add attribute
+        item[attribute_name] = attribute_value
+
+        # Add to metrics
+        self.metrics["data"].append(item)
+
+    def send(self):
+        payload = json.dumps(self.metrics)
+        response = requests.post(
+            self.host,
+            auth = HTTPBasicAuth(self.api_key, ""),
+            headers = {"Content-Type": "application/json"},
+            data = payload
+        )
+
+        return response.json()
+
+    def lastPush(self):
+        response = requests.post(
+            self.host + "/lastpushes/1",
+            auth = HTTPBasicAuth(self.api_key, ""),
+            headers = {"Content-Type": "application/json"}
+        )
+
+        return response.json()

databox/client.py

@@ -0,0 +1,19 @@
+import json
+from databox.client import PushClient
+
+# Create Push object
+pc = PushClient("339fb7fcxssg0sk48wocogo8wsck8408")
+
+# Add metrics
+pc.add(576.45, "sales.total", "2015-05-10 09:00:00")
+pc.add(42, "orders.total", "2015-05-10 09:00:00")
+
+# Send to Databox
+response = pc.send()
+
+if response["status"] == "ok":
+    print "Successfully pushed metrics to Databox!"
+else:
+    # get error info
+    lastPush = pc.lastPush()
+    print json.dumps(lastPush, indent=4)

databox/client.pyc

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

sample1.py

@@ -0,0 +1,17 @@
+import databox
+import setuptools
+
+install_requires = []
+install_requires.append('requests >= 2.7')
+
+setuptools.setup(
+    name=databox.__package_name__,
+    version=databox.__version__,
+    author=databox.__author__,
+    author_email=databox.__author_email__,
+    description=databox.__description__,
+    url=databox.__url__,
+    license='MIT',
+    packages=setuptools.find_packages(exclude=('tests',)),
+    install_requires=install_requires
+)