Skip to main content

Fava extension and beancount libraries for investing

Project description

Fava Investor

Fava Investor aims to be a comprehensive set of reports, analyses, and tools for investments, for Beancount and Fava (software for plain text, double entry bookkeeping). It is developed as a collection of modules, with each module offering a Fava plugin, a Beancount library, and a shell command.

Interactivity and visualization are key for investing reports and tools, and hence the primary focus is on Fava, even though all modules will aim to have all three interfaces.

Current modules:

Screenshot: TLH Screenshot: Asset Allocation

Utilities

Fava Investor ships with fava-investor-ticker-util, which is a collection of utilities for:

  • downloading information from Yahoo for commodities (tickers), and annotating your commodity declarations with metadata
  • discovering relationships between tickers in your Beancount file, such as equivalent and substantially similar tickers, and tax loss harvesting partner groups, from a minimal and incomplete specification
  • providing ISIN an other ticker identifying information to your importers

For more, install fava_investor via pip, and then see:

fava-investor-ticker-util --help
fava-investor-ticker-util relate --help

Installation via pip

pip3 install fava-investor

Or to install the bleeding edge version from git:

pip3 install git+https://github.com/redstreet/fava_investor

See #55 for MacOS installation.

Running Fava Investor

Running in Fava:

Add this to your beancount source, and start up fava as usual:

2000-01-01 custom "fava-extension" "fava_investor" "{}"

You should now see an 'Investor' link in the sidebar in fava. For more on how to configure the extension, see the included huge-example.beancount.

Running on the Command-Line:

Shell command include a command for each module, and the utilities.

All shell commands start with the prefix fava-investor-.

All module commands and utilities (fava-investor-ticker-util) use click. See here to enable shell completion in zsh, bash, or fish.

Problems?

  • Monitor the terminal you are running fava from to look for error output from fava_investor
  • Include the error messages you see above when opening bug reports or asking for help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fava_investor-0.2.6.tar.gz (611.9 kB view hashes)

Uploaded Source

Built Distribution

fava_investor-0.2.6-py3-none-any.whl (389.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page