split_money_evenly

This light-weight command line applet allows you to calculate money stuffs easily.

Have you ever encountered such a situation:

You, Allen, Alex, and Lily had a fantastic day. However, you paid for the lunch, Allen paid for the Uber ride, Alex booked four movie tickets online for Avengers 5, and Lily transfered Allen 40 bucks mistakenly.

You folks want to split the money evenly but it seems so freakingly involved to get a correct amount of money to whom each one should transfer. Probably even James, the guy who is super frigging good at maths, will also be stuck by this problem… for 30 seconds.

Don't worry

split_money_evenly comes to help.

How do I install it?

For programmers

1. open terminal (or your favorite command line tool)

2. run $ git clone git@github.com:JamesSMF/split_money_evenly.git

3. run python3 money.py inside the git directory diectly. (in python 3)

For non-programmers

1. Prepare a mac, and make sure you have python 3 installed since this program is written in python 3.

2. Click the green button "clone or download"

3. Click Download ZIP

4. Open System Preference -> Security & Privacy

5. Click the small lock and enter your password (Do I seem like a fraud…? Trust me tho lol.)

6. Click the small plus sign and select Downloads -> split_money_evenly-master -> split_money_evenly

(There are 2 options for the next step)

If you know how to use spotlight search:

Press command + <space> and type "split_money_evenly" (without quotation marks) and press enter.

else:

Open the Finder, and go to Downloads -> split_money_evenly-master. Click the split_money_evenly app to run it.

Basic Usage

run

python3 money.py

to start the program.

Note: there is no database for the program. So each time you run the program, all the previous datas are cleared.

New Event

Type "New event" or "new event" or simply "ne" to create a new event.

Then, the program will prompt the user to enter people's names. You can split names by any character you like, but not English letters.

After that, enter the event name. For example, "A Fabulous day".

When you see

>>>

at the beginning of the line, you have successfully entered "event mode"

Event Mode

Basic syntax

• <person> trans <person> <amount of money>
• <person> pay <amount of money>

Feel free to make those verbs gramatically correct, but please try not to change the basic structure of the syntax.

Enter "q" or "Q" to quit event mode and go back to normal mode.

Result

When you type "result" or "Result", the program will enter its calculation process and soon return the final result.

The result is normally in this form:

<name> {<person>: <amount of money>, <person>: <amount of money>, ... }

...

<name> is the person who should transfer <amount of money> to <person>.

Q

Enter "Q" or "q" to exit the program cleanly.

Version 1.2: File Mode

The newly added feature allows the user to input a file.

The basic syntax has not changed with some parts slightly different.

Here is an example file

Event: A fantanstic day in San Fransisco
People: Jack, Flora, Mely
   Jack paid 40 bucks for lunch
   Mely trans Jack 10 bucks
   Flora paid 20 dollars for Uber

Event: House rent
People: James, George, Johanna
   Johanna paid 3000 bucks for the rent
   James paid 200 for garbage disposal fee
   George trans James 30 bucks
   
result

Indentations and empty lines are not necessary but good for readibility.

Runnnig python money.py <file name> will generate the result according to the content in the file.

Also, the language has been changed from python 2 to python 3 since python 2 is obviously stepping out of the stage.

Version 2.0: Optimized the algorithm

The overall algorithm has been more complicated and therefore the running time prolonged. However, this improvement reduces most of redundant transfers.

Version 2.1: Fixed some algorithm problems

This version merges version 1.0 algorithm and version 2.0 algorithm to make the algorithm more accurate so that it reduces more redundant transactions.