README.md

Busy People Budget

The Busy People Budget is designed to provide personalized insights into financial health with only a few lines of code. The tool includes net worth calculation, built-in reports, and offers the flexibility to create a custom financial summary. The README contains example code and a tutorial; let me know your thoughts through GitHub Issues and Pull Requests!

Install

go get github.com/cassamajor/budget

Usage

Simple Summary: Income v Expenses

package main

import "github.com/cassamajor/budget"

func main() {
	budget.DefaultBudget()
}

Set your Personal Access Token as an environment variable, and execute the program:

export YNAB_PAT=personal-access-token
go run main.go

Output:

Ready to Assign: $529.15
Assigned: $3,703.49
Underfunded: $5,390.30
Income: $3,812.50
Expenses: $1,737.59

Advanced Summary: Detailed and Personalized Insights

The example can be found here: examples/advanced/main.go

Set your Personal Access Token as an environment variable, and execute the program:

export YNAB_PAT=personal-access-token
go run examples/advanced/main.go

Output:

Our Net Worth is $272,005.98.

We have $19,881.21 cash in our bank accounts.

We have $2,079.27 saved towards medical expenses.
We have $25,874.76 saved towards retirement.
We have $159,581.51 equity in our home.

We need an additional $5,390.30 to fund this month. At the end of the month, we will have roughly -$1,682.89 remaining. Unplanned purchases are not accounted for in this estimate.

We have $170,918.49 remaining on our mortgage.
We have $33,067.28 in student loans.
We have $18,315.82 in auto loans.

Tutorial: Brief Introduction to Features and Functionality

WithMonth and WithToken are functional options that can be passed into the NewBudget function.

If no options are passed, the current month is used, and the token is read from the environment variable YNAB_PAT.

month := budget.WithMonth("2024-07-01")
token := budget.WithToken("personal-access-token")

b, err := budget.NewBudget(month, token)

---

The Budget method returns a Summary. Included in the Summary are two structs: Month and Accounts.

Account balances are stored in the Accounts struct, and will always reflect current amounts; it is not affected by the WithMonth option.

Income and expense totals are stored in the Month struct. Both structs contain built-in reports that print to the console.

summary := b.Budget()

summary.Month.Report()
summary.Accounts.Report()

---

The NetWorth method is attached to the Accounts struct. It calculates the sum of all assets and liabilities and returns a NetWorth struct. The NetWorth struct has a Total method that returns the total net worth.

nw := summary.Accounts.NetWorth()
nw.Total()

---

AccountMap is a global variable that provides the ability to query accounts by their name.

c := budget.AccountMap["Checking"]

fmt.Println(c.Balance)