.devcontainer/Dockerfile

@@ -1,3 +0,0 @@
-FROM python:3.11
-
-COPY . .

.devcontainer/devcontainer.json

@@ -1,39 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/python
-{
-  "name": "Python 3",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
-  "build": {
-    "dockerfile": "Dockerfile"
-  },
-  "features": {
-    "ghcr.io/devcontainers-contrib/features/black:2": {},
-    "ghcr.io/devcontainers-contrib/features/mypy:2": {},
-    "ghcr.io/devcontainers-contrib/features/pylint:2": {},
-    "ghcr.io/devcontainers/features/docker-in-docker": {}
-  },
-  "customizations": {
-    "vscode": {
-      "extensions": [
-		"ms-python.python",
-    "ms-python.black-formatter",
-		"ms-python.vscode-pylance",
-		"ms-python.isort",
-    "charliermarsh.ruff",
-    "ms-toolsai.jupyter"
-	]
-    }
-  },
-  "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-  // Use 'postCreateCommand' to run commands after the container is created.
-  // "postCreateCommand": "pip3 install --user -r requirements.txt",
-  // Configure tool-specific properties.
-  // "customizations": {},
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
-}

.gitignore

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

.gitlab-ci.yml

@@ -1,24 +1,21 @@
-stages:
-  - lint
-  - build
-  - build_site
-  - deploy
-  - deploy_site
-
-black:
-  stage: lint
-  image: registry.gitlab.com/pipeline-components/black:latest
-  script:
-    - black --check --verbose -- .
-
-ruff:
-  stage: lint
-  # image: registry.gitlab.com/pipeline-components/ruff:latest
-  image: python:3.11-slim
-  script:
-    - pip3 install ruff
-    - ruff --output-format gitlab .
-
-
-include:
-  - local: /site/.gitlab-ci.yml
+stages:
+  - docs
+
+pages:
+  stage: docs
+  image: python:alpine
+
+  before_script:
+    - pip install mkdocs
+    - pip install mkdocs-material
+
+  script:
+    - cd ./web
+    - mkdocs build
+    - mv site ../public
+    - cd ../
+  artifacts:
+    paths:
+      - public
+  only:
+    - documentation

.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true,
-    "editor.formatOnSaveMode": "modificationsIfAvailable",
-    "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter",
-        "editor.formatOnSave": true,
-        "editor.formatOnSaveMode": "file"
-    }
-}

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Anson Biggs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Anson Biggs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,44 +1,5 @@
-# Simple Stock Bots
-
-[![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-blue.svg)](https://t.me/SimpleStockBot)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
-[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
-
-Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed.
-
-## Documentation
-
-Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
-- [Official Documentation](https://simplestockbot.com/)
-- [Command Reference](https://simplestockbot.com/commands/)
-
-## Support the Project
-
-Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
-
-You can contribute by:
-- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
-- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
-- [Getting in touch](contact.md) for any inquiries or suggestions.
-
-### Additional Support:
-
-- Follow on [Twitter](https://twitter.com/AnsonBiggs)
-- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
-- Utilize referral links for self-hosting:
-  - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
-
-## Hosting
-
-Self-hosting instructions are provided for those interested in running the bot on their own servers:
-- [Hosting Guide](https://simplestockbot.com/hosting/)
-
-## Contact
-
-Reach out for bug reports, feature requests, or other inquiries:
-- [Contact Page](https://simplestockbot.com/contact/)
-
----
-
-Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.
+# simple-telegram-bot
+
+## A Telegram Bot for stock market Data.
+
+## Full documentation [here.](https://misterbiggs.gitlab.io/simple-telegram-bot)

bot/Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.7-slim
+
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+CMD [ "python", "./stockBot.py" ]

bot/credentials.py

@@ -0,0 +1,7 @@
+secrets = {
+    "TELEGRAM_TOKEN": "TELEGRAM_API_TOKEN",
+    "TWITTER_CONSUMER_API": "CONSUMER_API",
+    "TWITTER_CONSUMER_SECRET": "CONSUMER_SECRET",
+    "TWITTER_ACCESS_TOKEN": "ACCESS_TOKEN",
+    "TWITTER_ACCESS_SECRET": "ACCESS_SECRET",
+}

bot/requirements.txt

@@ -0,0 +1,2 @@
+telegram==0.0.1
+python-telegram-bot==11.1.0

bot/stockBot.py

@@ -0,0 +1,182 @@
+# Work with Python 3.7
+import json
+import logging
+import re
+import urllib.request
+
+import telegram
+from telegram.ext import CommandHandler, Filters, MessageHandler, Updater
+
+import credentials
+import tickerInfo
+
+TOKEN = credentials.secrets["TELEGRAM_TOKEN"]
+TICKER_REGEX = "[$]([a-zA-Z]{1,4})"
+
+# Enable logging
+logging.basicConfig(
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
+)
+
+logger = logging.getLogger(__name__)
+print("Bot Online")
+
+
+# Define a few command handlers. These usually take the two arguments bot and
+# update. Error handlers also receive the raised TelegramError object in error.
+def start(bot, update):
+    """Send a message when the command /start is issued."""
+    update.message.reply_text("I am started and ready to go!")
+
+
+def help(bot, update):
+    """Send link to docs when the command /help is issued."""
+    message = "[Please see the docs for Bot information](https://misterbiggs.gitlab.io/simple-telegram-bot)"
+    update.message.reply_text(text=message, parse_mode=telegram.ParseMode.MARKDOWN)
+
+
+def news(bot, update):
+    """Send a message when the /news command is issued."""
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    try:
+        # regex to find tickers in messages, looks for up to 4 word characters following a dollar sign and captures the 4 word characters
+        tickers = re.findall(TICKER_REGEX, message)
+        bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        ## Checks if a ticker was passed in
+        if tickers == []:
+            message = "No Ticker, showing Market News:"
+            news = tickerInfo.stockNews("market")
+            for i in range(len(news["title"])):
+                message = f"{message}\n\n[{news['title'][i]}]({news['link'][i]})"
+            update.message.reply_text(
+                text=message, parse_mode=telegram.ParseMode.MARKDOWN
+            )
+        else:
+            tickerData = tickerInfo.tickerQuote(tickers)
+            for ticker in tickers:
+                ticker = ticker.upper()
+                # Makes sure ticker exists
+                if tickerData[ticker] == 1:
+                    name = tickerData[ticker + "Name"]
+                    price = tickerData[ticker + "Price"]
+                    change = tickerData[ticker + "Change"]
+
+                    message = f"The current stock price of {name} is $**{price}**"
+                    if change > 0:
+                        message = f"{message}, the stock is currently **up {change}%**"
+                    elif change < 0:
+                        message = (
+                            f"{message}, the stock is currently **down {change}%**"
+                        )
+                    else:
+                        message = (
+                            f"{message}, the stock hasn't shown any movement today."
+                        )
+
+                    news = tickerInfo.stockNews(ticker)
+                    for i in range(len(news["title"])):
+                        message = (
+                            f"{message}\n\n[{news['title'][i]}]({news['link'][i]})"
+                        )
+
+                    update.message.reply_text(
+                        text=message, parse_mode=telegram.ParseMode.MARKDOWN
+                    )
+                else:
+                    update.message.reply_text(ticker + " Does not exist.")
+    except:
+        pass
+
+
+def stockInfo(bot, update):
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    try:
+        # regex to find tickers in messages, looks for up to 4 word characters following a dollar sign and captures the 4 word characters
+        tickers = re.findall(TICKER_REGEX, message)
+
+        if len(tickers) > 0:
+            tickerData = tickerInfo.tickerQuote(tickers)
+            bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for ticker in tickers:
+            ticker = ticker.upper()
+            # Makes sure ticker exists
+            if tickerData[ticker] == 1:
+                name = tickerData[ticker + "Name"]
+                price = tickerData[ticker + "Price"]
+                change = tickerData[ticker + "Change"]
+                message = f"The current stock price of {name} is $**{price}**"
+                if change > 0:
+                    message = f"{message}, the stock is currently **up {change}%**"
+                elif change < 0:
+                    message = f"{message}, the stock is currently **down {change}%**"
+                else:
+                    message = f"{message}, the stock hasn't shown any movement today."
+                update.message.reply_text(
+                    text=message, parse_mode=telegram.ParseMode.MARKDOWN
+                )
+            else:
+                update.message.reply_text(ticker + " Does not exist.")
+    except:
+        pass
+
+
+def dividend(bot, update):
+    message = update.message.text
+    chat_id = update.message.chat_id
+    try:
+        # regex to find tickers in messages, looks for up to 4 word characters following a dollar sign and captures the 4 word characters
+        tickers = re.findall(TICKER_REGEX, message)
+        bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for ticker in tickers:
+            message = tickerInfo.stockDividend(ticker)
+            update.message.reply_text(
+                text=message, parse_mode=telegram.ParseMode.MARKDOWN
+            )
+
+    except:
+        pass
+
+
+def error(bot, update, error):
+    """Log Errors caused by Updates."""
+    logger.warning('Update "%s" caused error "%s"', update, error)
+
+
+def main():
+    """Start the bot."""
+    # Create the EventHandler and pass it your bot's token.
+    updater = Updater(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("news", news))
+    dp.add_handler(CommandHandler("dividend", dividend))
+
+    # on noncommand i.e message - echo the message on Telegram
+    dp.add_handler(MessageHandler(Filters.text, stockInfo))
+
+    # log all errors
+    dp.add_error_handler(error)
+
+    # Start the Bot
+    updater.start_polling()
+
+    # Run the bot until you press Ctrl-C or the process receives SIGINT,
+    # SIGTERM or SIGABRT. This should be used most of the time, since
+    # start_polling() is non-blocking and will stop the bot gracefully.
+    updater.idle()
+
+
+if __name__ == "__main__":
+    main()

bot/tickerInfo.py

@@ -0,0 +1,105 @@
+import urllib.request
+import json
+from datetime import datetime
+import time
+
+
+def tickerQuote(tickers):
+    """Gathers information from IEX api on stock"""
+    stockData = {}
+    IEXURL = (
+        "https://api.iextrading.com/1.0/stock/market/batch?symbols="
+        + ",".join(tickers)
+        + "&types=quote"
+    )
+    print("Gathering Quote from " + IEXURL)
+    with urllib.request.urlopen(IEXURL) as url:
+        IEXData = json.loads(url.read().decode())
+
+    for ticker in tickers:
+        ticker = ticker.upper()
+
+        # Makes sure ticker exists before populating a dictionary
+        if ticker in IEXData:
+            stockData[ticker] = 1
+            stockData[ticker + "Name"] = IEXData[ticker]["quote"]["companyName"]
+            stockData[ticker + "Price"] = IEXData[ticker]["quote"]["latestPrice"]
+            stockData[ticker + "Change"] = round(
+                (IEXData[ticker]["quote"]["changePercent"] * 100), 2
+            )
+            stockData[ticker + "Image"] = stockLogo(ticker)
+            print(ticker + " Quote Gathered")
+        else:
+            stockData[ticker] = 0
+    return stockData
+
+
+def stockNews(ticker):
+    """Makes a bunch of strings that are links to news websites for an input ticker"""
+    print("Gather News on " + ticker)
+
+    newsLink = f"https://api.iextrading.com/1.0/stock/{ticker}/news/last/5"
+    print(newsLink)
+    with urllib.request.urlopen(newsLink) as url:
+        data = json.loads(url.read().decode())
+
+    news = {"link": [], "title": []}
+    for i in range(len(data)):
+        news["link"].append(data[i]["url"])
+        news["title"].append(data[i]["headline"])
+    return news
+
+
+def stockLogo(ticker):
+    """returns a png of an input ticker"""
+    logoURL = f"https://g.foolcdn.com/art/companylogos/mark/{ticker}.png"
+    return logoURL
+
+
+def stockInfo(ticker):
+    infoURL = f"https://api.iextrading.com/1.0/stock/{ticker}/stats"
+
+    with urllib.request.urlopen(infoURL) as url:
+        data = json.loads(url.read().decode())
+
+    info = {}
+
+    info["companyName"] = data["companyName"]
+    info["marketCap"] = data["marketcap"]
+    info["yearHigh"] = data["week52high"]
+    info["yearLow"] = data["week52low"]
+    info["divRate"] = data["dividendRate"]
+    info["divYield"] = data["dividendYield"]
+    info["divDate"] = data["exDividendDate"]
+
+    return info
+
+
+def stockDividend(ticker):
+    data = stockInfo(ticker)
+    print(data["divDate"])
+    if data["divDate"] == 0:
+        return "{} has no dividend.".format(data["companyName"])
+
+    line1 = "{} current dividend yield is: {:.3f}%, or ${:.3f} per share.".format(
+        data["companyName"], data["divRate"], data["divYield"]
+    )
+
+    divDate = data["divDate"]
+
+    # Pattern IEX uses for dividend date.
+    pattern = "%Y-%m-%d %H:%M:%S.%f"
+
+    # Convert divDate to seconds, and subtract it from current time.
+    divSeconds = datetime.strptime(divDate, pattern).timestamp()
+    difference = divSeconds - int(time.time())
+
+    # Calculate (d)ays, (h)ours, (m)inutes, and (s)econds
+    d, h = divmod(difference, 86400)
+    h, m = divmod(h, 3600)
+    m, s = divmod(m, 60)
+
+    countdownMessage = f"\n\nThe dividend is in: {d:.0f} Days {h:.0f} Hours {m:.0f} Minutes {s:.0f} Seconds."
+
+    message = line1 + countdownMessage
+    return message

common/MarketData.py

@@ -1,345 +0,0 @@
-import datetime as dt
-import logging
-import os
-from typing import Dict
-from collections import OrderedDict
-
-import humanize
-import pandas as pd
-import pytz
-import requests as r
-import schedule
-
-from common.Symbol import Stock
-
-log = logging.getLogger(__name__)
-
-
-class MarketData:
-    """
-    Functions for finding stock market information about symbols from MarkData.app
-    """
-
-    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
-
-    symbol_list: Dict[str, Dict] = {}
-    charts: Dict[Stock, pd.DataFrame] = {}
-
-    openTime = dt.time(hour=9, minute=30, second=0)
-    marketTimeZone = pytz.timezone("US/Eastern")
-
-    def __init__(self) -> None:
-        """Creates a Symbol Object
-
-        Parameters
-        ----------
-        MARKETDATA_TOKEN : str
-            MarketData.app API Token
-        """
-
-        try:
-            self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
-
-            if self.MARKETDATA_TOKEN == "TOKEN":
-                self.MARKETDATA_TOKEN = ""
-        except KeyError:
-            self.MARKETDATA_TOKEN = ""
-            log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
-            log.warning("Use this affiliate link so that the bot can stay free:")
-            log.warning("https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo")
-
-        if self.MARKETDATA_TOKEN != "":
-            schedule.every().day.do(self.clear_charts)
-
-        self.get_symbol_list()
-        schedule.every().day.do(self.get_symbol_list)
-
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
-        url = "https://api.marketdata.app/v1/" + endpoint
-
-        # set token param if it wasn't passed.
-        params["token"] = self.MARKETDATA_TOKEN
-
-        # Undocumented query variable that ensures bot usage can be
-        # monitored even if someone doesn't make it through an affiliate link.
-        params["application"] = "simplestockbot"
-
-        resp = r.get(url, params=params, timeout=timeout)
-
-        # Make sure API returned a proper status code
-        try:
-            resp.raise_for_status()
-        except r.exceptions.HTTPError as e:
-            logging.error(e)
-            return {}
-
-        # Make sure API returned valid JSON
-        try:
-            resp_json = resp.json()
-
-            match resp_json["s"]:
-                case "ok":
-                    return resp_json
-                case "no_data":
-                    return resp_json
-                case "error":
-                    logging.error("MarketData Error:\n" + resp_json["errmsg"])
-                    return {}
-
-        except r.exceptions.JSONDecodeError as e:
-            logging.error(e)
-
-        return {}
-
-    def symbol_id(self, symbol: str) -> Dict[str, Dict]:
-        return self.symbol_list.get(symbol.upper(), None)
-
-    def get_symbol_list(self):
-        sec_resp = r.get("https://www.sec.gov/files/company_tickers.json")
-        sec_resp.raise_for_status()
-        sec_data = sec_resp.json()
-
-        for rank, ticker_info in sec_data.items():
-            self.symbol_list[ticker_info["ticker"]] = {
-                "ticker": ticker_info["ticker"],
-                "title": ticker_info["title"],
-                "mkt_cap_rank": rank,
-            }
-
-    def clear_charts(self) -> None:
-        """
-        Clears cache of chart data.
-        Charts are cached so that only 1 API call per 24 hours is needed since the
-            chart data is expensive and a large download.
-        """
-        self.charts = {}
-
-    def status(self) -> str:
-        # TODO: At the moment this API is poorly documented, this function likely needs to be revisited later.
-
-        try:
-            status = r.get(
-                "https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A",
-                timeout=5,
-            )
-            status.raise_for_status()
-        except r.HTTPError:
-            return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
-        except r.Timeout:
-            return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
-
-        statusJSON = status.json()
-
-        if statusJSON["status"] == "ok":
-            return (
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
-            )
-        else:
-            return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
-
-    def price_reply(self, symbol: Stock) -> str:
-        """Returns price movement of Stock for the last market day, or after hours.
-
-        Parameters
-        ----------
-        symbol : Stock
-
-        Returns
-        -------
-        str
-            Formatted markdown
-        """
-
-        if quoteResp := self.get(f"stocks/quotes/{symbol.symbol}/"):
-            price = round(quoteResp["last"][0], 2)
-
-            try:
-                changePercent = round(quoteResp["changepct"][0], 2)
-            except TypeError:
-                return f"The price of {symbol.name} is ${price}"
-
-            message = f"The current price of {symbol.name} is ${price} and "
-
-            if changePercent > 0.0:
-                message += f"is currently up {changePercent}% for the day."
-            elif changePercent < 0.0:
-                message += f"is currently down {changePercent}% for the day."
-            else:
-                message += "hasn't shown any movement for the day."
-
-            return message
-        else:
-            return f"Getting a quote for {symbol} encountered an error."
-
-    def spark_reply(self, symbol: Stock) -> str:
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
-            try:
-                changePercent = round(quoteResp["changepct"][0], 2)
-                return f"`{symbol.tag}`: {changePercent}%"
-            except TypeError:
-                pass
-
-        return f"`{symbol.tag}`"
-
-    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        schedule.run_pending()
-
-        try:
-            return self.charts[symbol.id.upper()]
-        except KeyError:
-            pass
-
-        resolution = "15"  # minutes
-        now = dt.datetime.now(self.marketTimeZone)
-
-        if self.openTime < now.time():
-            startTime = now.replace(hour=9, minute=30)
-        else:
-            startTime = now - dt.timedelta(days=1)
-
-        if data := self.get(
-            f"stocks/candles/{resolution}/{symbol}",
-            params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
-        ):
-            data.pop("s")
-            df = pd.DataFrame(data)
-            df["t"] = pd.to_datetime(df["t"], unit="s", utc=True)
-            df.set_index("t", inplace=True)
-
-            df.rename(
-                columns={
-                    "o": "Open",
-                    "h": "High",
-                    "l": "Low",
-                    "c": "Close",
-                    "v": "Volume",
-                },
-                inplace=True,
-            )
-
-            self.charts[symbol.id.upper()] = df
-            return df
-
-        return pd.DataFrame()
-
-    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        schedule.run_pending()
-
-        try:
-            return self.charts[symbol.id.upper()]
-        except KeyError:
-            pass
-
-        to_date = dt.datetime.today().strftime("%Y-%m-%d")
-        from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
-        resultion = "daily"
-
-        if data := self.get(
-            f"stocks/candles/{resultion}/{symbol}",
-            params={
-                "from": from_date,
-                "to": to_date,
-            },
-        ):
-            data.pop("s")
-
-            df = pd.DataFrame(data)
-            df["t"] = pd.to_datetime(df["t"], unit="s")
-            df.set_index("t", inplace=True)
-
-            df.rename(
-                columns={
-                    "o": "Open",
-                    "h": "High",
-                    "l": "Low",
-                    "c": "Close",
-                    "v": "Volume",
-                },
-                inplace=True,
-            )
-
-            self.charts[symbol.id.upper()] = df
-            return df
-
-        return pd.DataFrame()
-
-    def options_reply(self, request: str) -> str:
-        """Undocumented API Usage!"""
-
-        options_data = self.get(f"options/quotes/{request}")
-
-        for key in options_data.keys():
-            options_data[key] = options_data[key][0]
-
-        options_data["underlying"] = "$" + options_data["underlying"]
-
-        options_data["updated"] = humanize.naturaltime(dt.datetime.now() - dt.datetime.fromtimestamp(options_data["updated"]))
-
-        options_data["expiration"] = humanize.naturaltime(
-            dt.datetime.now() - dt.datetime.fromtimestamp(options_data["expiration"])
-        )
-
-        options_data["firstTraded"] = humanize.naturaltime(
-            dt.datetime.now() - dt.datetime.fromtimestamp(options_data["firstTraded"])
-        )
-
-        rename = {
-            "optionSymbol": "Option Symbol",
-            "underlying": "Underlying",
-            "expiration": "Expiration",
-            "side": "side",
-            "strike": "strike",
-            "firstTraded": "First Traded",
-            "updated": "Last Updated",
-            "bid": "bid",
-            "bidSize": "bidSize",
-            "mid": "mid",
-            "ask": "ask",
-            "askSize": "askSize",
-            "last": "last",
-            "openInterest": "Open Interest",
-            "volume": "Volume",
-            "inTheMoney": "inTheMoney",
-            "intrinsicValue": "Intrinsic Value",
-            "extrinsicValue": "Extrinsic Value",
-            "underlyingPrice": "Underlying Price",
-            "iv": "Implied Volatility",
-            "delta": "delta",
-            "gamma": "gamma",
-            "theta": "theta",
-            "vega": "vega",
-            "rho": "rho",
-        }
-
-        options_cleaned = OrderedDict()
-        for old, new in rename.items():
-            if old in options_data:
-                options_cleaned[new] = options_data[old]
-
-        return options_cleaned

common/Symbol.py

@@ -1,52 +0,0 @@
-import logging
-
-import pandas as pd
-
-
-class Symbol:
-    """
-    symbol: What the user calls it. ie tsla or btc
-    id: What the api expects. ie tsla or bitcoin
-    name: Human readable. ie Tesla or Bitcoin
-    tag: Uppercase tag to call the symbol. ie $TSLA or $$BTC
-    """
-
-    currency = "usd"
-    pass
-
-    def __init__(self, symbol) -> None:
-        self.symbol = symbol
-        self.id = symbol
-        self.name = symbol
-        self.tag = "$" + symbol
-
-    def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} instance of {self.id} at {id(self)}>"
-
-    def __str__(self) -> str:
-        return self.id
-
-
-class Stock(Symbol):
-    """Stock Market Object. Gets data from MarketData"""
-
-    def __init__(self, symbol_info: dict) -> None:
-        self.symbol = symbol_info["ticker"]
-        self.id = symbol_info["ticker"]
-        self.name = symbol_info["title"]
-        self.tag = "$" + symbol_info["ticker"]
-        self.market_cap_rank = symbol_info["mkt_cap_rank"]
-
-
-class Coin(Symbol):
-    """Cryptocurrency Object. Gets data from CoinGecko."""
-
-    def __init__(self, symbol: pd.DataFrame) -> None:
-        if len(symbol) > 1:
-            logging.info(f"Crypto with shared id:\n\t{symbol.id}")
-            symbol = symbol.head(1)
-
-        self.symbol = symbol.symbol.values[0]
-        self.id = symbol.id.values[0]
-        self.name = symbol.name.values[0]
-        self.tag = symbol.type_id.values[0].upper()

common/cg_Crypto.py

@@ -1,367 +0,0 @@
-import logging
-from typing import List
-
-import pandas as pd
-import requests as r
-import schedule
-from markdownify import markdownify
-
-from common.Symbol import Coin
-
-log = logging.getLogger(__name__)
-
-
-class cg_Crypto:
-    """
-    Functions for finding crypto info
-    """
-
-    vs_currency = "usd"  # simple/supported_vs_currencies for list of options
-
-    trending_cache: List[str] = []
-
-    def __init__(self) -> None:
-        self.get_symbol_list()
-        schedule.every().day.do(self.get_symbol_list)
-
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
-        url = "https://api.coingecko.com/api/v3" + endpoint
-        resp = r.get(url, params=params, timeout=timeout)
-        # Make sure API returned a proper status code
-        try:
-            resp.raise_for_status()
-        except r.exceptions.HTTPError as e:
-            log.error(e)
-            return {}
-
-        # Make sure API returned valid JSON
-        try:
-            resp_json = resp.json()
-            return resp_json
-        except r.exceptions.JSONDecodeError as e:
-            log.error(e)
-            return {}
-
-    def symbol_id(self, symbol) -> str:
-        try:
-            return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[0]
-        except KeyError:
-            return ""
-
-    def get_symbol_list(self):
-        raw_symbols = self.get("/coins/list")
-        symbols = pd.DataFrame(data=raw_symbols)
-
-        # Removes all binance-peg symbols
-        symbols = symbols[~symbols["id"].str.contains("binance-peg")]
-
-        symbols["description"] = "$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
-        symbols = symbols[["id", "symbol", "name", "description"]]
-        symbols["type_id"] = "$$" + symbols["symbol"]
-
-        self.symbol_list = symbols
-
-    def status(self) -> str:
-        """Checks CoinGecko /ping endpoint for API issues.
-
-        Returns
-        -------
-        str
-            Human readable text on status of CoinGecko API
-        """
-        status = r.get(
-            "https://api.coingecko.com/api/v3/ping",
-            timeout=5,
-        )
-
-        try:
-            status.raise_for_status()
-            return (
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
-            )
-        except r.HTTPError:
-            return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
-
-    def price_reply(self, coin: Coin) -> str:
-        """Returns current market price or after hours if its available for a given coin symbol.
-
-        Parameters
-        ----------
-        symbols : list
-            List of coin symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-            markdown formatted string of the symbols price and movement.
-        """
-
-        if resp := self.get(
-            "/simple/price",
-            params={
-                "ids": coin.id,
-                "vs_currencies": self.vs_currency,
-                "include_24hr_change": "true",
-            },
-        ):
-            try:
-                data = resp[coin.id]
-
-                price = data[self.vs_currency]
-                change = data[self.vs_currency + "_24h_change"]
-                if change is None:
-                    change = 0
-            except KeyError:
-                return f"{coin.id} returned an error."
-
-            message = f"The current price of {coin.name} is $**{price:,}**"
-
-            # Determine wording of change text
-            if change > 0:
-                message += f", the coin is currently **up {change:.3f}%** for today"
-            elif change < 0:
-                message += f", the coin is currently **down {change:.3f}%** for today"
-            else:
-                message += ", the coin hasn't shown any movement today."
-
-        else:
-            message = f"The price for {coin.name} is not available. If you suspect this is an error run `/status`"
-
-        return message
-
-    def intra_reply(self, symbol: Coin) -> pd.DataFrame:
-        """Returns price data for a symbol since the last market open.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-
-        if resp := self.get(
-            f"/coins/{symbol.id}/ohlc",
-            params={"vs_currency": self.vs_currency, "days": 1},
-        ):
-            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
-            df["Date"] = pd.to_datetime(df["Date"], unit="ms")
-            df = df.set_index("Date")
-            return df
-
-        return pd.DataFrame()
-
-    def chart_reply(self, symbol: Coin) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-
-        if resp := self.get(
-            f"/coins/{symbol.id}/ohlc",
-            params={"vs_currency": self.vs_currency, "days": 30},
-        ):
-            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
-            df["Date"] = pd.to_datetime(df["Date"], unit="ms")
-            df = df.set_index("Date")
-            return df
-
-        return pd.DataFrame()
-
-    def stat_reply(self, symbol: Coin) -> str:
-        """Gathers key statistics on coin. Mostly just CoinGecko scores.
-
-        Parameters
-        ----------
-        symbol : Coin
-
-        Returns
-        -------
-        str
-            Preformatted markdown.
-        """
-
-        if data := self.get(
-            f"/coins/{symbol.id}",
-            params={
-                "localization": "false",
-            },
-        ):
-            return f"""
-                [{data['name']}]({data['links']['homepage'][0]}) Statistics:
-                Market Cap: ${data['market_data']['market_cap'][self.vs_currency]:,}
-                Market Cap Ranking: {data.get('market_cap_rank',"Not Available")}
-                CoinGecko Scores:
-                    Overall: {data.get('coingecko_score','Not Available')}
-                    Development: {data.get('developer_score','Not Available')}
-                    Community: {data.get('community_score','Not Available')}
-                    Public Interest: {data.get('public_interest_score','Not Available')}
-                    """
-        else:
-            return f"{symbol.symbol} returned an error."
-
-    def cap_reply(self, coin: Coin) -> str:
-        """Gets market cap for Coin
-
-        Parameters
-        ----------
-        coin : Coin
-
-        Returns
-        -------
-        str
-            Preformatted markdown.
-        """
-
-        if resp := self.get(
-            "/simple/price",
-            params={
-                "ids": coin.id,
-                "vs_currencies": self.vs_currency,
-                "include_market_cap": "true",
-            },
-        ):
-            log.debug(resp)
-            try:
-                data = resp[coin.id]
-
-                price = data[self.vs_currency]
-                cap = data[self.vs_currency + "_market_cap"]
-            except KeyError:
-                return f"{coin.id} returned an error."
-
-            if cap == 0:
-                return f"The market cap for {coin.name} is not available for unknown reasons."
-
-            message = (
-                f"The current price of {coin.name} is $**{price:,}** and"
-                + " its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
-            )
-
-        else:
-            message = f"The Coin: {coin.name} was not found or returned and error."
-
-        return message
-
-    def info_reply(self, symbol: Coin) -> str:
-        """Gets coin description
-
-        Parameters
-        ----------
-        symbol : Coin
-
-        Returns
-        -------
-        str
-            Preformatted markdown.
-        """
-
-        if data := self.get(
-            f"/coins/{symbol.id}",
-            params={"localization": "false"},
-        ):
-            try:
-                return markdownify(data["description"]["en"])
-            except KeyError:
-                return f"{symbol} does not have a description available."
-
-        return f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
-
-    def spark_reply(self, symbol: Coin) -> str:
-        change = self.get(
-            "/simple/price",
-            params={
-                "ids": symbol.id,
-                "vs_currencies": self.vs_currency,
-                "include_24hr_change": "true",
-            },
-        )[symbol.id]["usd_24h_change"]
-
-        return f"`{symbol.tag}`: {symbol.name}, {change:.2f}%"
-
-    def trending(self) -> list[str]:
-        """Gets current coins trending on coingecko
-
-        Returns
-        -------
-        list[str]
-            list of $$ID: NAME, CHANGE%
-        """
-
-        coins = self.get("/search/trending")
-        try:
-            trending = []
-            for coin in coins["coins"]:
-                c = coin["item"]
-
-                sym = c["symbol"].upper()
-                name = c["name"]
-                change = self.get(
-                    "/simple/price",
-                    params={
-                        "ids": c["id"],
-                        "vs_currencies": self.vs_currency,
-                        "include_24hr_change": "true",
-                    },
-                )[c["id"]]["usd_24h_change"]
-
-                msg = f"`$${sym}`: {name}, {change:.2f}%"
-
-                trending.append(msg)
-
-        except Exception as e:
-            log.warning(e)
-            return self.trending_cache
-
-        self.trending_cache = trending
-        return trending
-
-    def batch_price(self, coins: list[Coin]) -> list[str]:
-        """Gets price of a list of coins all in one API call
-
-        Parameters
-        ----------
-        coins : list[Coin]
-
-        Returns
-        -------
-        list[str]
-            returns preformatted list of strings detailing price movement of each coin passed in.
-        """
-        query = ",".join([c.id for c in coins])
-
-        prices = self.get(
-            "/simple/price",
-            params={
-                "ids": query,
-                "vs_currencies": self.vs_currency,
-                "include_24hr_change": "true",
-            },
-        )
-
-        replies = []
-        for coin in coins:
-            if coin.id in prices:
-                p = prices[coin.id]
-
-                if p.get("usd_24h_change") is None:
-                    p["usd_24h_change"] = 0
-
-                replies.append(
-                    f"{coin.name}: ${p.get('usd',0):,} and has moved {p.get('usd_24h_change',0.0):.2f}% in the past 24 hours."
-                )
-
-        return replies

common/requirements.txt

@@ -1,7 +0,0 @@
-cachetools==5.3.1
-humanize==4.8.0
-markdownify==0.11.6
-mplfinance==0.12.10b0
-pandas==2.1.1
-requests==2.31.0
-schedule==1.2.1

common/symbol_router.py

@@ -1,407 +0,0 @@
-"""Function that routes symbols to the correct API provider.
-"""
-
-import datetime
-import logging
-import random
-import re
-from typing import Dict
-
-import pandas as pd
-import schedule
-from cachetools import TTLCache, cached
-
-from common.cg_Crypto import cg_Crypto
-from common.MarketData import MarketData
-from common.Symbol import Coin, Stock, Symbol
-
-log = logging.getLogger(__name__)
-
-
-class Router:
-    STOCK_REGEX = "(?:^|[^\\$])\\$([a-zA-Z.]{1,6})"
-    CRYPTO_REGEX = "[$]{2}([a-zA-Z]{1,20})"
-    trending_count: Dict[str, float] = {}
-
-    def __init__(self):
-        self.stock = MarketData()
-        self.crypto = cg_Crypto()
-
-        schedule.every().hour.do(self.trending_decay)
-
-    def trending_decay(self, decay=0.5):
-        """Decays the value of each trending stock by a multiplier"""
-        t_copy = {}
-        dead_keys = []
-        if self.trending_count:
-            t_copy = self.trending_count.copy()
-            for key in t_copy.keys():
-                if t_copy[key] < 0.01:
-                    # Prune Keys
-                    dead_keys.append(key)
-                else:
-                    t_copy[key] = t_copy[key] * decay
-        for dead in dead_keys:
-            t_copy.pop(dead)
-
-        self.trending_count = t_copy.copy()
-        log.info("Decayed trending symbols.")
-
-    def find_symbols(self, text: str, *, trending_weight: int = 1) -> list[Stock | Coin]:
-        """Finds stock tickers starting with a dollar sign, and cryptocurrencies with two dollar signs
-        in a blob of text and returns them in a list.
-
-        Parameters
-        ----------
-        text : str
-            Blob of text.
-
-        Returns
-        -------
-        list[Symbol]
-            List of stock symbols as Symbol objects
-        """
-        schedule.run_pending()
-
-        symbols: list[Symbol] = []
-        stock_matches = set(re.findall(self.STOCK_REGEX, text))
-        coin_matches = set(re.findall(self.CRYPTO_REGEX, text))
-
-        for stock_match in stock_matches:
-            # Market data lacks tools to check if a symbol is valid.
-            if stock_info := self.stock.symbol_id(stock_match):
-                symbols.append(Stock(stock_info))
-            else:
-                log.info(f"{stock_match} is not in list of stocks")
-
-        for coin_match in coin_matches:
-            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin_match.lower(), case=False)]
-            if sym.empty:
-                log.info(f"{coin_match} is not in list of coins")
-            else:
-                symbols.append(Coin(sym))
-        if symbols:
-            for symbol in symbols:
-                self.trending_count[symbol.tag] = self.trending_count.get(symbol.tag, 0) + trending_weight
-                log.debug(self.trending_count)
-
-        return symbols
-
-    def status(self, bot_resp) -> str:
-        """Checks for any issues with APIs.
-
-        Returns
-        -------
-        str
-            Human readable text on status of the bot and relevant APIs
-        """
-
-        stats = f"""
-        Bot Status:
-        {bot_resp}
-
-        Stock Market Data:
-        {self.stock.status()}
-
-        Cryptocurrency Data:
-        {self.crypto.status()}
-        """
-
-        log.warning(stats)
-
-        return stats
-
-    def inline_search(self, search: str, matches: int = 5) -> pd.DataFrame:
-        """Searches based on the shortest symbol that contains the same string as the search.
-        Should be very fast compared to a fuzzy search.
-
-        Parameters
-        ----------
-        search : str
-            String used to match against symbols.
-
-        Returns
-        -------
-        list[tuple[str, str]]
-            Each tuple contains: (Symbol, Issue Name).
-        """
-
-        # df = pd.concat([self.stock.symbol_list, self.crypto.symbol_list])
-        df = self.crypto.symbol_list
-
-        df = df[df["description"].str.contains(search, regex=False, case=False)].sort_values(
-            by="type_id", key=lambda x: x.str.len()
-        )
-
-        symbols = df.head(matches)
-        symbols["price_reply"] = symbols["type_id"].apply(
-            lambda sym: self.price_reply(self.find_symbols(sym, trending_weight=0))[0]
-        )
-
-        return symbols
-
-    def price_reply(self, symbols: list[Symbol]) -> list[str]:
-        """Returns current market price or after hours if its available for a given stock symbol.
-
-        Parameters
-        ----------
-        symbols : list
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-            markdown formatted string of the symbols price and movement.
-        """
-        replies = []
-
-        for symbol in symbols:
-            log.info(symbol)
-            if isinstance(symbol, Stock):
-                replies.append(self.stock.price_reply(symbol))
-            elif isinstance(symbol, Coin):
-                replies.append(self.crypto.price_reply(symbol))
-            else:
-                log.info(f"{symbol} is not a Stock or Coin")
-
-        return replies
-
-    def info_reply(self, symbols: list) -> list[str]:
-        """Gets information on stock symbols.
-
-        Parameters
-        ----------
-        symbols : list[str]
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable formatted
-                string of the symbols information.
-        """
-        replies = []
-
-        for symbol in symbols:
-            if isinstance(symbol, Stock):
-                replies.append(self.stock.info_reply(symbol))
-            elif isinstance(symbol, Coin):
-                replies.append(self.crypto.info_reply(symbol))
-            else:
-                log.debug(f"{symbol} is not a Stock or Coin")
-
-        return replies
-
-    def intra_reply(self, symbol: Symbol) -> pd.DataFrame:
-        """Returns price data for a symbol since the last market open.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available.
-                Otherwise returns empty pd.DataFrame.
-        """
-
-        if isinstance(symbol, Stock):
-            return self.stock.intra_reply(symbol)
-        elif isinstance(symbol, Coin):
-            return self.crypto.intra_reply(symbol)
-        else:
-            log.debug(f"{symbol} is not a Stock or Coin")
-            return pd.DataFrame()
-
-    def chart_reply(self, symbol: Symbol) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available.
-                Otherwise returns empty pd.DataFrame.
-        """
-        if isinstance(symbol, Stock):
-            return self.stock.chart_reply(symbol)
-        elif isinstance(symbol, Coin):
-            return self.crypto.chart_reply(symbol)
-        else:
-            log.debug(f"{symbol} is not a Stock or Coin")
-            return pd.DataFrame()
-
-    def stat_reply(self, symbols: list[Symbol]) -> list[str]:
-        """Gets key statistics for each symbol in the list
-
-        Parameters
-        ----------
-        symbols : list[str]
-            List of stock symbols
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-                formatted string of the symbols statistics.
-        """
-        replies = []
-
-        for symbol in symbols:
-            if isinstance(symbol, Stock):
-                replies.append(self.stock.stat_reply(symbol))
-            elif isinstance(symbol, Coin):
-                replies.append(self.crypto.stat_reply(symbol))
-            else:
-                log.debug(f"{symbol} is not a Stock or Coin")
-
-        return replies
-
-    def cap_reply(self, symbols: list[Symbol]) -> list[str]:
-        """Gets market cap for each symbol in the list
-
-        Parameters
-        ----------
-        symbols : list[str]
-            List of stock symbols
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-                formatted string of the symbols market cap.
-        """
-        replies = []
-
-        for symbol in symbols:
-            if isinstance(symbol, Stock):
-                replies.append(self.stock.cap_reply(symbol))
-            elif isinstance(symbol, Coin):
-                replies.append(self.crypto.cap_reply(symbol))
-            else:
-                log.debug(f"{symbol} is not a Stock or Coin")
-
-        return replies
-
-    def spark_reply(self, symbols: list[Symbol]) -> list[str]:
-        """Gets change for each symbol and returns it in a compact format
-
-        Parameters
-        ----------
-        symbols : list[str]
-            List of stock symbols
-
-        Returns
-        -------
-        list[str]
-            List of human readable strings.
-        """
-        replies = []
-
-        for symbol in symbols:
-            if isinstance(symbol, Stock):
-                replies.append(self.stock.spark_reply(symbol))
-            elif isinstance(symbol, Coin):
-                replies.append(self.crypto.spark_reply(symbol))
-            else:
-                log.debug(f"{symbol} is not a Stock or Coin")
-
-        return replies
-
-    @cached(cache=TTLCache(maxsize=1024, ttl=600))
-    def trending(self) -> str:
-        """Checks APIs for trending symbols.
-
-        Returns
-        -------
-        list[str]
-            List of preformatted strings to be sent to user.
-        """
-
-        # stocks = self.stock.trending()
-        coins = self.crypto.trending()
-
-        reply = ""
-
-        log.warning(self.trending_count)
-        if self.trending_count:
-            reply += "🔥Trending on the Stock Bot:\n`"
-            reply += "━" * len("Trending on the Stock Bot:") + "`\n"
-
-            sorted_trending = [s[0] for s in sorted(self.trending_count.items(), key=lambda item: item[1])][::-1][0:5]
-            log.warning(sorted_trending)
-            for t in sorted_trending:
-                reply += self.spark_reply(self.find_symbols(t))[0] + "\n"
-
-        if coins:
-            reply += "\n\n🦎Trending on CoinGecko:\n`"
-            reply += "━" * len("Trending on CoinGecko:") + "`\n"
-            for coin in coins:
-                reply += coin + "\n"
-
-        if "`$GME" in reply:
-            reply = reply.replace("🔥", "🦍")
-
-        if reply:
-            return reply
-        else:
-            log.warning("Failed to collect trending data.")
-            return "Trending data is not currently available."
-
-    def random_pick(self) -> str:
-        # choice = random.choice(list(self.stock.symbol_list["description"]) + list(self.crypto.symbol_list["description"]))
-        choice = random.choice(list(self.crypto.symbol_list["description"]))
-        hold = (datetime.date.today() + datetime.timedelta(random.randint(1, 365))).strftime("%b %d, %Y")
-
-        return f"{choice}\nBuy and hold until: {hold}"
-
-    def batch_price_reply(self, symbols: list[Symbol]) -> list[str]:
-        """Returns current market price or after hours if its available for a given stock symbol.
-
-        Parameters
-        ----------
-        symbols : list
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-            markdown formatted string of the symbols price and movement.
-        """
-        replies = []
-        stocks = []
-        coins = []
-
-        for symbol in symbols:
-            if isinstance(symbol, Stock):
-                stocks.append(symbol)
-            elif isinstance(symbol, Coin):
-                coins.append(symbol)
-            else:
-                log.debug(f"{symbol} is not a Stock or Coin")
-
-        if stocks:
-            for stock in stocks:
-                replies.append(self.stock.price_reply(stock))
-        if coins:
-            replies = replies + self.crypto.batch_price(coins)
-
-        return replies
-
-    def options(self, request: str, symbols: list[Symbol]) -> Dict:
-        request = request.lower()
-        if len(symbols) == 1:
-            symbol = symbols[0]
-            request = request.replace(symbol.tag.lower(), symbol.symbol.lower())
-            return self.stock.options_reply(request)
-        else:
-            return self.stock.options_reply(request)

dev-reqs.txt

@@ -1,12 +0,0 @@
--r common/requirements.txt
--r site/requirements.txt
-black==23.9.1
-ipython==8.16.1
-jupyter_client==8.4.0
-jupyter_core==5.4.0
-pylama==8.4.1
-mypy==1.5.1
-types-cachetools==5.3.0.6
-types-pytz==2023.3.1.1
-ruff==0.0.292
-isort==5.12.0

discord/D_info.py

@@ -1,59 +0,0 @@
-"""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. If you like it, [support me with a beer](https://www.buymeacoffee.com/Anson). 🍻
-
-For stock data or hosting your own bot, use my link. This helps keep the bot free:
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
-
-**Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
-
-**Documentation**: All details about the bot are at [docs](https://simplestockbot.com).
-
-The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
-- `/chart $$eth` gives Ethereum's monthly chart.
-- `/dividend $psec` shows Prospect Capital's dividend.
-
-Type any symbol, and the bot shows its price. Like: `Is $$btc rising since $tsla accepts it?` will give Bitcoin and Tesla prices.
-
-**Commands**
-- `/donate [USD amount]`: Support the bot. 🎗️
-- `/intra $[symbol]`: See stock's latest movement. 📈
-- `/chart $[symbol]`: View a month's stock activity. 📊
-- `/trending`: Check trending stocks and cryptos. 💬
-- `/help`: Need help? Ask here. 🆘
-
-**Inline Features**
-Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. Note: Prices might be delayed up to an hour.
-
-Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
-
-Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact).
-    """
-
-    donate_text = """
-Simple Stock Bot runs purely on [donations.](https://www.buymeacoffee.com/Anson)
-Every donation supports server costs and
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord) provides our data.
-
-**How to Donate?**
-1. Use `/donate [amount in USD]` command.
-   - E.g., `/donate 2` donates 2 USD.
-2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
-    - It's quick, doesn't need an account, and accepts Paypal or Credit card.
-
-Questions? Visit our [website](https://simplestockbot.com).
-"""

discord/Dockerfile

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

discord/bot.py

@@ -1,256 +0,0 @@
-import datetime
-import io
-import logging
-import os
-
-import mplfinance as mpf
-import nextcord
-from D_info import D_info
-from nextcord.ext import commands
-
-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.info(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*10:.4f} seconds") + "\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):
-    # Ignore messages from the bot itself
-    if message.author.id == bot.user.id:
-        return
-
-    content_lower = message.content.lower()
-
-    # Process commands starting with "/"
-    if message.content.startswith("/"):
-        await bot.process_commands(message)
-        return
-
-    symbols = None
-    if "$" in message.content:
-        symbols = s.find_symbols(message.content)
-
-    if "call" in content_lower or "put" in content_lower:
-        await handle_options(message, symbols)
-        return
-
-    if symbols:
-        for reply in s.price_reply(symbols):
-            await message.channel.send(reply)
-        return
-
-
-async def handle_options(message, symbols):
-    logging.info("Options detected")
-    try:
-        options_data = s.options(message.content.lower(), symbols)
-
-        # Create the embed directly within the function
-        embed = nextcord.Embed(title=options_data["Option Symbol"], description=options_data["Underlying"], color=0x3498DB)
-
-        # Key details
-        details = (
-            f"Expiration: {options_data['Expiration']}\n" f"Side: {options_data['side']}\n" f"Strike: {options_data['strike']}"
-        )
-        embed.add_field(name="Details", value=details, inline=False)
-
-        # Pricing info
-        pricing_info = (
-            f"Bid: {options_data['bid']} (Size: {options_data['bidSize']})\n"
-            f"Mid: {options_data['mid']}\n"
-            f"Ask: {options_data['ask']} (Size: {options_data['askSize']})\n"
-            f"Last: {options_data['last']}"
-        )
-        embed.add_field(name="Pricing", value=pricing_info, inline=False)
-
-        # Volume and open interest
-        volume_info = f"Open Interest: {options_data['Open Interest']}\n" f"Volume: {options_data['Volume']}"
-        embed.add_field(name="Activity", value=volume_info, inline=False)
-
-        # Greeks
-        greeks_info = (
-            f"IV: {options_data['Implied Volatility']}\n"
-            f"Delta: {options_data['delta']}\n"
-            f"Gamma: {options_data['gamma']}\n"
-            f"Theta: {options_data['theta']}\n"
-            f"Vega: {options_data['vega']}\n"
-            f"Rho: {options_data['rho']}"
-        )
-        embed.add_field(name="Greeks", value=greeks_info, inline=False)
-
-        # Send the created embed
-        await message.channel.send(embed=embed)
-
-    except KeyError as ex:
-        logging.warning(f"KeyError processing options for message {message.content}: {ex}")
-
-
-bot.run(DISCORD_TOKEN)

discord/discord-reqs.txt

@@ -1,2 +0,0 @@
-nextcord==2.6.0
--r requirements.txt

docker-compose.yaml

@@ -1,13 +0,0 @@
-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

pyproject.toml

@@ -1,11 +0,0 @@
-[tool.black]
-line-length = 130
-
-[tool.flake8]
-max-line-length = 130
-
-[tool.pycodestyle]
-max_line_length = 130
-
-[tool.ruff]
-line-length = 130

site/.gitignore

@@ -1 +0,0 @@
-.cache

site/.gitlab-ci.yml

@@ -1,23 +0,0 @@
-image: python:3.11
-
-build_site:
-  stage: build
-  script:
-    - cd ./site
-    - pip install -r requirements.txt
-    - mkdocs build --site-dir ../public --verbose
-  artifacts:
-    paths:
-      - public
-
-deploy_site:
-  stage: deploy
-  script:
-    - echo "Publishing site..."
-  dependencies:
-    - build_site
-  artifacts:
-    paths:
-      - public
-  rules:
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

site/.vscode/settings.json

@@ -1,12 +0,0 @@
-{
-    "yaml.schemas": {
-        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
-    },
-    "yaml.customTags": [
-        "!ENV scalar",
-        "!ENV sequence",
-        "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
-        "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
-        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
-    ]
-}

site/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 Anson Biggs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

site/docs/LICENSE.md

@@ -1,23 +0,0 @@
-```
-MIT License
-
-Copyright (c) 2019 Anson Biggs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-```

site/docs/blog/.authors.yml

@@ -1,5 +0,0 @@
-authors:
-  Anson:
-    name: Anson Biggs
-    description: Creator
-    avatar: https://gitlab.com/uploads/-/system/user/avatar/1377308/avatar.png

site/docs/blog/index.md

@@ -1,2 +0,0 @@
-# Blog
-

site/docs/blog/posts/intro.md

@@ -1,64 +0,0 @@
----
-title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz"
-date: 2023-10-10
-tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
-authors: [Anson]
-description: >
-    Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord!
----
-
-## What is Simple Stock Bot?
-
-Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            I wonder how $tsla is affecting the price of $$btc
-        </div>
-        <div class="message from">
-        The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
-        </div>
-        <div class="message from">
-        The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
-        </div>
-    </div>
-</div>
-
-With Simple Stock Bot, you can:
-- **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat.
-- **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat.
-- **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres.
-
-## Add the Bot to your Group
-
-[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button }
-
-[:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
-
-
-
-## Using the Bot
-
-Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat!
-
-Here are some simple commands to get you started:
-- `/intra` to view intraday charts.
-- `/chart` for a glimpse of the last month's trading data.
-- `/trending` to catch up on the latest trending stocks and cryptocurrencies.
-
-## Keeping It Free
-
-Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone.
-
-Feeling generous? You can support the project by [donating](https://simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bot).
-
-## Dive Deeper
-
-Craving more insights and features? Explore the [official documentation](https://simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot.
-
-Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again.
-
----
-
-Stay tuned for more updates, tips, and financial insights brought to you by Simple Stock Bot. Here’s to making every financial discussion enriched and informed!

site/docs/commands.md

@@ -1,186 +0,0 @@
-Symbols are used in headings to denote what platforms and symbol types a command supports.
-
-- Telegram Only :fontawesome-brands-telegram:
-- Discord Only :fontawesome-brands-discord:
-- Bot Commands :robot:
-- Cryptocurrency Support :material-currency-btc:
-- Stock Market Support :bank:
-
-## Get the Bots
-
-[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
-
-## Symbol Detection :material-currency-btc: :bank:  
-
-The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            I wonder how $tsla is affecting the price of $$btc
-        </div>
-        <div class="message from">
-        The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
-        </div>
-        <div class="message from">
-        The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
-        </div>
-    </div>
-</div>
-
-## Options Detection :bank:
-
-This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
-
-
-![Image of the telegram bot providing options info.](img/telegram_options.png)
-
-## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane: 
-
-The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /donate
-        </div>
-        <div class="message from">
-            The current stock price of Tesla Inc is $664.315, the stock is
-            currently down -0.99%
-        </div>
-    </div>
-</div>
-
-## `/intra [symbol]` :bank: :material-currency-btc:
-
-This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /intra $astr
-        </div>
-        <div class="message from">
-          <img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
-          <p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
-          <p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
-        </div>
-
-    </div>
-
-</div>
-
-## `/chart [symbol]` :bank: :material-currency-btc:
-
-This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /intra $astr
-        </div>
-        <div class="message from">
-          <img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
-          <p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
-          <p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
-        </div>
-
-    </div>
-
-</div>
-
-## `/trending` 
-
-Gets the latest trending stocks and their change in price
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /trending
-        </div>
-        <pre class="message from">
-
-🦍Trending on the Stock Bot:
-━━━━━━━━━━━━━━━━━━━━━━━━━━
-$GME: Gamestop Corporation - Class A, 5.06%
-$MMAT: Meta Materials Inc, 4.77%
-$$BTC: Bitcoin, -0.83%
-$$ETH: Ethereum, 6.06%
-$$DOGE: Binance-Peg Dogecoin, 0.14%
-
-
-💵Trending Stocks:
-━━━━━━━━━━━━━━━━
-$BBIG: Vinco Ventures Inc, 15.44%
-$GSAT: Globalstar Inc., -15.32%
-$AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
-$ACIU: AC Immune SA, 16.31%
-$PLTR: Palantir Technologies Inc - Class A, 2.25%
-$AAPL: Apple Inc, -0.84%
-$XELA: Exela Technologies Inc, 12.61%
-$WFC: Wells Fargo & Co., -5.60%
-$BAC: Bank Of America Corp., 0.22%
-$AMD: Advanced Micro Devices Inc., -0.54%
-
-
-🦎Trending Crypto:
-━━━━━━━━━━━━━━━━
-$$NFD: Feisty Doge NFT, -34.32%
-$$SLP: Smooth Love Potion, -13.02%
-$$PVU: Plant vs Undead Token, -1.27%
-$$XED: Exeedme, 1.02%
-$$SOL: Solana, -3.95%
-$$BNB: Binance Coin, -0.25%
-$$EWT: Energy Web Token, 17.72%
-
-        </pre>
-    </div>
-
-</div>
-
-## /help :robot:
-
-Just a simple command to get help in app. Returns a more summarized version of this page.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /help
-        </div>
-        <div class="message from">
-            The current stock price of Tesla Inc is $664.315, the stock is
-            currently down -0.99%
-        </div>
-    </div>
-</div>
-
-## `/status` :robot:
-
-This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            /status
-        </div>
-        <pre class="message from">
-Bot Status:
-        It took 0.783369 seconds for the bot to get your message.
-
-        Stock Market Data:
-        marketdata.app is currently not reporting any issues with its API.
-
-        Cryptocurrency Data:
-        CoinGecko API responded that it was OK in 0.160962 Seconds.
-        </pre>
-    </div>
-
-</div>
-
-## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank:  
-
-You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
-full list of stock symbols and return the price of the ticker. Then once you select the ticker
-want the bot will send a message as you in that chat with the latest stock price.
-The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
-`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.

site/docs/contact.md

@@ -1,8 +0,0 @@
-# I Would Love to Hear From You!
-
-Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
-
-- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
-- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
-- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
-- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).

site/docs/donate.md

@@ -1,21 +0,0 @@
-# Support Simple Stock Bot
-
-Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
-
-Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
-
-For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
-
-Should you have any inquiries, feel free to get in [touch](contact.md).
-
-## Additional Support:
-
-Your engagement also counts as support! Here are other ways to contribute:
-
-- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
-- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
-- If you plan to host your own bot, consider using my referral links:
-  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
-  - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-
-Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.

site/docs/host.md

@@ -1,51 +0,0 @@
-# Self-Hosting Guide
-
-This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
-
-## Get the Bots
-
-[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
-
-## Pre-requisites
-
-Ensure the following are installed or obtained before proceeding:
-
-- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
-- **API Keys**:
-  - **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
-  - **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
-  - **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
-
-!!! tip
-    The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
-
-!!! note
-    To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
-
-## Setup Instructions
-
-1. **Download/Clone the Repository**:
-    - Download or clone this repository to your local machine.
-
-2. **Configure Environment Variables**:
-    - Navigate to the project directory and locate the `.env` file.
-    - Fill in the `.env` file with your obtained API keys:
-
-    ```plaintext
-    MARKETDATA=your_marketdata_api_key
-    STRIPE=your_stripe_api_key
-    TELEGRAM=your_telegram_api_key
-    DISCORD=your_discord_api_key
-    ```
-
-    Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
-
-3. **Build and Run the Bot:**
-    - Open a terminal in the project directory.
-    - Build and run both bots using Docker Compose:
-
-    ```bash
-    docker-compose up
-    ```
-
-Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.

site/docs/index.md

@@ -1,35 +0,0 @@
-# Elevate Your Groupchats with Real-time Stock Insights
-
-Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
-
-## Get the Bots
-
-[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
-
-## [Commands](commands.md)
-
-### Real-Time Stock and Cryptocurrency Updates
-- Get live price updates of stocks and cryptocurrencies.
-- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
-
-### Intraday and Historical Data Visualization
-- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
-- `/chart`: Provides a chart of the last month's trading data up till the day before.
-
-### Trending Assets Awareness
-- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
-
-### In-App Assistance and Support
-- `/help`: Provides a quick summary of available commands for easy reference.
-- `/donate`: Support the maintenance of the bot to ensure continued free access.
-
-### User-Friendly Interaction
-- Easy symbol and command usage for a smooth user experience.
-- Engage with a community of financial enthusiasts and share insights effortlessly.
-
-## [Contact](contact.md)
-Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
-
-## Powered by MarketData.app
-
-Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.

site/docs/stylesheets/phone.css

@@ -1,40 +0,0 @@
-/* https://codepen.io/RG/pen/bdfDI */
-.phone {
-  background: none repeat scroll 0 0 #fff;
-  /*border-left: 1px solid #ccc;
-      border-right: 1px solid #ccc;*/
-  color: #ffffff;
-  font-family: sans-serif;
-  line-height: 20px;
-  width: 80%;
-  margin: 0 auto;
-  overflow-x: hidden;
-  position: relative;
-  border-radius: 10px;
-  margin: 50px;
-}
-.messages-wrapper {
-  position: relative;
-}
-.message {
-  margin: 10px;
-  padding: 15px 20px;
-  position: relative;
-  overflow-x: auto;
-}
-.message.to {
-  border-radius: 20px 0px 20px 20px;
-  background-color: #2095fe;
-  color: #fff;
-  margin-left: 20%;
-}
-.message.from {
-  border-radius: 20px 20px 20px 0px;
-  background-color: #e5e4e9;
-  color: #363636;
-  margin-right: 20%;
-}
-.message.to + .message.to,
-.message.from + .message.from {
-  margin-top: -7px;
-}

site/mkdocs.yml

@@ -1,79 +0,0 @@
-site_name: Simple Stock Bot
-site_url: https://simplestockbot.com
-edit_uri: /simple-stock-bots/site/tree/master/site
-repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
-repo_name: Simple Stock Bots
-
-site_description: Simple Discord and Telegram chat bots for Stock Market Data.
-site_author: Anson Biggs
-copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
-
-
-nav:
-  - Home: index.md
-  - Commands: commands.md
-  - Self-Host: host.md
-  - Donate: donate.md
-  - Contact: contact.md
-  - Blog: blog/index.md
-
-theme:
-  name: material
-  language: en
-  features:
-    - navigation.instant
-    - navigation.tracking
-    - navigation.tabs
-    - navigation.tabs.sticky
-    - content.code.copy
-  icon:
-    logo: material/robot-love
-  palette:
-    - media: "(prefers-color-scheme: light)"
-      primary: green
-      scheme: default
-      toggle:
-        icon: material/lightbulb-outline
-        name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
-      primary: green
-      scheme: slate
-      toggle:
-        icon: material/lightbulb
-        name: Switch to light mode
-
-extra:
-  social:
-    - icon: fontawesome/solid/house
-      link: https://simplestockbot.com/
-    - icon: fontawesome/brands/telegram
-      link: https://t.me/SimpleStockBot
-      name: Get the Telegram bot
-    - icon: fontawesome/brands/discord
-      link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
-      name: Get the Discord Bot
-    - icon: material/chart-line-stacked
-      link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
-      name: MarketData.app for stock data
-
-
-
-
-extra_css:
-  - stylesheets/phone.css
-
-
-plugins:
-  - search
-  - social
-  - blog
-
-
-markdown_extensions:
-  - attr_list
-  - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-  - admonition
-  - pymdownx.details
-  - pymdownx.superfences

site/requirements.txt

@@ -1,5 +0,0 @@
-mkdocs-material==9.4.4
-
-# Required for Social Cards
-Pillow==10.0.1
-CairoSVG==2.7.1

telegram/Dockerfile

@@ -1,22 +0,0 @@
-FROM python:3.11-buster AS builder
-
-
-COPY telegram/telegram-reqs.txt .
-COPY common/requirements.txt .
-
-RUN pip install --user -r telegram-reqs.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/T_info.py

@@ -1,70 +0,0 @@
-"""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 = """
-Appreciate this bot? Show support by [buying me a beer](https://www.buymeacoffee.com/Anson) 🍻.
-
-Want stock data or to host your own bot? Help keep this bot free by using my
-[affiliate link](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-
-📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews.
-
-**Guide**: All about using and setting up the bot is in the [docs](https://simplestockbot.com).
-
-The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
-- `/chart $$eth` gets a month's Ethereum chart.
-- `/dividend $psec` shows Prospect Capital's dividend info.
-
-Mention a symbol, and the bot reveals its price.
-E.g., `What's $$btc's price since $tsla accepts it?` gives Bitcoin and Tesla prices.
-
-**Commands**
-- `/donate [USD]`: Support the bot. 🎗️
-- `/intra $[symbol]`: Today's stock activity. 📈
-- `/chart $[symbol]`: Past month's stock chart. 📊
-- `/trending`: What's hot in stocks and cryptos. 💬
-- `/help`: Bot assistance. 🆘
-
-**Inline Features**
-Search with @SimpleStockBot `[query]` anywhere.
-Pick a ticker, and the bot shares the current price in chat. Note: Prices can lag by an hour.
-
-Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-
-Bot issues? Use `/status` or [contact us](https://simplestockbot.com/contact).
-
-    """
-
-    donate_text = """
-Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
-All funds help maintain servers, with data from
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-
-**How to Donate?**
-1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
-2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
-
-For questions, visit our [website](https://simplestockbot.com).
-"""
-
-
-# Not used by the bot but for updating commands with BotFather
-commands = """
-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. 📊
-"""

telegram/bot.py

@@ -1,514 +0,0 @@
-# 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 (
-    Application,
-    CommandHandler,
-    InlineQueryHandler,
-    PreCheckoutQueryHandler,
-    MessageHandler,
-    filters,
-    ContextTypes,
-)
-
-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)
-
-# set higher logging level for httpx to avoid all GET and POST requests being logged
-logging.getLogger("httpx").setLevel(logging.WARNING)
-
-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.")
-
-
-async def start(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send help text when the command /start is issued."""
-    log.info(f"Start command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.help_text,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def help(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send help text when the command /help is issued."""
-    log.info(f"Help command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.help_text,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def license(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send bots license when the /license command is issued."""
-    log.info(f"License command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.license,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def status(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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.")
-
-    await update.message.reply_text(
-        text=bot_status,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-    )
-
-
-async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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:
-        await update.message.reply_text(
-            text=t.donate_text,
-            parse_mode=telegram.constants.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:
-        await 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}")
-
-    await 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,
-    )
-
-
-async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Approves donation"""
-    log.info("precheckout_callback queried")
-    query = update.pre_checkout_query
-
-    await 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
-    #     await query.answer(ok=True)
-    # else:
-    #     await query.answer(ok=False, error_message="Something went wrong...")
-
-
-async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Thanks user for donation"""
-    log.info("Successful payment!")
-    await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
-
-
-async def symbol_detect_image(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """
-    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
-            await symbol_detect(update, context)
-    except AttributeError:
-        return
-
-
-async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """
-    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:
-            log.info("Looking for Symbols")
-            symbols = s.find_symbols(message)
-        else:
-            return
-    except AttributeError as ex:
-        log.info(ex)
-        return
-
-    # Detect Options
-    if ("call" in message.lower()) or ("put" in message.lower()):
-        log.info("Options detected")
-        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-        try:
-            options_data = s.options(message, symbols)
-
-            await update.message.reply_text(
-                text=generate_options_reply(options_data),
-                parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            )
-            return
-        except KeyError as ex:
-            logging.warning(ex)
-            pass
-
-    if symbols:
-        log.info(f"Symbols found: {symbols}")
-        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-
-        for reply in s.price_reply(symbols):
-            await update.message.reply_text(
-                text=reply,
-                parse_mode=telegram.constants.ParseMode.MARKDOWN,
-                disable_notification=True,
-            )
-
-
-def generate_options_reply(options_data: dict):
-    # Header with Option Symbol and Underlying
-    message_text = f"*{options_data['Option Symbol']} ({options_data['Underlying']})*\n\n"
-
-    # Key details
-    details = (
-        f"*Expiration:* `{options_data['Expiration']}`\n"
-        f"*Side:* `{options_data['side']}`\n"
-        f"*Strike:* `{options_data['strike']}`\n"
-        f"*First Traded:* `{options_data['First Traded']}`\n"
-        f"*Last Updated:* `{options_data['Last Updated']}`\n\n"
-    )
-    message_text += details
-
-    # Pricing info
-    pricing_info = (
-        f"*Bid:* `{options_data['bid']}` (Size: `{options_data['bidSize']}`)\n"
-        f"*Mid:* `{options_data['mid']}`\n"
-        f"*Ask:* `{options_data['ask']}` (Size: `{options_data['askSize']}`)\n"
-        f"*Last:* `{options_data['last']}`\n\n"
-    )
-    message_text += pricing_info
-
-    # Volume and open interest
-    volume_info = f"*Open Interest:* `{options_data['Open Interest']}`\n" f"*Volume:* `{options_data['Volume']}`\n\n"
-    message_text += volume_info
-
-    # Greeks
-    greeks_info = (
-        f"*IV:* `{options_data['Implied Volatility']}`\n"
-        f"*Delta:* `{options_data['delta']}`\n"
-        f"*Gamma:* `{options_data['gamma']}`\n"
-        f"*Theta:* `{options_data['theta']}`\n"
-        f"*Vega:* `{options_data['vega']}`\n"
-        f"*Rho:* `{options_data['rho']}`\n"
-    )
-    message_text += greeks_info
-
-    return message_text
-
-
-async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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":
-        await 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:
-        await update.message.reply_text("No symbols or coins found.")
-        return
-
-    df = s.intra_reply(symbol)
-    if df.empty:
-        await update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            disable_notification=True,
-        )
-        return
-
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.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)
-
-    await 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.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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":
-        await 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:
-        await update.message.reply_text("No symbols or coins found.")
-        return
-
-    df = s.chart_reply(symbol)
-    if df.empty:
-        await update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            disable_notification=True,
-        )
-        return
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.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)
-
-    await 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.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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
-
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-
-    trending_list = s.trending()
-
-    await update.message.reply_text(
-        text=trending_list,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
-    """
-    Handles inline query. Searches by looking if query is contained
-        in the symbol and returns matches in alphabetical order.
-    """
-
-    if not update.inline_query.query:
-        return
-
-    print(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.
-        """
-
-        await 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.constants.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.constants.ParseMode.MARKDOWN
-                ),
-            )
-        )
-
-        if len(results) == 5:
-            await update.inline_query.answer(results, cache_time=60 * 60)
-            log.info("Inline Command was successful")
-            return
-    await update.inline_query.answer(results)
-
-
-async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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}")
-
-    await update.message.reply_text(
-        text=s.random_pick(),
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """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)}"
-        )
-
-        await update.message.reply_text(
-            text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
-            parse_mode=telegram.constants.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.
-    application = Application.builder().token(TELEGRAM_TOKEN).build()
-
-    # on different commands - answer in Telegram
-    application.add_handler(CommandHandler("start", start))
-    application.add_handler(CommandHandler("help", help))
-    application.add_handler(CommandHandler("license", license))
-    application.add_handler(CommandHandler("trending", trending))
-    application.add_handler(CommandHandler("random", rand_pick))
-    application.add_handler(CommandHandler("donate", donate))
-    application.add_handler(CommandHandler("status", status))
-    application.add_handler(CommandHandler("inline", inline_query))
-
-    # Charting can be slow so they run async.
-    application.add_handler(CommandHandler("intra", intra, block=False))
-    application.add_handler(CommandHandler("intraday", intra, block=False))
-    application.add_handler(CommandHandler("day", intra, block=False))
-    application.add_handler(CommandHandler("chart", chart, block=False))
-    application.add_handler(CommandHandler("month", chart, block=False))
-
-    # on noncommand i.e message - echo the message on Telegram
-    application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
-    application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
-
-    # Inline Bot commands
-    application.add_handler(InlineQueryHandler(inline_query))
-
-    # Pre-checkout handler to final check
-    application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
-
-    # Payment success
-    application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
-
-    # log all errors
-    application.add_error_handler(error)
-
-    # Start the Bot
-    application.run_polling(allowed_updates=Update.ALL_TYPES)
-
-
-if __name__ == "__main__":
-    main()

telegram/telegram-reqs.txt

@@ -1,2 +0,0 @@
-python-telegram-bot==20.6
--r requirements.txt

tests.py

@@ -1,23 +0,0 @@
-import time
-
-import keyboard
-
-tests = """$$xno
-$tsla
-/intra $tsla
-/intra $$btc
-/chart $tsla
-/chart $$btc
-/help
-/trending""".split(
-    "\n"
-)
-
-print("press enter to start")
-keyboard.wait("enter")
-
-for test in tests:
-    print(test)
-    keyboard.write(test)
-    time.sleep(1)
-    keyboard.press_and_release("enter")

web/docs/LICENSE.md

@@ -0,0 +1,179 @@
+# License
+
+## Stock Market Data
+
+Provided for free by [IEX](https://iextrading.com/developer). View IEX’s [Terms of Use](https://iextrading.com/api-exhibit-a/).
+
+**This Website and the Associated Bot are Provided under the Following License**
+ 
+## Attribution-ShareAlike 4.0 International
+
+Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
+
+### Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
+
+* __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors).
+
+* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees).
+
+## Creative Commons Attribution-ShareAlike 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+### Section 1 – Definitions.
+
+a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+
+b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+
+c. __BY-SA Compatible License__ means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License.
+
+d. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+
+e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+
+f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+
+g. __License Elements__ means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
+
+h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+
+i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+
+j. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License.
+
+k. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+
+l. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+
+m. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+### Section 2 – Scope.
+
+a. ___License grant.___
+
+   1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+
+       A. reproduce and Share the Licensed Material, in whole or in part; and
+
+       B. produce, reproduce, and Share Adapted Material.
+
+   2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+
+   3. __Term.__ The term of this Public License is specified in Section 6(a).
+
+   4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+
+   5. __Downstream recipients.__
+
+       A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+
+       B. __Additional offer from the Licensor – Adapted Material.__ Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
+
+       C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+
+   6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+b. ___Other rights.___
+
+   1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+
+   2. Patent and trademark rights are not licensed under this Public License.
+
+   3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+### Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+a. ___Attribution.___
+
+   1. If You Share the Licensed Material (including in modified form), You must:
+
+       A. retain the following if it is supplied by the Licensor with the Licensed Material:
+
+         i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+
+         ii. a copyright notice;
+
+         iii. a notice that refers to this Public License;
+
+         iv. a notice that refers to the disclaimer of warranties;
+
+         v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+
+       B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+
+       C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+
+   2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+
+   3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+
+b. ___ShareAlike.___
+
+In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
+
+1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
+
+2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
+
+3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
+
+### Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+
+b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
+
+c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+### Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__
+
+b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__
+
+c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+### Section 6 – Term and Termination.
+
+a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+
+   1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+
+   2. upon express reinstatement by the Licensor.
+
+   For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+
+c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+
+d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+### Section 7 – Other Terms and Conditions.
+
+a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+
+b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+### Section 8 – Interpretation.
+
+a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+
+b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+
+c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+
+d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
+
+> Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” The text of the Creative Commons public licenses is dedicated to the public domain under the [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode). Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
+>
+> Creative Commons may be contacted at creativecommons.org.

web/docs/about.md

@@ -0,0 +1 @@
+# Under Construction 🚧

web/docs/commands.md

@@ -0,0 +1,44 @@
+# Telegram Bot Commands
+
+## Getting a Stock Quote
+
+Anytime the Bot is in your chat it will search all chats for `$` followed by a ticker. For example `$tsla` will return the following message for Tesla Motors:
+
+```
+The current stock price of Tesla Inc. is $321.35, the stock is currently up 2.7%
+```
+
+This works no matter where the ticker is in the message and you can have as many tickers as you want in the same message. For example:
+
+```
+I wonder how $aapl, $nflx, and $sono are performing today.
+```
+
+Will return:
+
+![Conversation With Simple Telegram Bot](img\telegramBotTickerReply.png)
+
+## Commands
+
+* [`/help`](#/help) - Create a new project.
+* [`/news`](#/news) - Start the live-reloading docs server.
+
+### /help
+
+This command just displays a short description of what the bot does and a link to this page.
+
+### /news
+
+This command is intelligent enough to get any tickers in the ticker format: `$amzn`, and can handle as many tickers as you would like to enter. The bot will then return the price of the ticker, and links various websites that provide news about the ticker. Currently for Apple stock the Bot would return:
+
+
+`The current stock price of Apple Inc. is **$174.18**, the stock is currently up **1.71%**`  
+[`Bravos`](https://bravos.co/AAPL)  
+[`Seeking Alpha`](https://seekingalpha.com/symbol/AAPL)  
+[`MSN Money`](https://www.msn.com/en-us/money/stockdetails?symbol=AAPL)  
+[`Yahoo Finance`](https://finance.yahoo.com/quote/AAPL)  
+[`Wall Street Journal`](https://quotes.wsj.com/AAPL)  
+[`The Street`](https://www.thestreet.com/quote/AAPL.html)  
+[`Zacks`](https://www.zacks.com/stock/quote/AAPL)  
+
+*This command needs updating, feel free to [open an issue](https://gitlab.com/MisterBiggs/simple-telegram-bot/issues) with suggestions.*

web/docs/index.md

@@ -0,0 +1,82 @@
+# Telegram Bot Commands
+
+## About
+
+If you aren't already, you can talk to this bot here: **[http://t.me/SimpleStockBot](http://t.me/SimpleStockBot)**
+
+Simple Stock Bot is a bot for [Telegram](https://telegram.org/) that provides information about the stock market. You can view the source code [here.](https://gitlab.com/MisterBiggs/simple-telegram-bot). You can also build your own docker container to run [here.](#Build)
+
+_Coded with ❤ by [@MisterBiggs](https://gitlab.com/MisterBiggs)_
+
+## Getting a Stock Quote
+
+Anytime the Bot is in your chat it will search all chats for `$` followed by a ticker. For example `$tsla` will return the following message for Tesla Motors:
+
+```
+The current stock price of Tesla Inc. is $321.35, the stock is currently up 2.7%
+```
+
+This works no matter where the ticker is in the message and you can have as many tickers as you want in the same message. For example:
+
+```
+I wonder how $aapl, $nflx, and $sono are performing today.
+```
+
+Will return:
+
+![Conversation With Simple Telegram Bot](img\telegramBotTickerReply.png)
+
+As long as the bot is in your chat it will reply to any stock tickers in your messages.
+
+## Commands
+
+- [`/help`](#/help)
+- [`/news`](#/news)
+- [`/dividend`](#/dividend)
+
+### /help
+
+This command just displays a short description of what the bot does and a link to this page.
+
+### /news
+
+This command is intelligent enough to get any tickers in the ticker format: `$amzn`, and can handle as many tickers as you would like to enter. The bot will then return the price of the ticker, and links various websites that provide news about the ticker. Currently the command `/news $aapl` returns:
+
+---
+
+`The current stock price of Apple Inc. is $**170.89**, the stock is currently **up 0.86%**`
+
+[`Apple: The 4 Biggest Risks`](https://api.iextrading.com/1.0/stock/aapl/article/7171544094325661)
+
+[`Apple is getting so serious about health, it's started hosting heart-health events at Apple Stores`](https://api.iextrading.com/1.0/stock/aapl/article/6966979968162641)
+
+[`You can now ask Siri to get you directions with Waze so you don't even have to open the app`](https://api.iextrading.com/1.0/stock/aapl/article/7672481171984085)
+
+---
+
+### /dividend
+
+The dividend command will give you the `dividend yield`, `dividend rate`, and will tell you how long until the payout date for any tickers input. Currently the command `/dividend $psec` returns:
+
+---
+
+`Prospect Capital Corporation current dividend yield is: 0.720%, or $11.285 per share.`
+
+`The dividend is in: 14 Days 1 Hours 54 Minutes 46 Seconds.`
+
+---
+
+## Run your own bot using latest build
+
+```powershell
+docker run --detach registry.gitlab.com/misterbiggs/simple-telegram-bot:latest
+```
+
+## Built and Run your own Bot
+
+You can also run your own bot super easily in a [Docker](https://hub.docker.com/) Container.
+
+1. Download the repository.
+2. Change information in [Credentials.py]() with your own Telegram Bot key, which can be found [here.]()
+3. Run stockBot.py
+4. profit???

web/mkdocs.yml

@@ -0,0 +1,14 @@
+site_name: Simple Stock Bot
+site_url: https://misterbiggs.gitlab.io/simple-telegram-bot
+edit_uri: blob/master/web/docs/
+nav:
+  - Home: index.md
+  # - Commands: commands.md
+  # - About: about.md
+  # - Author's Website: https://blog.ansonbiggs.com/
+  - LICENSE: LICENSE.md
+theme: "material"
+
+repo_url: https://gitlab.com/MisterBiggs/simple-telegram-bot
+repo_name: Simple Telegram Bot
+site_description: A Telegram Bot for stock market Data.