Merge branch 'phase-1-revival' into 'master'

Phase 1 Revival: Update dependencies, fix bugs, add tests

See merge request simple-stock-bots/simple-stock-bot!67

.devcontainer/Dockerfile

@@ -1,20 +1,3 @@
-FROM python:3.11-buster AS builder
-
-
-COPY requirements.txt /requirements.txt
-RUN pip install --user -r requirements.txt
-
-
-FROM python:3.11-slim
-
-ENV MPLBACKEND=Agg
-
-COPY --from=builder /root/.local /root/.local
-
-RUN pip install --no-cache-dir black
-ENV TELEGRAM=TOKEN
-ENV IEX=TOKEN
+FROM python:3.11
 
 COPY . .
-
-# CMD [ "python", "./bot.py" ]

.devcontainer/devcontainer.json

@@ -1,26 +1,41 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/docker-existing-dockerfile
+// 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": "DockerDev",
-	// Sets the run context to one level up instead of the .devcontainer folder.
-	"context": "..",
-	// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
-	"dockerFile": "Dockerfile",
-	// Set *default* container specific settings.json values on container create.
-	"settings": {},
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"ms-python.python",
-		"ms-azuretools.vscode-docker"
-	]
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-	// Uncomment the next line to run commands after the container is created - for example installing curl.
-	// "postCreateCommand": "apt-get update && apt-get install -y curl",
-	// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
-	// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
-	// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
-	// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
-	// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-	// "remoteUser": "vscode"
+  "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",
+    "context": ".."
+  },
+  "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",
+        "esbenp.prettier-vscode"
+      ]
+    }
+  },
+  "postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm --fix-missing && npm install"
+  // 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"
 }

.env.example

@@ -0,0 +1,17 @@
+# Required Environment Variables for Simple Stock Bot
+
+# Telegram Bot Token (required for Telegram functionality)
+# Get this from @BotFather on Telegram
+TELEGRAM=your_telegram_bot_token_here
+
+# Discord Bot Token (required for Discord functionality)
+# Get this from Discord Developer Portal
+DISCORD=your_discord_bot_token_here
+
+# MarketData.app API Token (required for stock market data)
+# Get this from https://www.marketdata.app/
+MARKETDATA=your_marketdata_api_token_here
+
+# Stripe Token (optional - for accepting donations)
+# Get this from Stripe Dashboard
+STRIPE=your_stripe_token_here

.gitignore

@@ -1 +1,3 @@
 __pycache__
+.env
+node_modules

.gitlab-ci.yml

@@ -1,34 +1,23 @@
-black:
-  stage: .pre
-  image: registry.gitlab.com/pipeline-components/black:latest
+stages:
+  - lint
+  - build_site
+  - deploy
+
+ruff:
+  stage: lint
+  image: python:3.12-slim
   script:
-    - black --check --verbose -- .
+    - pip3 install ruff==0.15.2
+    - ruff check . --output-format gitlab
+    - ruff format . --check
+  allow_failure: false
 
+# prettier:
+#   stage: lint
+#   image: node:16-slim # Use Node.js image since prettier is a Node.js tool
+#   script:
+#     - npm install prettier
+#     - npx prettier --check . # Adjust the path as needed
 
-build:master:
-  stage: build
-  image:
-    name: gcr.io/kaniko-project/executor:v1.9.0-debug
-    entrypoint: [""]
-  script:
-    - /kaniko/executor
-      --context "${CI_PROJECT_DIR}"
-      --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
-      --destination "${CI_REGISTRY_IMAGE}:latest"
-  rules:
-    - if: '$CI_COMMIT_BRANCH == "master"'
-
-
-build:branch:
-  stage: build
-  image:
-    name: gcr.io/kaniko-project/executor:v1.9.0-debug
-    entrypoint: [""]
-  script:
-    - /kaniko/executor
-      --context "${CI_PROJECT_DIR}"
-      --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
-      --destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_SHORT_SHA}"
-      --destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_BRANCH}"
-  rules:
-    - if: '$CI_COMMIT_BRANCH != "master"'
+include:
+  - local: /site/.gitlab-ci.yml

.vscode/launch.json

@@ -1,12 +0,0 @@
-{
-    "configurations": [
-        {
-            "name": "Telegram Bot",
-            "type": "python",
-            "request": "launch",
-            "program": "bot.py",
-            "console": "integratedTerminal",
-            "python": "python3.11"
-        }
-    ]
-}

.vscode/settings.json

@@ -1,5 +1,10 @@
 {
-    "python.formatting.provider": "black",
-    "python.linting.mypyEnabled": true,
-    "python.linting.flake8Enabled": true,
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "editor.formatOnSaveMode": "modificationsIfAvailable",
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "file"
+  }
 }

Dockerfile

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

MarketData.py

@@ -1,212 +0,0 @@
-"""Class with functions for running the bot with IEX Cloud.
-"""
-
-import logging
-import os
-import datetime as dt
-from logging import warning
-from typing import Dict
-
-import pandas as pd
-import requests as r
-import schedule
-
-from Symbol import Stock
-
-
-class MarketData:
-    """
-    Functions for finding stock market information about symbols from MarkData.app
-    """
-
-    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
-
-    charts: Dict[Stock, pd.DataFrame] = {}
-
-    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 = ""
-            warning("Starting without an MarketData.app Token will not allow you to get market data!")
-
-        if self.MARKETDATA_TOKEN != "":
-            schedule.every().day.do(self.clear_charts)
-
-    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"] = params.get("token", self.MARKETDATA_TOKEN)
-
-        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 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:
-        return "status isnt implemented by marketdata.app"
-
-    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}/"):
-            return f"The current price of {quoteResp['symbol']} is ${quoteResp['last']}"
-
-        else:
-            return f"Getting a quote for {symbol} encountered an error."
-
-    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 = "5"  # minutes
-
-        if data := self.get(
-            f"stocks/candles/{resolution}/{symbol}",
-            params={
-                "from": dt.datetime.now().strftime("%Y-%m-%d"),
-                "to": dt.datetime.now().isoformat(),
-            },
-        ):
-            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 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()

README.md

@@ -1,32 +1,48 @@
-# Simple Telegram Stock Bot
+# Simple Stock Bots
 
-
-[![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot)
+[![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)
-[![Author](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
+[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
 
-## Docs
+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.
 
-https://docs.simplestockbot.com/
+## Documentation
 
-## Usage
+Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
 
-https://docs.simplestockbot.com/commands/
+- [Official Documentation](https://simplestockbot.com/)
+- [Command Reference](https://simplestockbot.com/commands/)
 
-## Donate
+## Support the Project
 
-Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [IEX Cloud](https://iexcloud.io/).
+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).
 
-The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
+You can contribute by:
 
-Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
+- 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.
 
-If you have any questions get in [touch.](contact.md)
+### Additional Support:
 
-## Other Ways to Help:
-
-- Follow me on [twitter](https://twitter.com/AnsonBiggs)
-- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
-- Using my referral links to host your own Bot
+- Follow on [Twitter](https://twitter.com/AnsonBiggs)
+- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot)
+- Utilize referral links for self-hosting:
   - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-  - [IEX Cloud](https://iexcloud.io/s/62c8503e)
+  - [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.

T_info.py

@@ -1,73 +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 = """
-Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
-
-Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews
-
-Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
-
-The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
-
-Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla. 
-
-**Commands**
-        - `/donate [amount in USD]` to donate. 🎗️
-        - `/dividend $[symbol]` Dividend information for the symbol. 📅
-        - `/intra $[symbol]` Plot of the stocks movement since the last market open.  📈
-        - `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
-        - `/news $[symbol]` News about the symbol. 📰
-        - `/info $[symbol]` General information about the symbol. ℹ️
-        - `/stat $[symbol]` Key statistics about the symbol. 🔢
-        - `/cap $[symbol]` Market Capitalization of symbol. 💰
-        - `/trending` Trending Stocks and Cryptos. 💬
-        - `/help` Get some help using the bot. 🆘
-
-**Inline Features**
-    You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
-    
-    Market data is provided by [IEX Cloud](https://iexcloud.io)
-
-    If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
-    """
-
-    donate_text = """
-Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
-All donations go directly towards paying for servers, and market data is provided by
-[IEX Cloud](https://iexcloud.io/).
-
-The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
-
-Example: `/donate 2` would donate 2 USD.
-
-An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
-If you have any questions see the [website](https:docs.simplestockbot.com)
-
-    """
-
-
-commands = """
-donate - Donate to the bot 🎗️
-help - Get some help using the bot. 🆘
-info - $[symbol] General information about the symbol. ℹ️
-news - $[symbol] News about the symbol. 📰
-stat - $[symbol] Key statistics about the symbol. 🔢
-cap - $[symbol] Market Capitalization of symbol. 💰
-dividend - $[symbol] Dividend info 📅
-trending - Trending Stocks and Cryptos. 💬
-intra - $[symbol] Plot since the last market open. 📈
-chart - $[chart] Plot of the past month. 📊
-"""  # Not used by the bot but for updaing commands with BotFather

common/MarketData.py

@@ -0,0 +1,361 @@
+import datetime as dt
+import logging
+import os
+from collections import OrderedDict
+from typing import Dict
+
+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=None, timeout=10, headers=None) -> dict:
+        url = "https://api.marketdata.app/v1/" + endpoint
+
+        if params is None:
+            params = {}
+
+        # 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"
+
+        if headers is None:
+            headers = {}
+        headers = {"User-Agent": "Simple Stock Bot anson@ansonbiggs.com"} | headers
+
+        resp = r.get(url, params=params, timeout=timeout, headers=headers)
+
+        logging.debug(resp.headers.items())
+
+        # 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):
+        # Doesn't use `self.get()` since needs are much different
+        sec_resp = r.get(
+            "https://www.sec.gov/files/company_tickers.json",
+            headers={
+                "User-Agent": "Simple Stock Bot anson@ansonbiggs.com",
+                "Accept-Encoding": "gzip, deflate",
+                "Host": "www.sec.gov",
+            },
+        )
+        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:
+        """Check MarketData.app API status by making a test request."""
+        try:
+            # Test the API with a simple request
+            status = r.get(
+                "https://api.marketdata.app/v1/stocks/quotes/AAPL/",
+                timeout=5,
+            )
+            status.raise_for_status()
+            return f"MarketData.app API is responding OK with status {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
+        except r.HTTPError:
+            return f"MarketData.app API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
+        except r.Timeout:
+            return "MarketData.app API timed out before it could respond. This is likely due to a surge in usage or a complete outage."
+        except Exception as e:
+            return f"MarketData.app API check failed: {str(e)}"
+
+    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,6 +1,7 @@
-import pandas as pd
 import logging
 
+import pandas as pd
+
 
 class Symbol:
     """
@@ -25,15 +26,19 @@ class Symbol:
     def __str__(self) -> str:
         return self.id
 
+    def __hash__(self):
+        return hash(self.id)
+
 
 class Stock(Symbol):
     """Stock Market Object. Gets data from MarketData"""
 
-    def __init__(self, symbol: str) -> None:
-        self.symbol = symbol
-        self.id = symbol
-        self.name = "$" + symbol
-        self.tag = "$" + symbol.upper()
+    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):

common/cg_Crypto.py

@@ -1,15 +1,16 @@
-"""Class with functions for running the bot with IEX Cloud.
-"""
-
-import logging as log
+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
+from common.utilities import rate_limited
 
-from Symbol import Coin
+import time
+
+log = logging.getLogger(__name__)
 
 
 class cg_Crypto:
@@ -22,20 +23,33 @@ class cg_Crypto:
     trending_cache: List[str] = []
 
     def __init__(self) -> None:
-        """Creates a Symbol Object
-
-        Parameters
-        ----------
-        IEX_TOKEN : str
-            IEX Token
-        """
         self.get_symbol_list()
         schedule.every().day.do(self.get_symbol_list)
 
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+    # Coingecko's rate limit is 30 requests per minute.
+    # Since there are two bots sharing the same IP, we allocate half of that limit to each bot.
+    # This results in a rate limit of 15 requests per minute for each bot.
+    # Given this, the rate limit effectively becomes 1 request every 4 seconds for each bot.
+    @rate_limited(0.25)
+    def get(self, endpoint, params: dict = {}, timeout=10, retry_count=0, max_retries=3) -> 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
+
+        if resp.status_code == 429:
+            if retry_count >= max_retries:
+                log.error(f"CoinGecko 429 retry limit ({max_retries}) exceeded for endpoint: {endpoint}")
+                return {}
+
+            backoff_time = (2**retry_count) * 10  # Exponential backoff: 10s, 20s, 40s
+            log.warning(
+                f"CoinGecko returned 429 - Too Many Requests for endpoint: {endpoint}. Retry {retry_count + 1}/{max_retries} after {backoff_time}s."
+            )
+            time.sleep(backoff_time)
+            return self.get(
+                endpoint=endpoint, params=params, timeout=timeout, retry_count=retry_count + 1, max_retries=max_retries
+            )
+
         try:
             resp.raise_for_status()
         except r.exceptions.HTTPError as e:
@@ -85,10 +99,10 @@ class cg_Crypto:
         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."
+                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."
+            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.
@@ -209,14 +223,14 @@ class cg_Crypto:
             },
         ):
             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")}
+                [{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')}
+                    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."
@@ -256,7 +270,7 @@ class cg_Crypto:
 
             message = (
                 f"The current price of {coin.name} is $**{price:,}** and"
-                + " its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
+                + f" its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
             )
 
         else:
@@ -369,7 +383,7 @@ class cg_Crypto:
                     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."
+                    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

@@ -0,0 +1,8 @@
+cachetools==7.0.1
+humanize==4.15.0
+markdownify==1.2.2
+mplfinance==0.12.10a7
+pandas==3.0.1
+requests==2.32.5
+rush==2021.4.0
+schedule==1.2.2

common/symbol_router.py

@@ -1,25 +1,26 @@
-"""Function that routes symbols to the correct API provider.
-"""
+"""Function that routes symbols to the correct API provider."""
 
 import datetime
 import logging
 import random
 import re
-from logging import critical, debug, error, info, warning
+from typing import Dict
 
 import pandas as pd
 import schedule
 from cachetools import TTLCache, cached
 
-from cg_Crypto import cg_Crypto
-from MarketData import MarketData
-from Symbol import Coin, Stock, Symbol
+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 = {}
+    trending_count: Dict[str, float] = {}
 
     def __init__(self):
         self.stock = MarketData()
@@ -35,7 +36,7 @@ class Router:
             t_copy = self.trending_count.copy()
             for key in t_copy.keys():
                 if t_copy[key] < 0.01:
-                    # This just makes sure were not keeping around keys that havent been called in a very long time.
+                    # Prune Keys
                     dead_keys.append(key)
                 else:
                     t_copy[key] = t_copy[key] * decay
@@ -43,9 +44,9 @@ class Router:
             t_copy.pop(dead)
 
         self.trending_count = t_copy.copy()
-        info("Decayed trending symbols.")
+        log.info("Decayed trending symbols.")
 
-    def find_symbols(self, text: str, *, trending_weight: int = 1) -> list[Symbol]:
+    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.
 
@@ -61,25 +62,29 @@ class Router:
         """
         schedule.run_pending()
 
-        symbols = []
-        stocks = set(re.findall(self.STOCK_REGEX, text))
-        for stock in stocks:
-            # Market data lacks tools to check if a symbol is valid.
-            symbols.append(Stock(stock))
+        symbols: list[Symbol] = []
+        stock_matches = set(re.findall(self.STOCK_REGEX, text))
+        coin_matches = set(re.findall(self.CRYPTO_REGEX, text))
 
-        coins = set(re.findall(self.CRYPTO_REGEX, text))
-        for coin in coins:
-            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin.lower(), case=False)]
-            if ~sym.empty:
-                symbols.append(Coin(sym))
+        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:
-                info(f"{coin} is not in list of coins")
+                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:
-            info(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
+        return symbols
 
     def status(self, bot_resp) -> str:
         """Checks for any issues with APIs.
@@ -101,7 +106,7 @@ class Router:
         {self.crypto.status()}
         """
 
-        warning(stats)
+        log.warning(stats)
 
         return stats
 
@@ -120,7 +125,8 @@ class Router:
             Each tuple contains: (Symbol, Issue Name).
         """
 
-        df = pd.concat([self.stock.symbol_list, self.crypto.symbol_list])
+        # 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()
@@ -150,13 +156,13 @@ class Router:
         replies = []
 
         for symbol in symbols:
-            info(symbol)
+            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:
-                info(f"{symbol} is not a Stock or Coin")
+                log.info(f"{symbol} is not a Stock or Coin")
 
         return replies
 
@@ -182,7 +188,7 @@ class Router:
             elif isinstance(symbol, Coin):
                 replies.append(self.crypto.info_reply(symbol))
             else:
-                debug(f"{symbol} is not a Stock or Coin")
+                log.debug(f"{symbol} is not a Stock or Coin")
 
         return replies
 
@@ -206,7 +212,7 @@ class Router:
         elif isinstance(symbol, Coin):
             return self.crypto.intra_reply(symbol)
         else:
-            debug(f"{symbol} is not a Stock or Coin")
+            log.debug(f"{symbol} is not a Stock or Coin")
             return pd.DataFrame()
 
     def chart_reply(self, symbol: Symbol) -> pd.DataFrame:
@@ -229,7 +235,7 @@ class Router:
         elif isinstance(symbol, Coin):
             return self.crypto.chart_reply(symbol)
         else:
-            debug(f"{symbol} is not a Stock or Coin")
+            log.debug(f"{symbol} is not a Stock or Coin")
             return pd.DataFrame()
 
     def stat_reply(self, symbols: list[Symbol]) -> list[str]:
@@ -254,7 +260,7 @@ class Router:
             elif isinstance(symbol, Coin):
                 replies.append(self.crypto.stat_reply(symbol))
             else:
-                debug(f"{symbol} is not a Stock or Coin")
+                log.debug(f"{symbol} is not a Stock or Coin")
 
         return replies
 
@@ -280,7 +286,7 @@ class Router:
             elif isinstance(symbol, Coin):
                 replies.append(self.crypto.cap_reply(symbol))
             else:
-                debug(f"{symbol} is not a Stock or Coin")
+                log.debug(f"{symbol} is not a Stock or Coin")
 
         return replies
 
@@ -301,12 +307,11 @@ class Router:
 
         for symbol in symbols:
             if isinstance(symbol, Stock):
-                replies.append("Command not supported for stocks.")
-                # replies.append(self.stock.spark_reply(symbol))
+                replies.append(self.stock.spark_reply(symbol))
             elif isinstance(symbol, Coin):
                 replies.append(self.crypto.spark_reply(symbol))
             else:
-                debug(f"{symbol} is not a Stock or Coin")
+                log.debug(f"{symbol} is not a Stock or Coin")
 
         return replies
 
@@ -320,29 +325,24 @@ class Router:
             List of preformatted strings to be sent to user.
         """
 
-        stocks = self.stock.trending()
+        # 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 stocks:
-            reply += "\n\n💵Trending Stocks:\n`"
-            reply += "━" * len("Trending Stocks:") + "`\n"
-            for stock in stocks:
-                reply += stock + "\n"
-
         if coins:
-            reply += "\n\n🦎Trending Crypto:\n`"
-            reply += "━" * len("Trending Crypto:") + "`\n"
+            reply += "\n\n🦎Trending on CoinGecko:\n`"
+            reply += "━" * len("Trending on CoinGecko:") + "`\n"
             for coin in coins:
                 reply += coin + "\n"
 
@@ -352,11 +352,12 @@ class Router:
         if reply:
             return reply
         else:
-            warning("Failed to collect trending data.")
+            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.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}"
@@ -385,13 +386,21 @@ class Router:
             elif isinstance(symbol, Coin):
                 coins.append(symbol)
             else:
-                debug(f"{symbol} is not a Stock or Coin")
+                log.debug(f"{symbol} is not a Stock or Coin")
 
         if stocks:
-            # IEX batch endpoint doesnt seem to be working right now
             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)

common/utilities.py

@@ -0,0 +1,31 @@
+import time
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def rate_limited(max_per_second):
+    """
+    Decorator that ensures the wrapped function is called at most `max_per_second` times per second.
+    """
+    min_interval = 1.0 / max_per_second
+
+    def decorate(func):
+        last_called = [0.0]
+
+        def rate_limited_function(*args, **kwargs):
+            elapsed = time.time() - last_called[0]
+            left_to_wait = min_interval - elapsed
+
+            if left_to_wait > 0:
+                log.info(f"Rate limit exceeded. Waiting for {left_to_wait:.2f} seconds.")
+                time.sleep(left_to_wait)
+
+            ret = func(*args, **kwargs)
+            last_called[0] = time.time()
+
+            return ret
+
+        return rate_limited_function
+
+    return decorate

dev-reqs.txt

@@ -1,6 +1,12 @@
--r requirements.txt
-black==23.3.0
-flake8==5.0.4
-Flake8-pyproject==1.2.3
+-r common/requirements.txt
+-r site/requirements.txt
+ipython==8.16.1
+jupyter_client==8.4.0
+jupyter_core==5.4.0
 pylama==8.4.1
-mypy==1.2.0
+mypy==1.5.1
+types-cachetools==5.3.0.6
+types-pytz==2023.3.1.1
+ruff==0.15.2
+pytest==9.0.2
+pytest-asyncio==0.25.3

discord/D_info.py

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

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

discord/bot.py

@@ -0,0 +1,254 @@
+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']}\nSide: {options_data['side']}\nStrike: {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']}\nVolume: {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

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

docker-compose.yaml

@@ -0,0 +1,12 @@
+version: "3"
+services:
+  telegram:
+    build:
+      context: .
+      dockerfile: telegram/Dockerfile
+    env_file: .env
+  discord:
+    build:
+      context: .
+      dockerfile: discord/Dockerfile
+    env_file: .env

package-lock.json

@@ -0,0 +1,27 @@
+{
+  "name": "simple-stock-bot",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "devDependencies": {
+        "prettier": "3.0.3"
+      }
+    },
+    "node_modules/prettier": {
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz",
+      "integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==",
+      "dev": true,
+      "bin": {
+        "prettier": "bin/prettier.cjs"
+      },
+      "engines": {
+        "node": ">=14"
+      },
+      "funding": {
+        "url": "https://github.com/prettier/prettier?sponsor=1"
+      }
+    }
+  }
+}

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "prettier": "3.0.3"
+  }
+}

pyproject.toml

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

requirements.txt

@@ -1,7 +0,0 @@
-python-telegram-bot==13.5
-requests==2.25.1
-pandas==2.0.0
-schedule==1.0.0
-mplfinance==0.12.7a5
-markdownify==0.6.5
-cachetools==4.2.2

site/.gitignore

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

site/.gitlab-ci.yml

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

site/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "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

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

site/docs/LICENSE.md

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

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

site/docs/blog/index.md

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

site/docs/blog/posts/intro.md

@@ -0,0 +1,66 @@
+---
+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>
+
+<!-- more -->
+
+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-bots/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/blog/posts/marketdata-release.md

@@ -0,0 +1,40 @@
+---
+title: "v2023.1 Release! New Stock Market Data Provider and More!"
+date: 2023-10-16
+tags: [Simple Stock Bot, Telegram, Discord, MarketDataApp]
+authors: [Anson]
+description: >
+  Discover the latest updates for Simple Stock Bot, including our new integration with MarketData.app for enhanced real-time stock market insights.
+---
+
+## 🌐 General Updates:
+
+- **New Home**: We've transitioned to our fresh and updated website at [simplestockbot.com](https://simplestockbot.com/).
+- **New Data Provider**: We're excited to announce [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web) as our new provider for real-time stock market data, ensuring timely and accurate insights for our users.
+
+<!-- more -->
+
+## 📈 MarketData.app Integration Enhancements:
+
+- We've introduced **additional options** to our MarketData.app integration, ensuring even more precise and varied financial data.
+- **Afterhours Data Fix**: Addressed an issue where after hours stock market data caused errors.
+- **Trending Symbol Accuracy**: Fixed a bug that led to the display of invalid symbols in the `/trending` command.
+
+## 🤖 Bot Improvements & Fixes:
+
+- **Unified Repository**: To streamline our development and deployment, we've merged the Discord and Telegram bots into a single monorepo. Check it out on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot). Contributions welcome!
+- **Inline Functionality Restoration**: Fixed the telegram bot's inline functionality.
+- **Python Telegram Bot Update**: Migrated to the latest version of `Python Telegram Bot` for superior performance and more features.
+- **Rate Limiting Addition**: Implemented rate limiting to ensure optimal performance during peak usage times.
+- **SO MUCH MORE**: [Move to Marketdata.app GitLab Issues](https://gitlab.com/simple-stock-bots/simple-stock-bot/-/milestones/3)
+
+## 📝 Documentation & Repository Overhauls:
+
+- **Centralized Documentation**: For convenience and improved maintenance, we've shifted our documentation into the monorepo.
+- **Documentation Refinement**: Updated our documentation to reflect the latest homepage details.
+
+**Special Mention**: Immense gratitude to our dedicated community for their continual feedback and unwavering support. Dive deeper into the financial realm with Simple Stock Bot!
+
+---
+
+📥 For any concerns, queries, or feedback, don't hesitate to [Contact Us](../../contact.md).

site/docs/blog/posts/sunset.md

@@ -0,0 +1,14 @@
+---
+title: "Simple Bot End-of-Life"
+date: 2024-05-12
+tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
+authors: [Anson]
+description: >
+  Simple Stock Bot is being sunset. 
+---
+
+## What is Simple Stock Bot?
+
+For full details see my full blog post: [https://notes.ansonbiggs.com/simple-stock-bot-end-of-life/](https://notes.ansonbiggs.com/simple-stock-bot-end-of-life/)
+
+I am shutting down Simple Stock Bot, a popular Telegram and Discord bot that provided live stock and cryptocurrency market data. The bot was created in 2018 after my group chat lost access to the Google Allo, which had integrated market data. The bot grew to 15,000 monthly active users, but maintaining the service has become challenging due to increasing data costs and changes to the Discord API. I really appreciate the community and everyone that has donated along the way, this has been a seriously great ride. The bot will soon no longer function on Telegram and Discord.

site/docs/commands.md

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

@@ -0,0 +1,8 @@
+# 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-stock-bot).

site/docs/donate.md

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

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

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

@@ -0,0 +1,40 @@
+/* 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

@@ -0,0 +1,73 @@
+site_name: Simple Stock Bot
+site_url: https://simplestockbot.com
+repo_url: https://gitlab.com/simple-stock-bots/simple-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
+  custom_dir: overrides
+  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:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences

site/overrides/main.html

@@ -0,0 +1,17 @@
+{% extends "base.html" %}
+
+<!-- Announcement bar -->
+{% block announce %}
+
+<div class="admonition danger" style="min-height: 20vh;">
+  <p class="admonition-title">This project is now archived!</p>
+  <p>
+    Please
+    <a href="/blog/2024/05/12/simple-bot-end-of-life/"
+      >click here for more information.</a
+    >
+  </p>
+</div>
+<div class="" admoniton></div>
+
+{% endblock %}

site/requirements.txt

@@ -0,0 +1,6 @@
+mkdocs-material==9.5.22
+mkdocs-material-extensions==1.3.1
+
+# Required for Social Cards
+Pillow==10.0.1
+CairoSVG==2.7.1

telegram/Dockerfile

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

telegram/T_info.py

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

@@ -8,29 +8,31 @@ import os
 import random
 import string
 import traceback
-import logging as log
 from uuid import uuid4
 
 import mplfinance as mpf
+from T_info import T_info
+
 import telegram
-from telegram import (
-    InlineQueryResultArticle,
-    InputTextMessageContent,
-    LabeledPrice,
-    Update,
-)
+from common.symbol_router import Router
+from telegram import InlineQueryResultArticle, InputTextMessageContent, LabeledPrice, Update
 from telegram.ext import (
-    CallbackContext,
+    Application,
     CommandHandler,
-    Filters,
+    ContextTypes,
     InlineQueryHandler,
     MessageHandler,
     PreCheckoutQueryHandler,
-    Updater,
+    filters,
 )
 
-from 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"]
 
@@ -43,65 +45,62 @@ except KeyError:
 s = Router()
 t = T_info()
 
-# Enable logging
-logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
 
-logger = logging.getLogger(__name__)
 log.info("Bot script started.")
 
 
-def start(update: Update, context: CallbackContext):
+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}")
-    update.message.reply_text(
+    await update.message.reply_text(
         text=t.help_text,
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def help(update: Update, context: CallbackContext):
+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}")
-    update.message.reply_text(
+    await update.message.reply_text(
         text=t.help_text,
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def license(update: Update, context: CallbackContext):
+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}")
-    update.message.reply_text(
+    await update.message.reply_text(
         text=t.license,
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def status(update: Update, context: CallbackContext):
+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.")
 
-    update.message.reply_text(
+    await update.message.reply_text(
         text=bot_status,
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
     )
 
 
-def donate(update: Update, context: CallbackContext):
+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:
-        update.message.reply_text(
+        await update.message.reply_text(
             text=t.donate_text,
-            parse_mode=telegram.ParseMode.MARKDOWN,
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
             disable_notification=True,
         )
         amount = 1.0
@@ -111,11 +110,11 @@ def donate(update: Update, context: CallbackContext):
     try:
         price = int(amount * 100)
     except ValueError:
-        update.message.reply_text(f"{amount} is not a valid donation amount or number.")
+        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}")
 
-    context.bot.send_invoice(
+    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}",
@@ -131,37 +130,40 @@ def donate(update: Update, context: CallbackContext):
     )
 
 
-def precheckout_callback(update: Update, context: CallbackContext):
+async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
     """Approves donation"""
     log.info("precheckout_callback queried")
     query = update.pre_checkout_query
 
-    query.answer(ok=True)
+    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
-    #     query.answer(ok=True)
+    #     await query.answer(ok=True)
     # else:
-    #     query.answer(ok=False, error_message="Something went wrong...")
+    #     await query.answer(ok=False, error_message="Something went wrong...")
 
 
-def successful_payment_callback(update: Update, context: CallbackContext):
+async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
     """Thanks user for donation"""
     log.info("Successful payment!")
-    update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
+    await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
 
 
-def symbol_detect_image(update: Update, context: CallbackContext):
+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.
     """
-    if update.message.caption:
-        update.message.text = update.message.caption
-        symbol_detect(update, context)
+    try:
+        if update.message.caption:
+            update.message.text = update.message.caption
+            await symbol_detect(update, context)
+    except AttributeError:
+        return
 
 
-def symbol_detect(update: Update, context: CallbackContext):
+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.
@@ -170,27 +172,84 @@ def symbol_detect(update: Update, context: CallbackContext):
         message = update.message.text
         chat_id = update.message.chat_id
         if "$" in message:
-            symbols = s.find_symbols(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:
-        # Let user know bot is working
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
         log.info(f"Symbols found: {symbols}")
+        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
 
         for reply in s.price_reply(symbols):
-            update.message.reply_text(
+            await update.message.reply_text(
                 text=reply,
-                parse_mode=telegram.ParseMode.MARKDOWN,
+                parse_mode=telegram.constants.ParseMode.MARKDOWN,
                 disable_notification=True,
             )
 
 
-def intra(update: Update, context: CallbackContext):
+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*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}")
 
@@ -198,7 +257,7 @@ def intra(update: Update, context: CallbackContext):
     chat_id = update.message.chat_id
 
     if message.strip().split("@")[0] == "/intra":
-        update.message.reply_text(
+        await update.message.reply_text(
             "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
         )
         return
@@ -209,19 +268,19 @@ def intra(update: Update, context: CallbackContext):
     if len(symbols):
         symbol = symbols[0]
     else:
-        update.message.reply_text("No symbols or coins found.")
+        await update.message.reply_text("No symbols or coins found.")
         return
 
     df = s.intra_reply(symbol)
     if df.empty:
-        update.message.reply_text(
+        await update.message.reply_text(
             text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.ParseMode.MARKDOWN,
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
             disable_notification=True,
         )
         return
 
-    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
 
     buf = io.BytesIO()
     mpf.plot(
@@ -234,17 +293,17 @@ def intra(update: Update, context: CallbackContext):
     )
     buf.seek(0)
 
-    update.message.reply_photo(
+    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')}"
+        + f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
         + f"\n\n{s.price_reply([symbol])[0]}",
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def chart(update: Update, context: CallbackContext):
+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}")
 
@@ -252,7 +311,7 @@ def chart(update: Update, context: CallbackContext):
     chat_id = update.message.chat_id
 
     if message.strip().split("@")[0] == "/chart":
-        update.message.reply_text(
+        await update.message.reply_text(
             "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
         )
         return
@@ -262,18 +321,18 @@ def chart(update: Update, context: CallbackContext):
     if len(symbols):
         symbol = symbols[0]
     else:
-        update.message.reply_text("No symbols or coins found.")
+        await update.message.reply_text("No symbols or coins found.")
         return
 
     df = s.chart_reply(symbol)
     if df.empty:
-        update.message.reply_text(
+        await update.message.reply_text(
             text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.ParseMode.MARKDOWN,
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
             disable_notification=True,
         )
         return
-    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
 
     buf = io.BytesIO()
     mpf.plot(
@@ -286,40 +345,42 @@ def chart(update: Update, context: CallbackContext):
     )
     buf.seek(0)
 
-    update.message.reply_photo(
+    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.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def trending(update: Update, context: CallbackContext):
+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
 
-    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
 
     trending_list = s.trending()
-    log.info(trending_list)
 
-    update.message.reply_text(
+    await update.message.reply_text(
         text=trending_list,
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def inline_query(update: Update, context: CallbackContext):
+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.
     """
-    # info(f"Inline command ran by {update.message.chat.username}")
-    log.info(f"Query: {update.inline_query.query}")
+
+    if not update.inline_query.query:
+        return
+
+    print(f"Query: {update.inline_query.query}")
 
     ignored_queries = {"$", "$$", " ", ""}
 
@@ -329,12 +390,14 @@ def inline_query(update: Update, context: CallbackContext):
         in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
         """
 
-        update.inline_query.answer(
+        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.ParseMode.MARKDOWN),
+                    input_message_content=InputTextMessageContent(
+                        default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
+                    ),
                 )
             ]
         )
@@ -347,29 +410,31 @@ def inline_query(update: Update, context: CallbackContext):
             InlineQueryResultArticle(
                 str(uuid4()),
                 title=row["description"],
-                input_message_content=InputTextMessageContent(row["price_reply"], parse_mode=telegram.ParseMode.MARKDOWN),
+                input_message_content=InputTextMessageContent(
+                    row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
+                ),
             )
         )
 
         if len(results) == 5:
-            update.inline_query.answer(results, cache_time=60 * 60)
+            await update.inline_query.answer(results, cache_time=60 * 60)
             log.info("Inline Command was successful")
             return
-    update.inline_query.answer(results)
+    await update.inline_query.answer(results)
 
 
-def rand_pick(update: Update, context: CallbackContext):
+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}")
 
-    update.message.reply_text(
+    await update.message.reply_text(
         text=s.random_pick(),
-        parse_mode=telegram.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
         disable_notification=True,
     )
 
 
-def error(update: Update, context: CallbackContext):
+async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
     """Log Errors caused by Updates."""
     log.warning('Update "%s" caused error "%s"', update, error)
 
@@ -380,69 +445,63 @@ def error(update: Update, context: CallbackContext):
     log.warning(f"Logging error: {err_code}")
 
     if update:
-        message = (
+        log.warning(
             f"An exception was raised while handling an update\n"
-            f"<pre>update = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}"
-            "</pre>\n\n"
-            f"<pre>context.chat_data = {html.escape(str(context.chat_data))}</pre>\n\n"
-            f"<pre>context.user_data = {html.escape(str(context.user_data))}</pre>\n\n"
-            f"<pre>{html.escape(tb_string)}</pre>"
+            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)}"
         )
-        log.warning(message)
-    else:
-        log.warning(tb_string)
 
-    update.message.reply_text(
-        text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
-        parse_mode=telegram.ParseMode.MARKDOWN,
-    )
+        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.
-    updater = Updater(TELEGRAM_TOKEN)
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
+    application = Application.builder().token(TELEGRAM_TOKEN).build()
 
     # on different commands - answer in Telegram
-    dp.add_handler(CommandHandler("start", start))
-    dp.add_handler(CommandHandler("help", help))
-    dp.add_handler(CommandHandler("license", license))
-    dp.add_handler(CommandHandler("trending", trending))
-    dp.add_handler(CommandHandler("random", rand_pick))
-    dp.add_handler(CommandHandler("donate", donate))
-    dp.add_handler(CommandHandler("status", status))
-    dp.add_handler(CommandHandler("inline", inline_query))
+    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.
-    dp.add_handler(CommandHandler("intra", intra, run_async=True))
-    dp.add_handler(CommandHandler("intraday", intra, run_async=True))
-    dp.add_handler(CommandHandler("day", intra, run_async=True))
-    dp.add_handler(CommandHandler("chart", chart, run_async=True))
-    dp.add_handler(CommandHandler("month", chart, run_async=True))
+    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
-    dp.add_handler(MessageHandler(Filters.text, symbol_detect))
-    dp.add_handler(MessageHandler(Filters.photo, symbol_detect_image))
+    application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
+    application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
 
     # Inline Bot commands
-    dp.add_handler(InlineQueryHandler(inline_query))
+    application.add_handler(InlineQueryHandler(inline_query))
 
     # Pre-checkout handler to final check
-    dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
+    application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
 
     # Payment success
-    dp.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
+    application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
 
     # log all errors
-    dp.add_error_handler(error)
+    application.add_error_handler(error)
 
     # Start the Bot
-    updater.start_polling()
-
-    updater.idle()
+    application.run_polling(allowed_updates=Update.ALL_TYPES)
 
 
 if __name__ == "__main__":

telegram/telegram-reqs.txt

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

tests.py

@@ -1,27 +1,15 @@
-import keyboard
 import time
 
+import keyboard
 
 tests = """$$xno
-/info $tsla
-/info $$btc
-/news $tsla
-/news $$btc
-/stat $tsla
-/stat $$btc
-/cap $tsla
-/cap $$btc
-/dividend $tsla
-/dividend $msft
-/dividend $$btc
+$tsla
 /intra $tsla
 /intra $$btc
 /chart $tsla
 /chart $$btc
 /help
-/trending""".split(
-    "\n"
-)
+/trending""".split("\n")
 
 print("press enter to start")
 keyboard.wait("enter")

tests/conftest.py

@@ -0,0 +1,15 @@
+"""Pytest configuration and fixtures."""
+
+import sys
+import os
+from pathlib import Path
+
+# Add the project root to Python path so we can import modules
+project_root = Path(__file__).parent.parent
+sys.path.insert(0, str(project_root))
+
+# Set environment variables for testing
+os.environ.setdefault("TELEGRAM", "test_token")
+os.environ.setdefault("DISCORD", "test_token")
+os.environ.setdefault("MARKETDATA", "test_token")
+os.environ.setdefault("STRIPE", "test_token")

tests/test_rate_limited.py

@@ -0,0 +1,132 @@
+"""Test the rate_limited decorator functionality."""
+
+import time
+from unittest.mock import patch
+from common.utilities import rate_limited
+
+
+class TestRateLimited:
+    """Test rate_limited decorator functionality."""
+
+    def test_rate_limited_decorator(self):
+        """Test that rate limiting works correctly."""
+        call_times = []
+
+        @rate_limited(2.0)  # 2 calls per second max
+        def test_function():
+            call_times.append(time.time())
+            return len(call_times)
+
+        # First call should execute immediately
+        result1 = test_function()
+        assert result1 == 1
+        assert len(call_times) == 1
+
+        # Second call should be delayed
+        start_time = time.time()
+        result2 = test_function()
+        end_time = time.time()
+
+        assert result2 == 2
+        assert len(call_times) == 2
+
+        # Should have waited at least close to 0.5 seconds (1/2 calls per second)
+        elapsed = end_time - start_time
+        assert elapsed >= 0.4  # Allow some tolerance for timing
+
+    def test_rate_limited_with_args(self):
+        """Test rate limited function with arguments."""
+
+        @rate_limited(1.0)  # 1 call per second
+        def test_function(x, y=1):
+            return x + y
+
+        # Test that arguments are passed correctly
+        result1 = test_function(5, y=10)
+        assert result1 == 15
+
+        # Test positional and keyword args
+        start_time = time.time()
+        result2 = test_function(3, 7)
+        end_time = time.time()
+
+        assert result2 == 10
+        # Should have waited about 1 second
+        elapsed = end_time - start_time
+        assert elapsed >= 0.9
+
+    def test_rate_limited_logging(self):
+        """Test that rate limiting logs waiting messages."""
+
+        @rate_limited(10.0)  # 10 calls per second
+        def test_function():
+            return "called"
+
+        with patch("common.utilities.log.info") as mock_log:
+            # First call should not log
+            test_function()
+            mock_log.assert_not_called()
+
+            # Second call should log the wait
+            test_function()
+            mock_log.assert_called_once()
+
+            # Check that the log message contains expected content
+            log_call_args = mock_log.call_args[0][0]
+            assert "Rate limit exceeded" in log_call_args
+            assert "Waiting for" in log_call_args
+
+    def test_rate_limited_different_rates(self):
+        """Test different rate limiting values."""
+
+        @rate_limited(4.0)  # 4 calls per second = 0.25 second intervals
+        def fast_function():
+            return time.time()
+
+        @rate_limited(0.5)  # 0.5 calls per second = 2 second intervals
+        def slow_function():
+            return time.time()
+
+        # Test fast function (should wait ~0.25 seconds)
+        start = time.time()
+        fast_function()
+        fast_function()
+        fast_elapsed = time.time() - start
+        assert 0.2 <= fast_elapsed <= 0.4
+
+        # Test slow function (should wait ~2 seconds)
+        start = time.time()
+        slow_function()
+        slow_function()
+        slow_elapsed = time.time() - start
+        assert slow_elapsed >= 1.9
+
+    def test_multiple_instances(self):
+        """Test that different decorated functions maintain separate rate limits."""
+
+        @rate_limited(2.0)
+        def function_a():
+            return "A"
+
+        @rate_limited(2.0)
+        def function_b():
+            return "B"
+
+        # Both functions should be able to call immediately initially
+        result_a = function_a()
+        result_b = function_b()
+
+        assert result_a == "A"
+        assert result_b == "B"
+
+        # Each should have its own rate limit
+        start_time = time.time()
+        function_a()  # Should wait
+        elapsed = time.time() - start_time
+        assert elapsed >= 0.4
+
+        # function_b should still be able to call without waiting
+        start_time = time.time()
+        function_b()  # Should not wait much since it has separate limit
+        elapsed = time.time() - start_time
+        assert elapsed >= 0.4  # It will also wait since it was called recently

tests/test_router.py

@@ -0,0 +1,149 @@
+"""Test the Router symbol detection functionality."""
+
+from unittest.mock import Mock, patch
+from common.symbol_router import Router
+from common.Symbol import Stock, Coin
+
+
+class TestRouter:
+    """Test Router symbol detection and parsing."""
+
+    def setup_method(self):
+        """Set up test fixtures."""
+        # Mock the MarketData and cg_Crypto dependencies
+        with patch("common.symbol_router.MarketData") as mock_md, patch("common.symbol_router.cg_Crypto") as mock_crypto:
+            # Mock MarketData
+            mock_md_instance = Mock()
+            mock_md.return_value = mock_md_instance
+
+            # Mock cg_Crypto
+            mock_crypto_instance = Mock()
+            mock_crypto.return_value = mock_crypto_instance
+
+            # Create mock symbol list for crypto
+            import pandas as pd
+
+            mock_crypto_instance.symbol_list = pd.DataFrame(
+                {
+                    "symbol": ["btc", "eth", "ada"],
+                    "id": ["bitcoin", "ethereum", "cardano"],
+                    "name": ["Bitcoin", "Ethereum", "Cardano"],
+                }
+            )
+
+            self.router = Router()
+            self.mock_stock = mock_md_instance
+            self.mock_crypto = mock_crypto_instance
+
+    def test_stock_symbol_regex(self):
+        """Test that stock symbol regex correctly identifies patterns."""
+        import re
+
+        # Test the regex pattern directly
+        pattern = self.router.STOCK_REGEX
+
+        # Should match
+        assert re.search(pattern, "$AAPL")
+        assert re.search(pattern, "What about $TSLA today?")
+        assert re.search(pattern, "Look at $NVDA and $AMD")
+
+        # Should not match crypto patterns
+        assert not re.search(pattern, "$$BTC")
+
+        # Should not match without $
+        assert not re.search(pattern, "AAPL")
+
+    def test_crypto_symbol_regex(self):
+        """Test that crypto symbol regex correctly identifies patterns."""
+        import re
+
+        pattern = self.router.CRYPTO_REGEX
+
+        # Should match
+        assert re.search(pattern, "$$BTC")
+        assert re.search(pattern, "How is $$ETH doing?")
+        assert re.search(pattern, "$$BTC and $$ETH")
+
+        # Should not match single $ patterns
+        assert not re.search(pattern, "$BTC")
+        assert not re.search(pattern, "$AAPL")
+
+    def test_find_symbols_stock(self):
+        """Test stock symbol detection."""
+        # Mock successful stock lookup
+        self.mock_stock.symbol_id.return_value = {"ticker": "AAPL", "title": "Apple Inc.", "mkt_cap_rank": 1}
+
+        result = self.router.find_symbols("$AAPL")
+
+        assert len(result) == 1
+        assert isinstance(result[0], Stock)
+        self.mock_stock.symbol_id.assert_called_with("AAPL")
+
+    def test_find_symbols_crypto(self):
+        """Test crypto symbol detection."""
+        # Mock crypto dataframe lookup
+        import pandas as pd
+
+        mock_crypto_df = pd.DataFrame({"symbol": ["btc"], "id": ["bitcoin"], "name": ["Bitcoin"], "type_id": ["$$btc"]})
+
+        # Set up the mock to return the DataFrame when filtered
+        self.mock_crypto.symbol_list = pd.DataFrame(
+            {
+                "symbol": ["btc", "eth"],
+                "id": ["bitcoin", "ethereum"],
+                "name": ["Bitcoin", "Ethereum"],
+                "type_id": ["$$btc", "$$eth"],
+            }
+        )
+
+        # Mock the pandas filtering
+        with patch.object(self.mock_crypto.symbol_list, "str") as mock_str:
+            mock_str.fullmatch.return_value = mock_crypto_df
+            mock_crypto_df.empty = False
+
+            result = self.router.find_symbols("$$BTC")
+
+            assert len(result) == 1
+            assert isinstance(result[0], Coin)
+
+    def test_find_symbols_no_matches(self):
+        """Test behavior when no symbols are found."""
+        result = self.router.find_symbols("Hello world")
+        assert result == []
+
+    def test_find_symbols_invalid_stock(self):
+        """Test behavior when stock symbol is not found."""
+        # Mock failed stock lookup
+        self.mock_stock.symbol_id.return_value = None
+
+        result = self.router.find_symbols("$INVALID")
+
+        assert result == []
+        self.mock_stock.symbol_id.assert_called_with("INVALID")
+
+    def test_find_symbols_multiple(self):
+        """Test finding multiple symbols."""
+        # Mock successful lookups for both
+        self.mock_stock.symbol_id.side_effect = [
+            {"ticker": "AAPL", "title": "Apple Inc.", "mkt_cap_rank": 1},
+            {"ticker": "TSLA", "title": "Tesla Inc.", "mkt_cap_rank": 5},
+        ]
+
+        result = self.router.find_symbols("$AAPL and $TSLA")
+
+        assert len(result) == 2
+        assert all(isinstance(symbol, Stock) for symbol in result)
+
+    def test_trending_weight_tracking(self):
+        """Test that trending counts are updated."""
+        # Mock successful stock lookup
+        self.mock_stock.symbol_id.return_value = {"ticker": "AAPL", "title": "Apple Inc.", "mkt_cap_rank": 1}
+
+        # Clear trending count
+        self.router.trending_count = {}
+
+        result = self.router.find_symbols("$AAPL", trending_weight=2)
+
+        assert len(result) == 1
+        assert "$AAPL" in self.router.trending_count
+        assert self.router.trending_count["$AAPL"] == 2

tests/test_symbols.py

@@ -0,0 +1,128 @@
+"""Test Symbol, Stock, and Coin class construction."""
+
+from unittest.mock import patch
+import pandas as pd
+from common.Symbol import Symbol, Stock, Coin
+
+
+class TestSymbol:
+    """Test base Symbol class."""
+
+    def test_symbol_creation(self):
+        """Test basic Symbol creation."""
+        symbol = Symbol("TEST")
+        assert symbol.symbol == "TEST"
+        assert symbol.id == "TEST"
+        assert symbol.name == "TEST"
+
+    def test_symbol_currency_default(self):
+        """Test that currency defaults to USD."""
+        symbol = Symbol("TEST")
+        assert symbol.currency == "usd"
+
+
+class TestStock:
+    """Test Stock class functionality."""
+
+    def test_stock_creation(self):
+        """Test Stock object creation with proper dictionary structure."""
+        stock_info = {"ticker": "AAPL", "title": "Apple Inc.", "mkt_cap_rank": 1}
+
+        stock = Stock(stock_info)
+        assert stock.symbol == "AAPL"
+        assert stock.id == "AAPL"
+        assert stock.name == "Apple Inc."
+        assert stock.tag == "$AAPL"
+        assert stock.market_cap_rank == 1
+
+        # Verify inheritance
+        assert isinstance(stock, Symbol)
+        assert isinstance(stock, Stock)
+
+    def test_stock_with_different_data(self):
+        """Test Stock creation with different stock data."""
+        stock_info = {"ticker": "TSLA", "title": "Tesla, Inc.", "mkt_cap_rank": 5}
+
+        stock = Stock(stock_info)
+        assert stock.symbol == "TSLA"
+        assert stock.id == "TSLA"
+        assert stock.name == "Tesla, Inc."
+        assert stock.tag == "$TSLA"
+        assert stock.market_cap_rank == 5
+
+    def test_stock_tag_format(self):
+        """Test that stock tags are properly formatted with $ prefix."""
+        stock_info = {"ticker": "NVDA", "title": "NVIDIA Corporation", "mkt_cap_rank": 3}
+
+        stock = Stock(stock_info)
+        assert stock.tag == "$NVDA"
+        assert stock.tag.startswith("$")
+
+
+class TestCoin:
+    """Test Coin class functionality."""
+
+    def test_coin_creation_single_row(self):
+        """Test Coin object creation with single row DataFrame."""
+        coin_data = pd.DataFrame({"symbol": ["btc"], "id": ["bitcoin"], "name": ["Bitcoin"], "type_id": ["$$btc"]})
+
+        coin = Coin(coin_data)
+        assert coin.symbol == "btc"
+        assert coin.id == "bitcoin"
+        assert coin.name == "Bitcoin"
+        assert coin.tag == "$$BTC"
+
+        # Verify inheritance
+        assert isinstance(coin, Symbol)
+        assert isinstance(coin, Coin)
+
+    def test_coin_creation_ethereum(self):
+        """Test Coin creation with Ethereum data."""
+        coin_data = pd.DataFrame({"symbol": ["eth"], "id": ["ethereum"], "name": ["Ethereum"], "type_id": ["$$eth"]})
+
+        coin = Coin(coin_data)
+        assert coin.symbol == "eth"
+        assert coin.id == "ethereum"
+        assert coin.name == "Ethereum"
+        assert coin.tag == "$$ETH"
+
+    def test_coin_multiple_rows_takes_first(self):
+        """Test that when multiple rows exist, only the first is used."""
+        coin_data = pd.DataFrame(
+            {
+                "symbol": ["btc", "btc2"],
+                "id": ["bitcoin", "bitcoin-cash"],
+                "name": ["Bitcoin", "Bitcoin Cash"],
+                "type_id": ["$$btc", "$$bch"],
+            }
+        )
+
+        # Mock the head method to return first row
+        with patch.object(coin_data, "head") as mock_head:
+            first_row = pd.DataFrame({"symbol": ["btc"], "id": ["bitcoin"], "name": ["Bitcoin"], "type_id": ["$$btc"]})
+            mock_head.return_value = first_row
+
+            coin = Coin(coin_data)
+            mock_head.assert_called_once_with(1)
+            # The coin should use the first row data
+            assert coin.symbol == "btc"
+            assert coin.id == "bitcoin"
+
+    def test_coin_tag_uppercase(self):
+        """Test that coin tags are properly uppercased."""
+        coin_data = pd.DataFrame({"symbol": ["ada"], "id": ["cardano"], "name": ["Cardano"], "type_id": ["$$ada"]})
+
+        coin = Coin(coin_data)
+        assert coin.tag == "$$ADA"
+        assert coin.tag.isupper()
+
+    def test_coin_dataframe_access(self):
+        """Test that coin properly accesses DataFrame values."""
+        coin_data = pd.DataFrame({"symbol": ["dot"], "id": ["polkadot"], "name": ["Polkadot"], "type_id": ["$$dot"]})
+
+        coin = Coin(coin_data)
+        # Test that values are extracted correctly from DataFrame
+        assert isinstance(coin.symbol, str)
+        assert isinstance(coin.id, str)
+        assert isinstance(coin.name, str)
+        assert isinstance(coin.tag, str)