black-T.U.E.S.D.A.Y

Telegram-bot Ultimately Essential Service Definitively Assist You

Introduction

This is a bot project that provides various convenience functions using python-telegram-bot

Initially, it was developed for the purpose of a stock alert bot, so it was named Black Tuesday, which refers to the last day of the 1929 Wall Street crash.

In the vast landscape of the internet, individuals often find themselves overwhelmed by the task of seeking essential information. Traditional methods involve visiting multiple websites to gather the required data.
The "black-T.U.E.S.D.A.Y" project emerges as a solution to this challenge, offering a centralized platform that provides a myriad of information and convenience through various commands.

---

Release

You can use the latest version of the bot by adding @black_tuesday_bot to your Telegram.

You can also see the latest version of the bot in the Releases on the right.
The current latest version is v1.1.0.

---

Commands

• /start - Start the bot
  
• /help - Show command list
  
• /alarm - Show alarm list
  
  
  
  • /alarm [alarm time] - Set an alarm at the specified time
    
  • /alarm [alarm index] - Remove the alarm at the specified index
    
  • /alarm [alarm ID] - Remove the alarm with the specified ID
    
  • /alarm all - Remove all alarms
    
• /search [search value]- Search anything you want at google.com
  
• /weather - Show weather information
  
  • /weather [weather notification time] - Set weather notification every day at the specified time
    
  • /weather off - Turn off weather notification
    
• /setloc [x-coordinate] [y-coordinate] - Set location for weather command
  
• /pl - Show Premier League table
  
• /plnow - Show today's Premier League schedule
  
• /plnext - Show tomorrow's Premier League schedule
  
• /cl - Show this week's UEFA Champions League schedule
  
• /kbo - Show KBO league table
  
• /kbonow - Show today's KBO game schedule
  
• /npb - Show NPB league table
  
• /npbnow - Show today's NPB game schedule
  
• /gpt [ask value] - Ask anything to chatGPT
  
• /gptkeyset [gpt API key] - Set the API key for chatGPT
  
• /find [find value] - Search stock ticker with company name
  
• /now [stock ticker] - Show real time price of the stock
  
• /boj - BOJ(Solved.ac) streak reminder
  

---

Bug Report

If you find a bug, please report it in the Issues with specific time and command to let me know.
Or you can use bug report template.

---

About Files

• main.py - Main file of the bot
• log.py - Logging module
• database.py - Manage database
• crawling.py - Crawling module
• commands directory
  • alarm.py - Alarm command module
  • boj.py - BOJ command module
  • cl.py - CL command module
  • epl.py - PL command module
  • find.py - Find command module
  • gpt.py - GPT command module
  • help.py - Help command module
  • kbo.py - KBO command module
  • now.py - Now command module
  • npb.py - NPB command module
  • search.py - Search command module
  • start.py - Start command module
  • weather.py - Weather command module
• requirements.txt - Packages required to run the bot

---

Reference

• Telegram Bot
  • python-telegram-bot
• Weather API (Meteorological Administration_Short-Term Forecast) for /weather
  • Korea public data portal
  • Usage of Weather API
• ChatGPT API for /gpt
  • OpenAI API Reference Document
• Unofficial Solved.ac API for /boj
  • Unofficial Solved.ac API
  • Github - solvedac/unofficial-documentation
• Premier League Table API for /pl
  • Football-data.org
• Ticker Search API for /find
  • yashwanth2804/TickerSymbol
• Yahoo Finance API for /now
  • ranaroussi/yfinance

---

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.