mirror of
https://github.com/andrewkdinh/fund-indicators.git
synced 2024-11-21 14:34:20 -08:00
a8b7b794ec
Added link to the essay that was the basis of this project
3.1 KiB
3.1 KiB
fund-indicators
fund-indicators is a cross-platform Python application that allows users to easily find relationships between various attributes of mutual funds and previous performance. This project is based on research from Performance Indicators of Mutual Funds.
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)
- Simple to use
Quickstart
Give it a try at repl.run or repl.it.
If you would like to clone to your own machine:
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
toconfig.json
if you would like to skip beginning questions (only for advanced users)
Planned Features
- Graphical user interface (GUI)
- Multithreading/asynchronous requests
Contributing
Want to help? Great! Check out the CONTRIBUTING.md file!
Credits
This project utilizes a wide variety of open-source projects:
- NumPy, Termcolor, Beautiful Soup, yahoofinancials, requests-cache, halo, matplotlib, asciinema, Core Infrastructure Initiative Best Practices Badge
And thank you to those that have helped me with the idea and product:
- Amber Bruce, Alex Stoykov, Doug Achterman, Stack Overflow
Licensed under GPL-3.0 | Copyright (C) 2019 Andrew Dinh