documentation + setupt + pylint fixes

esecules · esecules · commit 356690e8950b · 2016-08-04T23:38:22.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 *~
+*.pyc
 consumer_oauth.json
 *.pkl
 *bank*
diff --git a/README.md b/README.md
@@ -1,2 +1,29 @@
 # splitwise-csv
-Upload expenses to splitwise from a csv file. 
+Upload expenses to splitwise from a csv file.
+
+##API Keys
+You will need to obtain your own API keys from Splitwise.
+https://secure.splitwise.com/apps/new
+Set the "Callback URL" to "localhost:5000"
+Store your consumer key and consumer secret in src/consumer_oauth.json like so:
+```
+{
+    "consumer_key":"YOUR CONSUMER KEY",
+    "consumer_secret":"YOUR CONSUMER SECRET"
+}	
+```
+
+##Prerequesites
+`pip install -r setup/requirements.txt`
+
+##Usage
+###First Usage
+`python groupsplit.py <transactions csv> <splitwise group name>`
+You will need a Display to authorize this application by entering your login information in the browser spawned from here.
+It will ask you a few questions to determine which columns have the date, amount and description, etc. You can save the answers for future use. Then you go through each transaction one by one marking them to be split (or not). Finally it uploads them to your splitwise.
+###Normal Usage
+`python groupsplit.py <transactions csv> <splitwise group name>`
+It will skip right to going through your transactions one by one, so long as you have agreed to it remembering your csv layout
+##Resetting
+Just delete any or all of the .pkl (pickeled) files. 
+If you start to use a new csv layout you have to delete the csv_settings.pkl file 
diff --git a/setup/requirements.txt b/setup/requirements.txt
@@ -0,0 +1,4 @@
+Flask==0.10.1
+money==1.3.0
+oauthlib==1.0.3
+requests==2.9.1
diff --git a/src/groupsplit.py b/src/groupsplit.py
@@ -1,33 +1,37 @@
-#! /usr/bin/python
-
-import requests
+import os
 import csv
 import sys
-import oauthlib.oauth1
-import pprint
-import webbrowser
-import subprocess
-import os
-import pickle
 import json
+import pickle
+import pprint
 import urllib
+import requests
+import subprocess
+import webbrowser
+import oauthlib.oauth1
+from money import Money
 from pprint import pprint
 from datetime import datetime
 
-if os.path.isfile("consumer_oauth.json"):
-    with open("consumer_oauth.json", 'rb') as f:
-        consumer = json.load(f)
-        ckey=consumer['consumer_key']
-        csecret = consumer['consumer_secret']
-else:
-    with open("consumer_oauth.json", 'wb') as f:
-        json.dump({'consumer_key':'YOUR KEY HERE',
-                   'consumer_secret':'YOUR SECRET HERE'}, f)
-    exit("go to https://secure.splitwise.com/oauth_clients to obtain your keys. place them in consumer_oauth.json")
+def get_client_auth():
+    if os.path.isfile("consumer_oauth.json"):
+        with open("consumer_oauth.json", 'rb') as oauth_file:
+            consumer = json.load(oauth_file)
+            ckey = consumer['consumer_key']
+            csecret = consumer['consumer_secret']
+    else:
+        with open("consumer_oauth.json", 'wb') as oauth_file:
+            json.dump({'consumer_key':'YOUR KEY HERE',
+                       'consumer_secret':'YOUR SECRET HERE'}, oauth_file)
+        exit("go to https://secure.splitwise.com/oauth_clients to obtain your keys."+
+             "place them in consumer_oauth.json")
+    return ckey, csecret
 
 def get_client():
-    client = oauthlib.oauth1.Client( ckey, client_secret=csecret )
-    uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_request_token", http_method='POST')
+    ckey, csecret = get_client_auth()
+    client = oauthlib.oauth1.Client(ckey, client_secret=csecret)
+    uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_request_token",
+                                     http_method='POST')
     r = requests.post(uri, headers=headers, data=body)
     resp = r.text.split('&')
     oauth_token = resp[0].split('=')[1]
@@ -36,114 +40,140 @@ def get_client():
 
     webbrowser.open_new(uri)
 
-    p = subprocess.Popen(['./server.py'], stdout=subprocess.PIPE, shell=True)
-    stdout, stderr = p.communicate()
+    proc = subprocess.Popen(['./server.py'], stdout=subprocess.PIPE, shell=True)
+    stdout, stderr = proc.communicate()
+    if stderr:
+        exit(stderr)
     client = oauthlib.oauth1.Client(ckey, client_secret=csecret,
-                                    resource_owner_key=oauth_token, resource_owner_secret=oauth_secret,
+                                    resource_owner_key=oauth_token,
+                                    resource_owner_secret=oauth_secret,
                                     verifier=stdout.strip())
 
-    uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_access_token", http_method='POST')
-    r = requests.post(uri, headers=headers, data=body)
-    resp = r.text.split('&')
-    oauth_token = resp[0].split('=')[1]
-    oauth_secret = resp[1].split('=')[1]
+    uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_access_token",
+                                     http_method='POST')
+    resp = requests.post(uri, headers=headers, data=body)
+    tokens = resp.text.split('&')
+    oauth_token = tokens[0].split('=')[1]
+    oauth_secret = tokens[1].split('=')[1]
     client = oauthlib.oauth1.Client(ckey, client_secret=csecret,
-                                    resource_owner_key=oauth_token, resource_owner_secret=oauth_secret,
+                                    resource_owner_key=oauth_token,
+                                    resource_owner_secret=oauth_secret,
                                     verifier=stdout.strip())
-    with open('oauth_client.pkl', 'wb') as f:
-        pickle.dump(client, f)
+    with open('oauth_client.pkl', 'wb') as pkl:
+        pickle.dump(client, pkl)
     return client
 
-
-if os.path.isfile("oauth_client.pkl"):
-    with open('oauth_client.pkl', 'rb') as f:
-        client = pickle.load(f)
-else:
-    client = get_client()
-
-#uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_expenses?limit=3", http_method='GET')
-#r = requests.get(uri, headers=headers, data=body)
-#r = json.loads(r.text)
-
-uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_current_user", http_method='GET')
-r = requests.get(uri, headers=headers, data=body)
-r = json.loads(r.text)
-myId = r['user']['id']
-
-uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/get_groups", http_method='GET')
-r = requests.get(uri, headers=headers, data=body)
-r = json.loads(r.text)
-numFound = 0
-gid=''
-members={}
-for group in r['groups']:
-    if group['name'].lower() == sys.argv[2].lower():
-        gid = group['id']
-        members=[ m['id'] for m in group['members'] if m['id'] != myId ]
-        numFound += 1
-
-print members
-
-if numFound > 1:
-    exit("More than 1 group found")
-elif numFound < 1:
-    exit("No matching group")
-elif len( members ) < 1:
-    exit("No members in group")
-with open(sys.argv[1], 'rb') as csvfile:
-    reader = csv.reader(csvfile)
-    rows = [ x for x in reader ]
-
-
-print "These are the first two rows of your csv"
-print '\n'.join( [ str(t) for t in rows[0:2] ] )
-print 'Colnum numbers start at 0'
-dateCol = input("Which column has the date?")
-amountCol = input("Which column has the amount?")
-descCol = input("Which column has the description?")
-titleRow = raw_input("Does first row have titles? [Y/n]").lower() != 'n'
-if titleRow:
-    rows = rows[1:]
-transactions = [ {    "date":datetime.strftime(datetime.strptime(r[dateCol],"%m/%d/%y"), "%Y-%m-%dT%H:%M:%SZ"),
-                      "amount":-1 * float(r[amountCol]),
-                      "desc":r[descCol] }
-                 for r in rows if float(r[amountCol]) < 0 ]
-splits = []
-for t in transactions:
-    if raw_input("%s at %s $%s. Split? [y/N]" % (t['date'], t['desc'], t['amount'])).lower() == 'y':
-        splits.append(t)
-
-
-
-for s in splits:
-    numPeople=len(members) + 1
-    totalCents = int(s['amount'] * 100)
-    baseAmount = totalCents // numPeople
-    extraCents = totalCents - numPeople * baseAmount
-    params = {
-        "payment": 'false',
-        "cost": s["amount"],
-        "description": s["desc"],
-        "date": s["date"],
-        "group_id":gid,
-        "users__0__user_id":myId,
-        "users__0__paid_share":s["amount"],
-        "users__0__owed_share":baseAmount/100.0,
-    }
-    for i in range(len(members)):
-        params['users__%s__user_id' % (i+1)] = members[i]
-        params['users__%s__paid_share' % (i+1)] = 0
-        params['users__%s__owed_share' % (i+1)] = (baseAmount + 1)/100.0 if extraCents else baseAmount/100.0
-        extraCents-=1
-    params = urllib.urlencode(params)
-    uri, headers, body = client.sign("https://secure.splitwise.com/api/v3.0/create_expense?%s" % params, http_method='POST')
-    print "Request"
-    print uri
-    print "Headers:"
-    print headers
-    print "Body:"
-    print body
-    r = requests.post(uri, headers=headers, data=params)
-    resp = json.loads(r.text)
-    print "Response:"
-    pprint(resp)
+def split(total, num_people):
+    base = total * 100 // num_people / 100
+    extra = total - num_people * base
+    assert base * num_people + extra == total, "InternalError:" + \
+    " something doesnt add up here: %d * %d + %d != %d" %(base, num_people, extra, total)
+    return base, extra
+
+def api_call(url, http_method, client):
+    uri, headers, body = client.sign(url, http_method=http_method)
+    resp = requests.request(http_method, uri, headers=headers, data=body)
+    return resp.json()
+
+def main():
+    if os.path.isfile("oauth_client.pkl"):
+        with open('oauth_client.pkl', 'rb') as oauth_pkl:
+            client = pickle.load(oauth_pkl)
+    else:
+        client = get_client()
+
+    resp = api_call("https://secure.splitwise.com/api/v3.0/get_current_user", 'GET', client)
+    my_id = resp['user']['id']
+
+    resp = api_call("https://secure.splitwise.com/api/v3.0/get_groups", 'GET', client)
+    num_found = 0
+    gid = ''
+    members = {}
+
+    for group in resp['groups']:
+        if group['name'].lower() == sys.argv[2].lower():
+            gid = group['id']
+            members = [m['id'] for m in group['members'] if m['id'] != my_id]
+            num_found += 1
+
+    if num_found > 1:
+        exit("More than 1 group found")
+    elif num_found < 1:
+        exit("No matching group")
+    elif len(members) < 1:
+        exit("No members in group")
+
+    with open(sys.argv[1], 'rb') as csvfile:
+        reader = csv.reader(csvfile)
+        rows = [x for x in reader]
+
+
+    if os.path.isfile("csv_settings.pkl"):
+        with open('csv_settings.pkl', 'rb') as f:
+            date_col, amount_col, desc_col, has_title_row, local_currency, remember = pickle.load(f)
+
+    else:
+        print "These are the first two rows of your csv"
+        print '\n'.join([str(t) for t in rows[0:2]])
+        print 'Colnum numbers start at 0'
+        date_col = input("Which column has the date?")
+        amount_col = input("Which column has the amount?")
+        desc_col = input("Which column has the description?")
+        has_title_row = raw_input("Does first row have titles? [Y/n]").lower() != 'n'
+        local_currency = raw_input("What currency were these transactions made in?")
+        test = Money("1.00", local_currency)  #pylint: disable=W0612
+        remember = raw_input("Remember these settings? [Y/n]").lower() != 'n'
+
+    if remember:
+        with open("csv_settings.pkl", "wb") as pkl:
+            csv_settings = (date_col, amount_col, desc_col, has_title_row, local_currency, remember)
+            pickle.dump(csv_settings, pkl)
+
+    if has_title_row:
+        rows = rows[1:]
+    transactions = [{"date":datetime.strftime(datetime.strptime(r[date_col], "%m/%d/%y"), "%Y-%m-%dT%H:%M:%SZ"),
+                     "amount":-1 * Money(r[amount_col], local_currency),
+                     "desc":r[desc_col]}
+                    for r in rows if float(r[amount_col]) < 0]
+    splits = []
+    for t in transactions:
+        if raw_input("%s at %s $%s. Split? [y/N]" % (t['date'], t['desc'], t['amount'])).lower() == 'y':
+            splits.append(t)
+
+
+    print "Uploading %d splits" % len(splits)
+    one_cent = Money("0.01", local_currency)
+    for s in splits:
+        num_people = len(members) + 1
+        base, extra = split(s['amount'], num_people)
+        params = {
+            "payment": 'false',
+            "cost": s["amount"].amount,
+            "description": s["desc"],
+            "date": s["date"],
+            "group_id": gid,
+            "currency_code": local_currency,
+            "users__0__user_id": my_id,
+            "users__0__paid_share": s["amount"].amount,
+            "users__0__owed_share": base.amount,
+        }
+        for i in range(len(members)):
+            params['users__%s__user_id' % (i+1)] = members[i]
+            params['users__%s__paid_share' % (i+1)] = 0
+            params['users__%s__owed_share' % (i+1)] = (base + one_cent).amount if extra else base.amount
+            extra -= one_cent
+        paramsStr = urllib.urlencode(params)
+        uri = "https://secure.splitwise.com/api/v3.0/create_expense?%s" % (paramsStr)
+        resp = api_call(uri, 'POST', client)
+        if resp["errors"]:
+            print "URI:"
+            print uri
+            pprint(resp)
+        else:
+            sys.stdout.write(".")
+            sys.stdout.flush()
+    sys.stdout.write("\n")
+    sys.stdout.flush()
+
+if __name__ == "__main__":
+    main()

-Original file line number
+Diff line change
@@ @@ -1,4 +1,5 @@ @@
 *~
 +*.pyc
 consumer_oauth.json
 *.pkl
 *bank*