Bouch

Bouch is the budget pouch. A simple tool to calculate and project your annual personal budget based on fiscal quarter expenditures, income, assets, and debts.

Use it to help establish an annual financial plan, set monetary goals, and gain perspective on your financial health.

Install

To install bouch via RubyGems simple execute this command from a command-line interface:

gem install bouch

To use bouch as part of your Ruby Project add this line to your Gemfile:

gem 'bouch'

Usage

Bouch takes a simple YAML file as its primary data input. This will be referred to as a budget pouch file.

Generate an example budget pouch file and run it:

bouch example > my_budget.yml
bouch my_budget.yml

Generate an Example Pouch File

You can generate an example budget pouch YAML file to get started:

bouch example > my_budget.yml

Edit my_budget.yml with your own data, then run:

bouch my_budget.yml

CLI Flags

bouch [YAML_FILE]       # Calculate and display budget
bouch example           # Print an example budget pouch YAML
bouch --version / -v    # Print version
bouch --help / -h       # Print usage help

Example Output

You should see the example budget summary output (with colorized sections):

──────────────────────────────────────────
BUDGET
──────────────────────────────────────────
Quarter 1:                     3025.00
Quarter 2:                     3025.00
Quarter 3:                     3025.00
Quarter 4:                     3025.00
Budget Annual Total:           12100.00
──────────────────────────────────────────
INCOME
──────────────────────────────────────────
Budget Annual Income:          28808.00
Budget Income Percent:         42.00%
──────────────────────────────────────────
ASSETS
──────────────────────────────────────────
Assets Total:                  500.00
Equity Total:                  500.00
Net Worth:                     1000.00
──────────────────────────────────────────
DEBTS
──────────────────────────────────────────
Debt Total:                    420.00
Debt Ratio:                    0.4200
Debt Ratio Percent:            42.00%
──────────────────────────────────────────

Pouch Schema

To use bouch to calculate your own budget you must create a customized budget pouch file.

Budget pouch files are written in Ruby friendly YAML and currently use the following schema:

• Nested mappings, also know as hashes in Ruby
• Think of hashes as simple groupings of keys value pairs
• Primary hash keys:
  • Budget
  • Salary
  • Assets (optional)
  • Equity (optional)
  • Debts (optional)
• Budget nested keys and values:
  • Q1
    • foo
      • Value: Integer or Float
      • Equals a single budget item's quarterly cost
    • bar
      • cost
        • Value: Integer or Float
        • Equals the repeated budget item's monthly cost
      • repeat
        • Value: true
        • Enables quarterly auto-calculation of the repeat payment
  • Q2
    • Same nested schema as Q1
  • Q3
    • Same nested schema as Q1
  • Q4
    • Same nested schema as Q1
• Salary nested keys and values:
  • quantity
    • Value: Float or Integer
    • Equals amount of after-tax money per salary pay period
  • frequency
    • Value: Integer
    • Equals number of weeks for each salary pay period
• Assets nested keys and values:
  • foo
    • Value: Integer or Float
    • Equals an asset's total valued amount
• Equity nested keys and values:
  • bar
    • Value: Integer or Float
    • Equals the total value of equity in a specific asset
• Debts nested keys and values:
  • fizz
    • Value: Integer or Float
    • Equals a debt's total valued amount
• All non-primary nested keys are case insensitive

Here is an simple example of of budget pouch file:

---
Budget:
  Q1:
    Rent:
      cost: 1000
      repeat: true
    foo: 20
    bar: 5
  Q2:
    Rent:
      cost: 1000
      repeat: true
    fizz: 20
    buzz: 5
  Q3:
    Rent:
      cost: 1000
      repeat: true
    bubble: 20
    sort: 5
  Q4:
    Rent:
      cost: 1000
      repeat: true
    baz: 20
    qax: 5
Salary:
  quantity: 1108.00
  frequency: 2
Assets:
  foo: 500
Equity:
  bar: 500
Debts:
  baz: 120
  qax: 300
...