0.0.5 - new conversions, documentation

Author: robswc

README.md

@@ -8,12 +8,12 @@ Unofficial Quickbase JSON API wrapper for python
 
 Makes life a little easier!
 
-## Quickstart
+# Quickstart
 
-### Installation
+## Installation
 To install, run `pip install quickbase-json-api-client`
 
-### Initialize Client
+## Initialize Client
 Use the following code to create and initialize a client object. 
 ```
 from quickbase_json.client import QuickbaseJSONClient # import client
@@ -24,7 +24,7 @@ client = QuickbaseJSONClient(realm="yourRealm", auth="userToken")
 Where `yourRealm` is the name (subdomain) of your Quickbase Realm and `userToken` is the user token used to authenticate
 with the realm.
 
-### Query Records
+## Query Records
 Querying for records is one of the most useful features of the Quickbase JSON API.  Querying records with QJAC can be done
 using the following code
 
@@ -33,16 +33,28 @@ using the following code
 Where `tableId` is the ID of the table you wish to query from, `fids` is a list of field IDs you wish to receive and `queryString`
 is a quickbase [query string](https://help.quickbase.com/api-guide/componentsquery.html).
 
-### Response Objects
+## Response Objects
 
 A `QBResponse` object is returned when querying records with QJAC.  A `QBResponse` has several methods that make
-handling returned data easier.  Here are a few of the most useful ones:
+handling returned data easier.  Here are a few of the most useful ones.
 
-**denest()**
+### Response Methods
+
+- **denest()**
 
 Denests the data.  I.e. changes `{'fid': {'value': 'actualValue'}}` to `{'fid': 'actualValue'}`
 
-**orient(orient='records', key='3')**
+- **orient(orient='records', key='3')**
 
 Orients the data.  Currently, the only option is 'records'.  This will orient the returned data into a "record like structure", i.e. changes
-`{'fid': 'actualValue', 'fid': 'actualValue'}` to `{'key': {etc: etc}}`
+`{'fid': 'actualValue', 'fid': 'actualValue'}` to `{'key': {etc: etc}}`
+
+- **convert()**
+
+Converts the data, based on fields and provided arguments.  For example, calling `convert('datetime')` will convert all data with fields
+of the 'date time' type to python datetime objects.  Other conversions are 'currency' and 'int'.
+
+- **round_ints()**
+
+Rounds all float integers into whole number ints.  i.e. converts `55.0` to `55`.
+

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = quickbase-json-api-client
-version = 0.0.3
+version = 0.0.5
 author = Robert Carroll
 author_email = rob@shenandoah.capital
 description = Python wrapper for quickbase JSON API.

src/quickbase_json/qb_response.py

@@ -238,7 +238,9 @@ def convert_type(self, field_type, **kwargs):
         """
 
         def c_datetime():
-
+            """
+            Helper function that converts date time QB fields to datetime ojects.
+            """
             for f in self.get('fields'):
                 fid = str(f.get('id'))
                 if f.get('type') == 'date time':
@@ -251,7 +253,24 @@ def c_datetime():
                             d.update({fid: {
                                 'value': datetime.datetime.strptime(d.get(fid).get('value'), '%Y-%m-%dT%H:%M:%S.%fZ')}})
 
+        def c_currency(currency_format):
+
+            for f in self.get('fields'):
+                fid = str(f.get('id'))
+                if f.get('type') == 'numeric currency':
+
+                    if 'denest' in self.operations:
+                        for d in self.get('data'):
+                            fmt = currency_format + "{:,.2f}".format(d.get(fid))
+                            d.update({fid: fmt})
+                    else:
+                        for d in self.get('data'):
+                            fmt = currency_format + "{:,.2f}".format(d.get(fid).get('value'))
+                            d.update({fid: {'value':  fmt}})
+
         if field_type == 'datetime':
             c_datetime()
+        if field_type == 'numeric currency' or field_type == 'currency':
+            c_currency(kwargs.get('fmt'))
 
         return self

tests/sample_data.py

@@ -61,3 +61,31 @@
 	skip             0               
 
 """
+
+record_data_currency = {
+    "data": [
+        {
+            "6": {
+                "value": 55.55
+            },
+        },
+        {
+            "6": {
+                "value": 13
+            },
+        }
+    ],
+    "fields": [
+        {
+            "id": 6,
+            "label": "Cost",
+            "type": "numeric currency"
+        }
+    ],
+    "metadata": {
+        "totalRecords": 2,
+        "numRecords": 1,
+        "numFields": 1,
+        "skip": 0
+    }
+}

tests/test_response.py

@@ -48,6 +48,18 @@ def test_convert_datetime():
     assert isinstance(dt_test2, datetime.datetime)
 
 
+# test currency convert
+def test_convert_currency():
+    # test datetime convert w/o denest
+    res = QBResponse('records', sample_data=deepcopy(sample_data.record_data_currency))
+    res.convert_type('numeric currency', fmt='$')
+    res.denest()
+
+    # make sure both are formatted correctly
+    assert res.data()[0].get('6') == '$55.55'
+    assert res.data()[1].get('6') == '$13.00'
+
+
 # test datetime convert
 def test_round_ints():
     # test converting ints with floating point