wancat/ledger-quotes-updater
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
wancat
2022-05-28 18:57:44 +08:00
parent c360f0fec8
commit fec1cd7323
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,15 +1,18 @@
# LedgerStockUpdate # LedgerStockUpdate
This repository has been archived, and the project has been ported to Rust, please refer to the [SourceHut page](https://sr.ht/~adchari/ledgerdb) This application locates any stocks/crypto currencies you have in your [ledger-cli](https://ledger-cli.org) file, then generates a price database of those stocks compatible with the application, using quotes from Yahoo Finance.
This application locates any stocks you have in your [ledger-cli](https://ledger-cli.org) file, then generates a price database of those stocks compatible with the application. Forked from [adchari/LedgerStockUpdate](https://github.com/adchari/LedgerStockUpdate), add some features:
* Add name mapping functionality: use BTC in your ledger and BTC-USD for online quotes
* Replace API from Alpha Vantage, without the needs of obtaining API token
* Recursively transform the quotes to single currency
### Usage ### Usage
Build the go file, and run as follows: Build the go file, and run as follows:
```bash ```bash
./[name of executable] -f=[ledger file] -p=[price database file (to create or update)] -a=[Alpha Vantage API token] -b=[Name of ledger binary] ./[name of executable] -f=[ledger file] -p=[price database file (to create or update)] -b=[Name of ledger binary] -m=[name mapping file]
``` ```
This should spit out a price database file, which can then be used to calculate the market value in ledger as follows: This should spit out a price database file, which can then be used to calculate the market value in ledger as follows:
@@ -17,3 +20,4 @@ This should spit out a price database file, which can then be used to calculate
```bash ```bash
ledger -f [ledger file] --price-db [price database file] -V bal ledger -f [ledger file] --price-db [price database file] -V bal
``` ```