Merge branch '101-combine-discord-and-telegram-bots-into-one-repo-and-deploy-with-docker-compose' into 'master'

Resolve "Combine Discord and Telegram bots into one repo and deploy with docker compose"

Closes #101

See merge request simple-stock-bots/simple-telegram-stock-bot!49

.gitignore

@@ -1 +1,2 @@
 __pycache__
+.env

.gitlab-ci.yml

@@ -1,34 +1,5 @@
 black:
-  stage: .pre
+  # stage: .pre
   image: registry.gitlab.com/pipeline-components/black:latest
   script:
     - black --check --verbose -- .
-
-
-build:master:
-  stage: build
-  image:
-    name: gcr.io/kaniko-project/executor:v1.9.0-debug
-    entrypoint: [""]
-  script:
-    - /kaniko/executor
-      --context "${CI_PROJECT_DIR}"
-      --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
-      --destination "${CI_REGISTRY_IMAGE}:latest"
-  rules:
-    - if: '$CI_COMMIT_BRANCH == "master"'
-
-
-build:branch:
-  stage: build
-  image:
-    name: gcr.io/kaniko-project/executor:v1.9.0-debug
-    entrypoint: [""]
-  script:
-    - /kaniko/executor
-      --context "${CI_PROJECT_DIR}"
-      --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
-      --destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_SHORT_SHA}"
-      --destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_BRANCH}"
-  rules:
-    - if: '$CI_COMMIT_BRANCH != "master"'

common/MarketData.py

@@ -8,7 +8,7 @@ import pytz
 import requests as r
 import schedule
 
-from Symbol import Stock
+from common.Symbol import Stock
 
 log = logging.getLogger(__name__)
 

common/cg_Crypto.py

@@ -6,7 +6,7 @@ import requests as r
 import schedule
 from markdownify import markdownify
 
-from Symbol import Coin
+from common.Symbol import Coin
 
 log = logging.getLogger(__name__)
 

common/symbol_router.py

@@ -10,9 +10,9 @@ import pandas as pd
 import schedule
 from cachetools import TTLCache, cached
 
-from cg_Crypto import cg_Crypto
+from common.cg_Crypto import cg_Crypto
-from MarketData import MarketData
+from common.MarketData import MarketData
-from Symbol import Coin, Stock, Symbol
+from common.Symbol import Coin, Stock, Symbol
 
 from typing import Dict
 

dev-reqs.txt

@@ -1,4 +1,4 @@
--r requirements.txt
+-r telegram/requirements.txt
 black==23.3.0
 flake8==5.0.4
 Flake8-pyproject==1.2.3

discord/D_info.py

@@ -0,0 +1,65 @@
+"""Functions and Info specific to the discord Bot
+"""
+
+import re
+
+import requests as r
+
+
+class D_info:
+    license = re.sub(
+        r"\b\n",
+        " ",
+        r.get("https://gitlab.com/simple-stock-bots/simple-discord-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=discord)
+
+Keep up with the latest news for the bot in its discord 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=discord)
+
+    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=discord).
+
+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. 📊
+"""

discord/Dockerfile

@@ -1,7 +1,8 @@
 FROM python:3.11-buster AS builder
 
 
-COPY requirements.txt /requirements.txt
+COPY discord/requirements.txt .
+
 RUN pip install --user -r requirements.txt
 
 
@@ -11,7 +12,7 @@ ENV MPLBACKEND=Agg
 
 COPY --from=builder /root/.local /root/.local
 
-
+COPY common common
-COPY . .
+COPY discord .
 
 CMD [ "python", "./bot.py" ]

discord/bot.py

@@ -0,0 +1,202 @@
+import datetime
+import io
+import logging
+import os
+
+import mplfinance as mpf
+import nextcord
+from nextcord.ext import commands
+
+from D_info import D_info
+from common.symbol_router import Router
+
+DISCORD_TOKEN = os.environ["DISCORD"]
+
+s = Router()
+d = D_info()
+
+
+intents = nextcord.Intents.default()
+
+
+client = nextcord.Client(intents=intents)
+bot = commands.Bot(command_prefix="/", description=d.help_text, intents=intents)
+
+logger = logging.getLogger("nextcord")
+logger.setLevel(logging.INFO)
+handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
+handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
+logger.addHandler(handler)
+
+
+@bot.event
+async def on_ready():
+    logging.info("Starting Simple Stock Bot")
+    logging.info(f"Logged in as {bot.user.name} {bot.user.id}")
+
+
+@bot.command()
+async def status(ctx: commands):
+    """Debug command for diagnosing if the bot is experiencing any issues."""
+    logging.warning(f"Status command ran by {ctx.message.author}")
+    message = ""
+    try:
+        message = "Contact MisterBiggs#0465 if you need help.\n"
+        message += s.status(f"Bot recieved your message in: {bot.latency*1000:.4f}ms") + "\n"
+
+    except Exception as ex:
+        logging.critical(ex)
+        message += (
+            f"*\n\nERROR ENCOUNTERED:*\n{ex}\n\n"
+            + "*The bot encountered an error while attempting to find errors. Please contact the bot admin.*"
+        )
+    await ctx.send(message)
+
+
+@bot.command()
+async def license(ctx: commands):
+    """Returns the bots license agreement."""
+    await ctx.send(d.license)
+
+
+@bot.command()
+async def donate(ctx: commands):
+    """Details on how to support the development and hosting of the bot."""
+    await ctx.send(d.donate_text)
+
+
+@bot.command()
+async def search(ctx: commands, *, query: str):
+    """Search for a stock symbol using either symbol of company name."""
+    results = s.search_symbols(query)
+    if results:
+        reply = "*Search Results:*\n`$ticker: Company Name`\n"
+        for query in results:
+            reply += "`" + query[1] + "`\n"
+        await ctx.send(reply)
+
+
+@bot.command()
+async def crypto(ctx: commands, _: str):
+    """Get the price of a cryptocurrency using in USD."""
+    await ctx.send("Crypto now has native support. Any crypto can be called using two dollar signs: `$$eth` `$$btc` `$$doge`")
+
+
+@bot.command()
+async def intra(ctx: commands, sym: str):
+    """Get a chart for the stocks movement since market open."""
+    symbols = s.find_symbols(sym)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await ctx.send("No symbols or coins found.")
+        return
+
+    df = s.intra_reply(symbol)
+    if df.empty:
+        await ctx.send("Invalid symbol please see `/help` for usage details.")
+        return
+    with ctx.channel.typing():
+        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)
+
+        # Get price so theres no request lag after the image is sent
+        price_reply = s.price_reply([symbol])[0]
+        await ctx.send(
+            file=nextcord.File(
+                buf,
+                filename=f"{symbol.name}:intra{datetime.date.today().strftime('%S%M%d%b%Y')}.png",
+            ),
+            content=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')}",
+        )
+        await ctx.send(price_reply)
+
+
+@bot.command()
+async def chart(ctx: commands, sym: str):
+    """returns a chart of the past month of data for a symbol"""
+
+    symbols = s.find_symbols(sym)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await ctx.send("No symbols or coins found.")
+        return
+
+    df = s.chart_reply(symbol)
+    if df.empty:
+        await ctx.send("Invalid symbol please see `/help` for usage details.")
+        return
+    with ctx.channel.typing():
+        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)
+
+        # Get price so theres no request lag after the image is sent
+        price_reply = s.price_reply([symbol])[0]
+        await ctx.send(
+            file=nextcord.File(
+                buf,
+                filename=f"{symbol.name}:1M{datetime.date.today().strftime('%d%b%Y')}.png",
+            ),
+            content=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')}",
+        )
+        await ctx.send(price_reply)
+
+
+@bot.command()
+async def cap(ctx: commands, sym: str):
+    """Get the market cap of a symbol"""
+    symbols = s.find_symbols(sym)
+    if symbols:
+        with ctx.channel.typing():
+            for reply in s.cap_reply(symbols):
+                await ctx.send(reply)
+
+
+@bot.command()
+async def trending(ctx: commands):
+    """Get a list of Trending Stocks and Coins"""
+    with ctx.channel.typing():
+        await ctx.send(s.trending())
+
+
+@bot.event
+async def on_message(message):
+    if message.author.id == bot.user.id:
+        return
+    if message.content:
+        if message.content[0] == "/":
+            await bot.process_commands(message)
+            return
+
+        if "$" in message.content:
+            symbols = s.find_symbols(message.content)
+
+            if symbols:
+                for reply in s.price_reply(symbols):
+                    await message.channel.send(reply)
+                return
+
+
+bot.run(DISCORD_TOKEN)

discord/requirements.txt

@@ -0,0 +1,7 @@
+nextcord==2.4.2
+requests==2.25.1
+pandas==2.0.0
+schedule==1.0.0
+mplfinance==0.12.7a5
+markdownify==0.6.5
+cachetools==4.2.2

docker-compose.yaml

@@ -0,0 +1,13 @@
+version: '3'
+services:
+  telegram:
+    build:
+      context: .
+      dockerfile: telegram/Dockerfile
+    image: registry.gitlab.com/simple-stock-bots/simple-telegram-stock-bot
+    env_file: .env
+  discord:
+    build:
+      context: .
+      dockerfile: discord/Dockerfile
+    env_file: .env

telegram/Dockerfile

@@ -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" ]

telegram/bot.py

@@ -28,7 +28,7 @@ from telegram.ext import (
     Updater,
 )
 
-from symbol_router import Router
+from common.symbol_router import Router
 from T_info import T_info
 
 # Enable logging