Skip to content

Repository files navigation

Static Badge

Generate a daily report about your financial portfolio by using Github Actions

Project uses yfinance to acquire market data and Plotly to display graphs. Daily example reports can be found under Releases

Usage

  1. Create a new private repository on your Github account
  2. Create a .github/workflows/generate_report.yaml file in your repository and copy all the content of file from this repository into it
  3. Add files containing information about your assets to the root of your repository - one file per asset. Examples of the input format can be found in examples directory. Fields are explained in the Input_Fields_Explained.yaml example
  4. Create a settings.yaml file in the root of your repository and adjust the report settings to your liking. Example of settings file can be found here
  5. (Optional) Adjust report generation settings (e.g. daily generation time) in your own .github/workflows/generate_report.yaml file
  6. Star this repository, so I would know people are using the project

About

Generates daily reports of your financial asset performance by using Github Actions

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages