redstreet / fava_miler Goto Github PK

View Code? Open in Web Editor NEW

14.0 4.0 2.0 66 KB

Miles expiration and value reporting for Fava/Beancount (Personal finance software).

License: GNU General Public License v3.0

Python 99.15% HTML 0.85%

fava_miler's Introduction

fava_miler

Airline miles and rewards points: expiration and value reporting for Fava/Beancount (Personal finance software).

Introduction

Airline miles and rewards points typically expire after a period of inactivity. They also can be viewed as having a value in a currency of your choice. If you track airline mile transactions in Beancount, this simple plugin reports on the value of miles and their expiry date. This is particularly useful if you have miles/points on many airlines or businesses.

Installation

pip install fava-miler

Configuring your beancount source

Define your operating_currency
Declare the currency for each of your airline miles
Add expiry-months and points-value metadata to your commodity declaration
- Any negative value for expiry-months signifies that this commodity never expires

This should get the reporter working. Example:

option "operating_currency" "USD"
1990-01-01 commodity MILESAIRALD
    expiry-months: 24
    points-value: 0.015 USD

2000-01-01 open Assets:Miles:AirAldorra MILESAIRALD
2000-01-01 open Income:Misc

2010-01-01 * "Credit card miles"
        Assets:Miles:AirAldorra 100 MILESAIRALD
        Income:Misc

Running

beancount

fava-miler --help

fava

Add the following to your source and run fava as you normally would.

2010-01-01 custom "fava-extension" "fava_miler" "{
  'accounts_pattern' : '^Assets.*Reward',
  'exclude_currencies' : '(POINTS_ABC)|(POINTS_DEF)',
}"

fava_miler's People

Contributors

Stargazers

Watchers

Forkers

tbm z1n

fava_miler's Issues

Support expiry field

The expiry-months sort of works, but I'd like a much more accurate calculation of the expiration date.

I am thinking of creating a beancount plugin that would calculate the exact expiration date. That could calculate the exact expiry date and set the expiry metadata for the commodity, so fava_miler could make use of it.

Does that sound like a good approach to you? (If so, I can create a patch. I haven't though about the design of the beancount plugin yet, but that's a separate question)

Filter empty balances

fava_miler shows entries for miles where I have a 0 balance. I think they should be filtered out.

module 'beancount.core.getters' has no attribute 'get_commodity_directives' with beancount <2.3.1

  File "/home/tbm/.local/lib/python3.7/site-packages/fava_miler/common/favainvestorapi.py", line 16, in get_commodity_map
    return getters.get_commodity_map(self.ledger.entries)
AttributeError: module 'beancount.core.getters' has no attribute 'get_commodity_map'

You need a dependency on beancount 2.3.3.

Take point value from pricedb instead of points-value

You require a points-value on the commodity definition.

But since beancount has a price directive, wouldn't it make more sense to take the price from there?

Differentiate between no expiration, expiration and unknown

If expiry-months is not define, the date of the last transaction is used. I don't think that's ideal since:

Some miles have no expiration. I think in that case the field should be blank
It might not be defined, i.e. unknown, in which case it should say "unknown" or something? (or be blank, but then no expiration should say "none")

I tried something like this but then the sorting broke:

        if 'expiry-months' in meta:
            expiry_months = meta['expiry-months']
            if expiry_months:
                expiry = row.latest_transaction + datetime.timedelta(int(expiry_months)*365/12)
            else:
                expiry = ''
        else:
            expiry = 'unknown'

What's the best way to handle this in your view?

Missing dependency on fava_investor

python3 /home/tbm/.local/lib/python3.7/site-packages/fava_miler/miler.py --help
Traceback (most recent call last):
  File "/home/tbm/.local/lib/python3.7/site-packages/fava_miler/miler.py", line 6, in <module>
    import fava_investor.common.beancountinvestorapi as api
ModuleNotFoundError: No module named 'fava_investor'