StockTracker

This page is the offical documentation for downloading and running the code in this code base.

Update:

This project is no longer in develoment. Attempting to build this project will work because the required API keys and MongoDB servers code has been removed. This project has been made public so others may learn from it's existence.

Preview

Notes about the READMEs

It is very important that you read all README.md files before attempting a system test, or a unit test of certain systems here is a list of all README files:

1. /main/README.md (the one your reading)
2. /main/Helper/helper.py/README.md (used for fixing bugs in imported package)
3. /main/UnitTest/Login/README.md (used for unit testing)
4. /main/UnitTest/Helper/README.md (used for unit testing)
5. /main/Robinhoon_API/README.md (used for find robin_stocks docs)
6. /main/UnitTest/Database/README.md (used for fixing SSL cert error and set connectionString)

How to Download and Setup

1. Download Python v3.11.1. The app most likely will run on older or newer versions of Python 3, but that has not been tested.
2. Run git clone https://github.com/key6oardWarrior/StockTracker
3. cd [dir that cloned StockTrader]
4. py -m pip install -r Dependencies/requirements.txt This will install all the need python dependencies. If you have any more issues read the other README.md files
5. py installer.py
6. py compile.py

Please note that while running compile.py you may encounter an error that states, "Can't list [directory]." Please ignore this error message. A desktop shortcut will be created use that shortcut to run the application.

Note

Nothing on this application is financial advice and there is no guarantee that any user will profit from using this application. Any data entered into this app will not be stored on the user's computer or another server. When a user wants to see "the last 5 days of trading" from congress members you will see the last 5 days that congress members reported their trades. For example, if the date is Jan 3, 2024 and congress member A sells 3 shares of Apple on June 5, 2022, but reports that trade on Jan 2, 2024 and a user requested to see the last 5 days of trading then the user will see that congress member A made the sale yesterday. Be sure to check the transaction date because it may be different from the reported date. Also keep in mind that the law requires congress persons to report their trades within 45 days after making the trade; however, many congress persons break the law and report their trades late (sometimes VERY late).