jessawitzel/retirement_goal_calc

A retirement goal calculator to be used with YNAB.

retirement_goal_calc's Issues

OAuth Support

Figure that out. https://api.youneedabudget.com/#outh-applications

Determine which parts of the YNAB we need.

We want to collect all of the accounts needed to perform our retirement goal calculation.

To do that, we will need to fetch all of the accounts, show them to the user and have them include them as investments to track.

We will want to look at https://api.youneedabudget.com to determine what endpoints will contain the data we need. This will also help us create our mock data for #2

Saved Amount Calculator

Given an amount per-month calculate how much savings is needed to produce that as a dividend.

• This should be done as a simple Python function.
• There should be tests.
• Data we might need:
  • share price
  • share count
  • dividend frequency
  • dividend payout
  • desired monthly dividend

Suppose company ABC's stock is trading at $20 and pays yearly dividends of $1 per share to its
shareholders. Also suppose that company XYZ’s stock is trading at $40 and also pays annual dividends of
$1 per share. This means that company ABC’s dividend yield is 5% (1 / 20 = 0.05), while XYZ’s dividend
yield is only 2.5% (1 / 40 = 0.025). Assuming all other factors are equivalent, then, an investor looking to
use his or her portfolio to supplement his or her income would likely prefer ABC's stock over that of XYZ,
as it has double the dividend yield.

Example

Desired: 1,000 / mo
Dividend Frequency: Quarterly
Dividend Amount: 0.32
Share Price: $66.79

3,000 / 0.32 = 9,375
9,375 * 66.79 = $626,156

YNAB API Mock

Create a fake/mock JSON file that contains data we would expect from a valid response to a request of the YNAB API.

We can place this in a folder called data

See: https://api.youneedabudget.com

Update README.md

Let's call out what methods from the YNAB API we will be using in the README.
We can also place our compound interest formula in the readme.
We can create a narrative documentation, something like:

The retirement_goal_calc determines how much per-month you will need to save, to meet your monthly dividend goal. To do this, we will use information from the YNAB API and information you enter, such as target retirement date and estimated rate of return.