# 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
```bash
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)',
}"
```
Raw data
{
"_id": null,
"home_page": "https://github.com/redstreet/fava_miler",
"name": "fava-miler",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "fava beancount accounting investment",
"author": "Red S",
"author_email": "redstreet@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/91/c7/bdd656ebcca378e4234a08fae4121264bcb034b7c44b408df889800fbfd5/fava_miler-0.3.0.tar.gz",
"platform": null,
"description": "# fava_miler\nAirline miles and rewards points: expiration and value reporting for Fava/Beancount\n(Personal finance software).\n\n## Introduction\nAirline miles and rewards points typically expire after a period of inactivity. They\nalso can be viewed as having a value in a currency of your choice. If you track airline\nmile transactions in Beancount, this simple plugin reports on the value of miles and\ntheir expiry date. This is particularly useful if you have miles/points on many airlines\nor businesses.\n\n\n\n## Installation\n```bash\npip install fava-miler\n```\n\n### Configuring your beancount source\n- Define your `operating_currency`\n- Declare the currency for each of your airline miles\n- Add `expiry-months` and `points-value` metadata to your commodity declaration\n - Any negative value for `expiry-months` signifies that this commodity never expires\n\nThis should get the reporter working. Example:\n\n```\noption \"operating_currency\" \"USD\"\n1990-01-01 commodity MILESAIRALD\n expiry-months: 24\n points-value: 0.015 USD\n\n2000-01-01 open Assets:Miles:AirAldorra MILESAIRALD\n2000-01-01 open Income:Misc\n\n2010-01-01 * \"Credit card miles\"\n Assets:Miles:AirAldorra 100 MILESAIRALD\n Income:Misc\n```\n\n## Running\n\n### beancount\n```\nfava-miler --help\n```\n\n### fava\nAdd the following to your source and run fava as you normally would.\n\n```\n2010-01-01 custom \"fava-extension\" \"fava_miler\" \"{\n 'accounts_pattern' : '^Assets.*Reward',\n 'exclude_currencies' : '(POINTS_ABC)|(POINTS_DEF)',\n}\"\n```\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Show expiry of airline miles, rewards points",
"version": "0.3.0",
"split_keywords": [
"fava",
"beancount",
"accounting",
"investment"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "1bcc37b884c42616c7120c40c96b9ddb",
"sha256": "d85ea18f6023f89c2e5b1eb80eb5bde5bf11f305a7a174a6327046abcb6e5848"
},
"downloads": -1,
"filename": "fava_miler-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bcc37b884c42616c7120c40c96b9ddb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20874,
"upload_time": "2022-12-26T09:27:42",
"upload_time_iso_8601": "2022-12-26T09:27:42.668396Z",
"url": "https://files.pythonhosted.org/packages/35/15/4147fbfad099ae3a79887cea806b3fc3a45a344dfee0d87b620de5176e54/fava_miler-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "62391e41b0c8dc32d1d4443f958c658e",
"sha256": "8c3f79c6ee39e3ad8b7bddedd192c096a4e28cc8dc6dd88bed1e3c51b548dd7d"
},
"downloads": -1,
"filename": "fava_miler-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "62391e41b0c8dc32d1d4443f958c658e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26324,
"upload_time": "2022-12-26T09:27:44",
"upload_time_iso_8601": "2022-12-26T09:27:44.059901Z",
"url": "https://files.pythonhosted.org/packages/91/c7/bdd656ebcca378e4234a08fae4121264bcb034b7c44b408df889800fbfd5/fava_miler-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-26 09:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "redstreet",
"github_project": "fava_miler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fava-miler"
}
JSON
