adri0/investd

investd - A tool for summarizing investments.

investd

Tool for generating financial reports. Download statements from your broker or investment accounts, ingest them using investd and generate nice reports.

Check out the sample report generated from sample data at: https://adri0.github.io/investd

investd's Issues

Report

Include some basic metrics, such as:

• Total invested
• Plot investments
• Assets:
  • Quantity
  • Invested
  • Currency

Fail gracefully when no transactions available for creating report

Name of the generated report must containg date and reference currency

E.g.:

• overview_2022-10-12_PLN.html

XTB not supporting partial order fulfillment

In my XTB operations history there are partial BUY operations, such as:

OPEN BUY 4/8 @ 5.0140
OPEN BUY 3/8 @ 5.0140
...

It should be easy to allow parsing these.

If INVESTD_DATA env variable not provided, data folder should be current working dir

Unable to run from commandline after 'pip install .'

Shouldn't we get 'investd' command added to the path in such case?

I'm not sure what this part does:

    entry_points={"investd.__main__": {"main = investd.__main__:cli"}},

Is it for running it like:

python -m investd

?

Maybe we can also add sth like:

setup(
    ...
    entry_points = {
        'console_scripts': ['investd=investd.__main__:cli'],
    }
    ...
)

?

Persist FX rates

Configurable symbol mapping to yfinance

Currently symbol mapping for fetching quotes from yfinance is a hardcoded dictionary in quotes.py. Would be nice to have that configurable via some text file.

Build and test code on each commit

Configure Github Actions for doing that.

"Database is locked" error when running download-quotes

    When I ran this for the first time, I noticed a weird messsage:

 python -m investd download-quotes
2023-01-07 01:14:07,519 - investd.config - INFO - PERSIST_PATH: data/persist - REF_CURRENCY: PLN - REPORTS_PATH: data/reports - SOURCE_BASE_PATH: data/source
[*********************100%***********************]  2 of 2 completed

1 Failed download:
- IBC5.DE: OperationalError('database is locked')

Originally posted by @mkopec87 in #38 (comment)

Update Revolut Stocks source to match latest format

Revolut changed the format of the exported CSV. Update the source parser to use the latest format.

Config file

Add a config file for configuring:

• data paths

Add versioning

Currently, the package is always in version 0.0.1.

Require and automate versioning of the tool upon merging pull requests in main.

XTB statement column headers depend on language settings

In XLSX file I exported, I have headers in Polish, e.g. "Kwota" instead of "Amount".

Side question: any reason to use XLSX export from XTB instead of CSV?

Add test for sources

Quotes for Polish retail bonds

It would be nice to be able to get current value of Polish retail bonds in the portfolio.

Some web scraping could do, I already started the research in the topic to find out that:

• monthly inflation can be parsed here: https://stat.gov.pl/obszary-tematyczne/ceny-handel/wskazniki-cen/wskazniki-cen-towarow-i-uslug-konsumpcyjnych-pot-inflacja-/miesieczne-wskazniki-cen-towarow-i-uslug-konsumpcyjnych-od-1982-roku/?fbclid=IwAR25bUL3T5IgAcCCtcdhg0iM5F9balYL44vHzrza4qcs_hRplCPTq2LCaRI (notice that filename may change monthly)
• not-that user friendly interest tables are here: https://www.obligacjeskarbowe.pl/tabela-odsetkowa/
• I also contacted myfund.pl, as they seem to somehow calculate that values. I'll post the answer when I have one.

Configure INVESTD_DATA dir via command line argument

Create a dummy transaction dataset

Replace black by ruff format

• Ruff format does the same formatting as black, but faster.
• Would be nice to add some linting rules as well.

Source configuration

Each source needs some configuration, such as account currency.

Avoid running notebook when importing it in reports.__init__

When the reports command runs, the code of the report notebook is executed by the main application upon importing:

nb_module = load_module(f"{__package__}.{notebook_name}")

Find another way to find the notebook path without importing it.

Improve Readme.

• Basic usage
• Future vision

Prevent publishing pages in fork

Not sure if feasible, but in my fork I get failing build for main branch because of not being able to publish the page.
Maybe we can somehow prevent that?

https://github.com/mkopec87/investd/actions/runs/4188445079/jobs/7259585973

Persistence in a database

Currently the persistence layer consists of CSV files.

Add report_date parameter to report

The portfolio overview report should be able to show the portfolio value at a given date, not only today.

Current portfolio value

Add information about current portfolio value in the overview.

For that it is needed:

• Quotes for all assets at current date.
• Exchange rate for all asset currencies at current date.

Exchange rates

It is necessary to know exchange rates at a certain date for calculating portfolio value.

Add a license

Need to chose a proper open source license.

Quotes module

Reports for the portfolio net worth require quotes of each owned asset. For that it is need to query external APIs for obtaining the price of assets.

Some remarks:

• Depending on the source of each asset, obtaining a quote might require access to different APIs.
• Nice to have: persist quotes locally to avoid hitting rate limits.

Single command for ingesting and generating report

Currently we need to first run ingest-sources then report to generate the most up-to-date report. It would be nice to add some parameter to report command for also ingesting.

Invested amount portfolio metrics

• Total invested amount: all buys minus sells in the reference currency. (float)
• Invested amount in reference currency grouped by (data frame):
  • Symbol
  • Asset type
  • Currency
  • Source
  • Year
  • Month (last 12)
• Tests

.test.env doesn't work for tests

It would be nice to avoid using sample_data directory in the unit tests. Instead, it would be ideal in the tests to use only data inside tests/resources, but I didn't manage to load config variables form .test.env in the tests.

Add report_date parameter to report

The portfolio overview report should be able to show the portfolio value at a given date, not only today.

Update yfinance

For me, communication with yfinance is only working if I update yfinance to latest version.

Publish sample report using Github Pages

Ingesting sources should merge newly ingested tx into existing ones

Currently ingest-sources generates a new transactions CSV each time it is run containing only transactions found in the sources being ingested. It would be best if we could keep the existing transactions in place as we ingest source files that might not contain existing ones.