aemx/ubudget

Setup

Requirements

A UNIX-like operating system (Linux, macOS)
Python 3.6+
curl or wget
Robpol86's terminaltables module

Installation

To install μbudget, use curl or wget within your desired installation directory.

with curl:

sudo curl -L https://github.com/aemx/ubudget/archive/0.0.1.tar.gz -o 0.0.1.tar.gz
sudo tar -xzf 0.0.1.tar.gz && sudo rm -r 0.0.1.tar.gz

with wget:

sudo wget https://github.com/aemx/ubudget/archive/0.0.1.tar.gz -O 0.0.1.tar.gz
sudo tar -xzf 0.0.1.tar.gz && sudo rm -r 0.0.1.tar.gz

Using μbudget

Running for the first time

An example dataset named data.json is provided with all copies of μbudget. To test this dataset, run python ubudget.py from within the ubudget-0.0.1/ directory.
Your output should look something like this:

If this is not the case, please open an issue and describe the problem here.

Adding your own data

Within the data.json file are two lists, "p" and "t".

The "p" (percentages) array contains three values, representing a percentage of money to save, spend, and keep for emergencies.
The "t" (transactions) array contains four arrays, "n", "d", "t", and "a".
- The "n" array represents a name for your transaction. This should be around 10 characters, but is unlimited.
- The "d" array represents an ISO 8601 date for your transaction. This should be in a %Y-%m-%d format.
- The "t" array represents a transaction type. This MUST be either a case-sensitive D for deposit or W for withdrawal.
- The "a" array represents an amount. This MUST be a float value.

Uninstallation

To uninstall μbudget, simply type the following from within the directory containing ubudget-0.0.1/:

sudo rm -r ubudget-0.0.1

License

This project is licensed under the MIT License.

Last updated on 01 September 2017 for version 0.0.1

aemx / ubudget