mirror of
https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot.git
synced 2025-07-23 22:51:28 +00:00
refactor telegram bot to use docker compose
This commit is contained in:
21
telegram/Dockerfile
Normal file
21
telegram/Dockerfile
Normal file
@@ -0,0 +1,21 @@
|
||||
FROM python:3.11-buster AS builder
|
||||
|
||||
|
||||
COPY telegram/requirements.txt .
|
||||
|
||||
RUN pip install --user -r requirements.txt
|
||||
|
||||
|
||||
FROM python:3.11-slim
|
||||
|
||||
ENV MPLBACKEND=Agg
|
||||
|
||||
COPY --from=builder /root/.local /root/.local
|
||||
|
||||
|
||||
COPY common common
|
||||
COPY telegram .
|
||||
|
||||
|
||||
|
||||
CMD [ "python", "./bot.py" ]
|
||||
65
telegram/T_info.py
Normal file
65
telegram/T_info.py
Normal file
@@ -0,0 +1,65 @@
|
||||
"""Functions and Info specific to the Telegram Bot
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
import requests as r
|
||||
|
||||
|
||||
class T_info:
|
||||
license = re.sub(
|
||||
r"\b\n",
|
||||
" ",
|
||||
r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
|
||||
)
|
||||
|
||||
help_text = """
|
||||
Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
|
||||
|
||||
If you are interested in stock market data, or want to host your own bot, be sure to use my affiliate link so that the bot can stay free: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram)
|
||||
|
||||
Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews
|
||||
|
||||
Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
|
||||
|
||||
The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
|
||||
|
||||
Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla.
|
||||
|
||||
**Commands**
|
||||
- `/donate [amount in USD]` to donate. 🎗️
|
||||
- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
|
||||
- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
|
||||
- `/trending` Trending Stocks and Cryptos. 💬
|
||||
- `/help` Get some help using the bot. 🆘
|
||||
|
||||
**Inline Features**
|
||||
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
|
||||
|
||||
Market data is provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram)
|
||||
|
||||
If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
|
||||
"""
|
||||
|
||||
donate_text = """
|
||||
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
|
||||
All donations go directly towards paying for servers, and market data is provided by
|
||||
[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
|
||||
|
||||
The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
|
||||
|
||||
Example: `/donate 2` would donate 2 USD.
|
||||
|
||||
An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
|
||||
If you have any questions see the [website](https://docs.simplestockbot.com)
|
||||
|
||||
"""
|
||||
|
||||
|
||||
commands = """ # Not used by the bot but for updating commands with BotFather
|
||||
donate - Donate to the bot 🎗️
|
||||
help - Get some help using the bot. 🆘
|
||||
trending - Trending Stocks and Cryptos. 💬
|
||||
intra - $[symbol] Plot since the last market open. 📈
|
||||
chart - $[chart] Plot of the past month. 📊
|
||||
"""
|
||||
450
telegram/bot.py
Normal file
450
telegram/bot.py
Normal file
@@ -0,0 +1,450 @@
|
||||
# Works with Python 3.8
|
||||
import datetime
|
||||
import html
|
||||
import io
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import random
|
||||
import string
|
||||
import traceback
|
||||
from uuid import uuid4
|
||||
|
||||
import mplfinance as mpf
|
||||
import telegram
|
||||
from telegram import (
|
||||
InlineQueryResultArticle,
|
||||
InputTextMessageContent,
|
||||
LabeledPrice,
|
||||
Update,
|
||||
)
|
||||
from telegram.ext import (
|
||||
CallbackContext,
|
||||
CommandHandler,
|
||||
Filters,
|
||||
InlineQueryHandler,
|
||||
MessageHandler,
|
||||
PreCheckoutQueryHandler,
|
||||
Updater,
|
||||
)
|
||||
|
||||
from common.symbol_router import Router
|
||||
from T_info import T_info
|
||||
|
||||
# Enable logging
|
||||
logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
TELEGRAM_TOKEN = os.environ["TELEGRAM"]
|
||||
|
||||
try:
|
||||
STRIPE_TOKEN = os.environ["STRIPE"]
|
||||
except KeyError:
|
||||
STRIPE_TOKEN = ""
|
||||
log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
|
||||
|
||||
s = Router()
|
||||
t = T_info()
|
||||
|
||||
|
||||
log.info("Bot script started.")
|
||||
|
||||
|
||||
def start(update: Update, context: CallbackContext):
|
||||
"""Send help text when the command /start is issued."""
|
||||
log.info(f"Start command ran by {update.message.chat.username}")
|
||||
update.message.reply_text(
|
||||
text=t.help_text,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def help(update: Update, context: CallbackContext):
|
||||
"""Send help text when the command /help is issued."""
|
||||
log.info(f"Help command ran by {update.message.chat.username}")
|
||||
update.message.reply_text(
|
||||
text=t.help_text,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def license(update: Update, context: CallbackContext):
|
||||
"""Send bots license when the /license command is issued."""
|
||||
log.info(f"License command ran by {update.message.chat.username}")
|
||||
update.message.reply_text(
|
||||
text=t.license,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def status(update: Update, context: CallbackContext):
|
||||
"""Gather status of bot and dependant services and return important status updates."""
|
||||
log.warning(f"Status command ran by {update.message.chat.username}")
|
||||
bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date
|
||||
|
||||
bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.")
|
||||
|
||||
update.message.reply_text(
|
||||
text=bot_status,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
)
|
||||
|
||||
|
||||
def donate(update: Update, context: CallbackContext):
|
||||
"""Sets up donation."""
|
||||
log.info(f"Donate command ran by {update.message.chat.username}")
|
||||
chat_id = update.message.chat_id
|
||||
|
||||
if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
|
||||
update.message.reply_text(
|
||||
text=t.donate_text,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
amount = 1.0
|
||||
else:
|
||||
amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
|
||||
|
||||
try:
|
||||
price = int(amount * 100)
|
||||
except ValueError:
|
||||
update.message.reply_text(f"{amount} is not a valid donation amount or number.")
|
||||
return
|
||||
log.info(f"Donation amount: {price} by {update.message.chat.username}")
|
||||
|
||||
context.bot.send_invoice(
|
||||
chat_id=chat_id,
|
||||
title="Simple Stock Bot Donation",
|
||||
description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
|
||||
payload=f"simple-stock-bot-{chat_id}",
|
||||
provider_token=STRIPE_TOKEN,
|
||||
currency="USD",
|
||||
prices=[LabeledPrice("Donation:", price)],
|
||||
start_parameter="",
|
||||
# suggested_tip_amounts=[100, 500, 1000, 2000],
|
||||
photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
|
||||
photo_width=500,
|
||||
photo_height=500,
|
||||
)
|
||||
|
||||
|
||||
def precheckout_callback(update: Update, context: CallbackContext):
|
||||
"""Approves donation"""
|
||||
log.info("precheckout_callback queried")
|
||||
query = update.pre_checkout_query
|
||||
|
||||
query.answer(ok=True)
|
||||
# I dont think I need to check since its only donations.
|
||||
# if query.invoice_payload == "simple-stock-bot":
|
||||
# # answer False pre_checkout_query
|
||||
# query.answer(ok=True)
|
||||
# else:
|
||||
# query.answer(ok=False, error_message="Something went wrong...")
|
||||
|
||||
|
||||
def successful_payment_callback(update: Update, context: CallbackContext):
|
||||
"""Thanks user for donation"""
|
||||
log.info("Successful payment!")
|
||||
update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
|
||||
|
||||
|
||||
def symbol_detect_image(update: Update, context: CallbackContext):
|
||||
"""
|
||||
Makes image captions into text then passes the `update` and `context`
|
||||
to symbol detect so that it can reply cashtags in image captions.
|
||||
"""
|
||||
try:
|
||||
if update.message.caption:
|
||||
update.message.text = update.message.caption
|
||||
symbol_detect(update, context)
|
||||
except AttributeError:
|
||||
return
|
||||
|
||||
|
||||
def symbol_detect(update: Update, context: CallbackContext):
|
||||
"""
|
||||
Runs on any message that doesn't have a command and searches for cashtags,
|
||||
then returns the prices of any symbols found.
|
||||
"""
|
||||
try:
|
||||
message = update.message.text
|
||||
chat_id = update.message.chat_id
|
||||
if "$" in message:
|
||||
symbols = s.find_symbols(message)
|
||||
log.info("Looking for Symbols")
|
||||
else:
|
||||
return
|
||||
except AttributeError as ex:
|
||||
log.info(ex)
|
||||
return
|
||||
if symbols:
|
||||
# Let user know bot is working
|
||||
context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
|
||||
log.info(f"Symbols found: {symbols}")
|
||||
|
||||
for reply in s.price_reply(symbols):
|
||||
update.message.reply_text(
|
||||
text=reply,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def intra(update: Update, context: CallbackContext):
|
||||
"""returns a chart of intraday data for a symbol"""
|
||||
log.info(f"Intra command ran by {update.message.chat.username}")
|
||||
|
||||
message = update.message.text
|
||||
chat_id = update.message.chat_id
|
||||
|
||||
if message.strip().split("@")[0] == "/intra":
|
||||
update.message.reply_text(
|
||||
"This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
|
||||
)
|
||||
return
|
||||
|
||||
symbols = s.find_symbols(message, trending_weight=5)
|
||||
symbol = symbols[0]
|
||||
|
||||
if len(symbols):
|
||||
symbol = symbols[0]
|
||||
else:
|
||||
update.message.reply_text("No symbols or coins found.")
|
||||
return
|
||||
|
||||
df = s.intra_reply(symbol)
|
||||
if df.empty:
|
||||
update.message.reply_text(
|
||||
text="Invalid symbol please see `/help` for usage details.",
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
return
|
||||
|
||||
context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
|
||||
|
||||
buf = io.BytesIO()
|
||||
mpf.plot(
|
||||
df,
|
||||
type="renko",
|
||||
title=f"\n{symbol.name}",
|
||||
volume="Volume" in df.keys(),
|
||||
style="yahoo",
|
||||
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
|
||||
)
|
||||
buf.seek(0)
|
||||
|
||||
update.message.reply_photo(
|
||||
photo=buf,
|
||||
caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
|
||||
+ f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
|
||||
+ f"\n\n{s.price_reply([symbol])[0]}",
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def chart(update: Update, context: CallbackContext):
|
||||
"""returns a chart of the past month of data for a symbol"""
|
||||
log.info(f"Chart command ran by {update.message.chat.username}")
|
||||
|
||||
message = update.message.text
|
||||
chat_id = update.message.chat_id
|
||||
|
||||
if message.strip().split("@")[0] == "/chart":
|
||||
update.message.reply_text(
|
||||
"This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
|
||||
)
|
||||
return
|
||||
|
||||
symbols = s.find_symbols(message, trending_weight=10)
|
||||
|
||||
if len(symbols):
|
||||
symbol = symbols[0]
|
||||
else:
|
||||
update.message.reply_text("No symbols or coins found.")
|
||||
return
|
||||
|
||||
df = s.chart_reply(symbol)
|
||||
if df.empty:
|
||||
update.message.reply_text(
|
||||
text="Invalid symbol please see `/help` for usage details.",
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
return
|
||||
context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
|
||||
|
||||
buf = io.BytesIO()
|
||||
mpf.plot(
|
||||
df,
|
||||
type="candle",
|
||||
title=f"\n{symbol.name}",
|
||||
volume="Volume" in df.keys(),
|
||||
style="yahoo",
|
||||
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
|
||||
)
|
||||
buf.seek(0)
|
||||
|
||||
update.message.reply_photo(
|
||||
photo=buf,
|
||||
caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
|
||||
+ f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def trending(update: Update, context: CallbackContext):
|
||||
"""returns currently trending symbols and how much they've moved in the past trading day."""
|
||||
log.info(f"Trending command ran by {update.message.chat.username}")
|
||||
|
||||
chat_id = update.message.chat_id
|
||||
|
||||
context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
|
||||
|
||||
trending_list = s.trending()
|
||||
|
||||
update.message.reply_text(
|
||||
text=trending_list,
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def inline_query(update: Update, context: CallbackContext):
|
||||
"""
|
||||
Handles inline query. Searches by looking if query is contained
|
||||
in the symbol and returns matches in alphabetical order.
|
||||
"""
|
||||
# info(f"Inline command ran by {update.message.chat.username}")
|
||||
log.info(f"Query: {update.inline_query.query}")
|
||||
|
||||
ignored_queries = {"$", "$$", " ", ""}
|
||||
|
||||
if update.inline_query.query.strip() in ignored_queries:
|
||||
default_message = """
|
||||
You can type:\n@SimpleStockBot `[search]`
|
||||
in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
|
||||
"""
|
||||
|
||||
update.inline_query.answer(
|
||||
[
|
||||
InlineQueryResultArticle(
|
||||
str(uuid4()),
|
||||
title="Please enter a query. It can be a ticker or a name of a company.",
|
||||
input_message_content=InputTextMessageContent(default_message, parse_mode=telegram.ParseMode.MARKDOWN),
|
||||
)
|
||||
]
|
||||
)
|
||||
|
||||
matches = s.inline_search(update.inline_query.query)
|
||||
|
||||
results = []
|
||||
for _, row in matches.iterrows():
|
||||
results.append(
|
||||
InlineQueryResultArticle(
|
||||
str(uuid4()),
|
||||
title=row["description"],
|
||||
input_message_content=InputTextMessageContent(row["price_reply"], parse_mode=telegram.ParseMode.MARKDOWN),
|
||||
)
|
||||
)
|
||||
|
||||
if len(results) == 5:
|
||||
update.inline_query.answer(results, cache_time=60 * 60)
|
||||
log.info("Inline Command was successful")
|
||||
return
|
||||
update.inline_query.answer(results)
|
||||
|
||||
|
||||
def rand_pick(update: Update, context: CallbackContext):
|
||||
"""For the gamblers. Returns a random symbol to buy and a sell date"""
|
||||
log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}")
|
||||
|
||||
update.message.reply_text(
|
||||
text=s.random_pick(),
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
disable_notification=True,
|
||||
)
|
||||
|
||||
|
||||
def error(update: Update, context: CallbackContext):
|
||||
"""Log Errors caused by Updates."""
|
||||
log.warning('Update "%s" caused error "%s"', update, error)
|
||||
|
||||
tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
|
||||
tb_string = "".join(tb_list)
|
||||
|
||||
err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
|
||||
log.warning(f"Logging error: {err_code}")
|
||||
|
||||
if update:
|
||||
log.warning(
|
||||
f"An exception was raised while handling an update\n"
|
||||
f"\tupdate = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}\n"
|
||||
f"\tcontext.chat_data = {str(context.chat_data)}\n"
|
||||
f"\tcontext.user_data = {str(context.user_data)}\n"
|
||||
f"\t{html.escape(tb_string)}"
|
||||
)
|
||||
|
||||
update.message.reply_text(
|
||||
text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
|
||||
parse_mode=telegram.ParseMode.MARKDOWN,
|
||||
)
|
||||
else:
|
||||
log.warning("No message to send to user.")
|
||||
log.warning(tb_string)
|
||||
|
||||
|
||||
def main():
|
||||
"""Start the context.bot."""
|
||||
# Create the EventHandler and pass it your bot's token.
|
||||
updater = Updater(TELEGRAM_TOKEN)
|
||||
|
||||
# Get the dispatcher to register handlers
|
||||
dp = updater.dispatcher
|
||||
|
||||
# on different commands - answer in Telegram
|
||||
dp.add_handler(CommandHandler("start", start))
|
||||
dp.add_handler(CommandHandler("help", help))
|
||||
dp.add_handler(CommandHandler("license", license))
|
||||
dp.add_handler(CommandHandler("trending", trending))
|
||||
dp.add_handler(CommandHandler("random", rand_pick))
|
||||
dp.add_handler(CommandHandler("donate", donate))
|
||||
dp.add_handler(CommandHandler("status", status))
|
||||
dp.add_handler(CommandHandler("inline", inline_query))
|
||||
|
||||
# Charting can be slow so they run async.
|
||||
dp.add_handler(CommandHandler("intra", intra, run_async=True))
|
||||
dp.add_handler(CommandHandler("intraday", intra, run_async=True))
|
||||
dp.add_handler(CommandHandler("day", intra, run_async=True))
|
||||
dp.add_handler(CommandHandler("chart", chart, run_async=True))
|
||||
dp.add_handler(CommandHandler("month", chart, run_async=True))
|
||||
|
||||
# on noncommand i.e message - echo the message on Telegram
|
||||
dp.add_handler(MessageHandler(Filters.text, symbol_detect))
|
||||
dp.add_handler(MessageHandler(Filters.photo, symbol_detect_image))
|
||||
|
||||
# Inline Bot commands
|
||||
dp.add_handler(InlineQueryHandler(inline_query))
|
||||
|
||||
# Pre-checkout handler to final check
|
||||
dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
|
||||
|
||||
# Payment success
|
||||
dp.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
|
||||
|
||||
# log all errors
|
||||
dp.add_error_handler(error)
|
||||
|
||||
# Start the Bot
|
||||
updater.start_polling()
|
||||
|
||||
updater.idle()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
7
telegram/requirements.txt
Normal file
7
telegram/requirements.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
python-telegram-bot==13.5
|
||||
requests==2.25.1
|
||||
pandas==2.0.0
|
||||
schedule==1.0.0
|
||||
mplfinance==0.12.7a5
|
||||
markdownify==0.6.5
|
||||
cachetools==4.2.2
|
||||
Reference in New Issue
Block a user