fund-indicators/README.md
2019-04-08 07:25:41 -07:00

2.8 KiB

fund-indicators

License Latest Commits CII Best Practices

A project to determine relationships between mutual fund performance and different factors.

asciicast demo

Calculates relationships between: Previous performance, Alpha, Sharpe Ratio, Sortino Ratio

and Expense ratios, Turnover, Market Capitalization (Asset Size), Persistence

Give it a try at repl.run or repl.it.

Key Features

  • 100% automated
  • Uses multiple API's in the case another fails
  • Caches http requests for future runs
  • Scrapes data from Yahoo Finance
  • Color-coded for easy viewing
  • Optional graphs to easily visualize linear regression results
  • A new joke every time
  • Cross-platform (tested on Windows and Linux)

Quickstart

git clone https://github.com/andrewkdinh/fund-indicators.git && cd fund-indicators
pip install -r requirements.txt
python main.py
  • Common mutual funds are listed in stocks.txt
  • Configure and rename config.example.json to config.json if you would like to skip beginning questions (only for advanced users)

Contributing

Want to help? Great! Check out the CONTRIBUTING.md file!

Credits

This project utilizes a wide variety of open-source projects:

And thank you to those that have helped me with the idea and product:

Licensed under GPL-3.0 | Copyright (C) 2019 Andrew Dinh