https://github.com/andreasgerstmayr/fava-portfolio-returns

fava-portfolio-returns shows portfolio returns in Fava
https://github.com/andreasgerstmayr/fava-portfolio-returns

beancount beangrow fava portfolio returns

Last synced: 19 days ago
JSON representation

fava-portfolio-returns shows portfolio returns in Fava

• Host: GitHub
• URL: https://github.com/andreasgerstmayr/fava-portfolio-returns
• Owner: andreasgerstmayr
• License: gpl-2.0
• Created: 2022-02-18T15:37:28.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-22T21:54:35.000Z (21 days ago)
• Last Synced: 2024-12-22T22:26:10.514Z (21 days ago)
• Topics: beancount, beangrow, fava, portfolio, returns
• Language: Python
• Homepage:
• Size: 11 MB
• Stars: 37
• Watchers: 2
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Fava Portfolio Returns

[![Continuous Integration](https://github.com/andreasgerstmayr/fava-portfolio-returns/actions/workflows/continuous-integration.yaml/badge.svg)](https://github.com/andreasgerstmayr/fava-portfolio-returns/actions/workflows/continuous-integration.yaml)

[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/andreasgerstmayr/fava-portfolio-returns)

fava-portfolio-returns shows portfolio returns in the [Fava](https://github.com/beancount/fava) web interface. It leverages [beangrow](https://github.com/beancount/beangrow) to calculate the portfolio returns.

[![Overview](frontend/tests/e2e/__image_snapshots__/report_overview.png)](frontend/tests/e2e/__image_snapshots__/report_overview.png)

[![Report](frontend/tests/e2e/__image_snapshots__/report_vht.png)](frontend/tests/e2e/__image_snapshots__/report_vht.png)

## Installation

```

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

```

## Usage

Please setup [beangrow](https://github.com/beancount/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-js` to compile the frontend. The compiled and bundled code will be placed in `src/fava_portfolio_returns/FavaPortfolioReturns.js`.

You can run `make watch-js` 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 calculation changes or additions in the [beangrow](https://github.com/beancount/beangrow) repository, and any user interface changes in this repository.

## Related Projects

* [Fava Portfolio Summary](https://github.com/PhracturedBlue/fava-portfolio-summary)

* [Fava Classy Portfolio](https://github.com/seltzered/fava-classy-portfolio)

* [Fava Investor](https://github.com/redstreet/fava_investor)

* [Fava Dashboards](https://github.com/andreasgerstmayr/fava-dashboards)

## Acknowledgements

Thanks to Martin Blais and all contributors of [beancount](https://github.com/beancount/beancount) and [beangrow](https://github.com/beancount/beangrow),

Jakob Schnitzer, Dominik Aumayr and all contributors of [Fava](https://github.com/beancount/fava),

and to all contributors of [Apache ECharts](https://echarts.apache.org).