A smart personal assistant for retail stock traders

Overview • Getting Started • Deployment • Libraries • License • Special Thanks

Overview

Features:

• Upcoming dividends. Display all upcoming dividend payouts
• Dividend summary. Summary of dividends paid by a company over the last 5 years
• Dividend estimation. Estimate total dividends earned this year using data from last year
• Post market analysis. Receive an automatically generated report of the top losers, gainers and highest volumes to the user after market close everyday.

Data sources:

• dividends.sg
• Yahoo! Finance

Supported markets:

• Singapore

Supported platforms:

• Telegram (bot)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development, testing and deployment purposes.

Prerequisites

pip install -r requirements.txt

Usage

start the bot:

python main.py

bot will run until you stop it with CTRL + C / CMD + C

Deployment

You may host the bot on any server that has python 3 installed

Libraries

• pandas
• python-telegram-bot
• sqlite3
• pandas-datareader
• millify

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Special Thanks

• mmdaz - Basic structure for MVC bot architecture
• xlanor - Great example of a telegram bot with MVC architecture
• vecteezy.com - Cool logo