This repository is a collection of scripts intended for analyzing world events, social media posts/trends, and other potentially influential indicators to compare against market trends.
This software requires a lot of imports, I recommend setting up a python virtual environment as follows:
git clone $this_repository/
cd finance_tracker
python3 -m venv /path/to/finance_tracker/stocksleuth-virtual-env #stocksleuth-virtual-env can be named whatever you want.
source stocksleuth-virtal-env/bin/activate
deactivate #This will exit the python virtual env.You'll now be inside the python virtual environment and can install the needed libraries without effecting your personal machine.
Below is a list of apis and accounts needed to use this software. Once obtained fill out configs/api-client.yaml
- NewsAPI Free API Key, requires throwaway email.
- AlphaVantage Free API Key, requires throwaway email.
- Twelvedata Free API Key, requires email confirmation.
- Sec-API Free API Key, requires email confirmation.
- RedditAPI Free API Key, create a reddit user, remember username and password.
- Reddit-App-Creation Log into reddit and create a reddit app named stocksleuth.
- Submit Request for API Fill out this with the following:
- Assistance with? -- API support an inqueries.
- What Position? -- I am a Developer.
- Inquiry? -- I want to register to use the free tier of the Reddit API.
- OAUTH Cleint ID? -- Give ID, This is emailed to you after the creation of the Reddit App "stocksleuth" above.
- You can find the Reddit Client-Secret on the Reddit App page, you now have all three pieces to use RedditAPI as defined in api-client.yaml
Run python3 main.py -h to get a list of avaible flags, use --gui or -g to launch the GUI if you dont like the command line.