/fava-portfolio-returns

fava-portfolio-returns shows portfolio returns in Fava

Primary LanguageHTMLGNU General Public License v2.0GPL-2.0

Fava Portfolio Returns

fava-portfolio-returns shows portfolio returns in the Fava web interface. It leverages beangrow to calculate the portfolio returns.

Screenshot

Installation

pip install git+https://github.com/andreasgerstmayr/fava-portfolio-returns.git

Usage

Please setup beangrow first, using this guide: https://beancount.github.io/docs/calculating_portolio_returns.html.

Enable this plugin in Fava by adding the following lines to your ledger:

2010-01-01 custom "fava-extension" "fava_portfolio_returns" "{
  'beangrow_config': 'beangrow.pbtxt',
}"

View Example Ledger

cd example; fava example.beancount

Building from Source

Run make build to compile the frontend. The compiled and bundled frontend will be placed in fava_portfolio_returns/templates/PortfolioReturns.html.

You can run make watch to automatically rebuild the frontend for any changes.

Contributing

The goal of this Fava extension is to display beangrow reports in the browser. Please implement any calculation changes or additions in the beangrow repository, and any user interface changes in this repository.

Related Projects

Acknowledgements

Thanks to Martin Blais and all contributors of beancount and beangrow, Jakob Schnitzer, Dominik Aumayr and all contributors of Fava, and to all contributors of Apache ECharts.