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,5 +1,3 @@
 FROM python:3.11
 
 COPY . .
-
-# RUN pip install -r requirements.txt

.devcontainer/devcontainer.json

@@ -5,7 +5,8 @@
   // 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"
+    "dockerfile": "Dockerfile",
+    "context": ".."
   },
   "features": {
     "ghcr.io/devcontainers-contrib/features/black:2": {},
@@ -16,16 +17,17 @@
   "customizations": {
     "vscode": {
       "extensions": [
-		"ms-python.python",
+        "ms-python.python",
-		"ms-python.black-formatter",
+        "ms-python.black-formatter",
-		"ms-python.flake8",
+        "ms-python.vscode-pylance",
-		"ms-python.vscode-pylance",
+        "ms-python.isort",
-		"ms-python.isort",
+        "charliermarsh.ruff",
-		"charliermarsh.ruff"
+        "ms-toolsai.jupyter",
-	]
+        "esbenp.prettier-vscode"
+      ]
     }
   },
-  "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
+  "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.
@@ -36,4 +38,4 @@
   // "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,2 +1,3 @@
 __pycache__
-.env
+.env
+node_modules

.gitlab-ci.yml

@@ -1,21 +1,23 @@
-stages:
+stages:
-  - lint
+  - lint
-  - deploy
+  - build_site
-
+  - deploy
-black:
+
-  stage: lint
+ruff:
-  image: registry.gitlab.com/pipeline-components/black:latest
+  stage: lint
-  script:
+  image: python:3.12-slim
-    - black --check --verbose -- .
+  script:
-
+    - pip3 install ruff==0.15.2
-ruff:
+    - ruff check . --output-format gitlab
-  stage: lint
+    - ruff format . --check
-  # image: registry.gitlab.com/pipeline-components/ruff:latest
+  allow_failure: false
-  image: python:3.11-slim
+
-  script:
+# prettier:
-    - pip3 install ruff
+#   stage: lint
-    - ruff --output-format gitlab .
+#   image: node:16-slim # Use Node.js image since prettier is a Node.js tool
-
+#   script:
-
+#     - npm install prettier
-include:
+#     - npx prettier --check . # Adjust the path as needed
-  - local: /docs/.gitlab-ci.yml
+
+include:
+  - local: /site/.gitlab-ci.yml

.vscode/settings.json

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

README.md

@@ -9,14 +9,16 @@ Enhance your group chats on Telegram and Discord with real-time stock and crypto
 ## Documentation
 
 Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
-- [Official Documentation](https://docs.simplestockbot.com/)
+
-- [Command Reference](https://docs.simplestockbot.com/commands/)
+- [Official Documentation](https://simplestockbot.com/)
+- [Command Reference](https://simplestockbot.com/commands/)
 
 ## Support the Project
 
 Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
 
 You can contribute by:
+
 - Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
 - Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
 - [Getting in touch](contact.md) for any inquiries or suggestions.
@@ -24,7 +26,7 @@ You can contribute by:
 ### Additional Support:
 
 - Follow on [Twitter](https://twitter.com/AnsonBiggs)
-- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
+- 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)
   - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
@@ -32,12 +34,14 @@ You can contribute by:
 ## Hosting
 
 Self-hosting instructions are provided for those interested in running the bot on their own servers:
-- [Hosting Guide](https://docs.simplestockbot.com/hosting/)
+
+- [Hosting Guide](https://simplestockbot.com/hosting/)
 
 ## Contact
 
 Reach out for bug reports, feature requests, or other inquiries:
-- [Contact Page](https://docs.simplestockbot.com/contact/)
+
+- [Contact Page](https://simplestockbot.com/contact/)
 
 ---
 

common/MarketData.py

@@ -1,269 +1,361 @@
-import datetime as dt
+import datetime as dt
-import logging
+import logging
-import os
+import os
-from typing import Dict
+from collections import OrderedDict
-
+from typing import Dict
-import pandas as pd
+
-import pytz
+import humanize
-import requests as r
+import pandas as pd
-import schedule
+import pytz
-
+import requests as r
-from common.Symbol import Stock
+import schedule
-
+
-log = logging.getLogger(__name__)
+
-
+from common.Symbol import Stock
-
+
-class MarketData:
+log = logging.getLogger(__name__)
-    """
+
-    Functions for finding stock market information about symbols from MarkData.app
+
-    """
+class MarketData:
-
+    """
-    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
+    Functions for finding stock market information about symbols from MarkData.app
-
+    """
-    charts: Dict[Stock, pd.DataFrame] = {}
+
-
+    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
-    openTime = dt.time(hour=9, minute=30, second=0)
+
-    marketTimeZone = pytz.timezone("US/Eastern")
+    symbol_list: Dict[str, Dict] = {}
-
+    charts: Dict[Stock, pd.DataFrame] = {}
-    def __init__(self) -> None:
+
-        """Creates a Symbol Object
+    openTime = dt.time(hour=9, minute=30, second=0)
-
+    marketTimeZone = pytz.timezone("US/Eastern")
-        Parameters
+
-        ----------
+    def __init__(self) -> None:
-        MARKETDATA_TOKEN : str
+        """Creates a Symbol Object
-            MarketData.app API Token
+
-        """
+        Parameters
-
+        ----------
-        try:
+        MARKETDATA_TOKEN : str
-            self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
+            MarketData.app API Token
-
+        """
-            if self.MARKETDATA_TOKEN == "TOKEN":
+
-                self.MARKETDATA_TOKEN = ""
+        try:
-        except KeyError:
+            self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
-            self.MARKETDATA_TOKEN = ""
+
-            log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
+            if self.MARKETDATA_TOKEN == "TOKEN":
-            log.warning("Use this affiliate link so that the bot can stay free:")
+                self.MARKETDATA_TOKEN = ""
-            log.warning("https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo")
+        except KeyError:
-
+            self.MARKETDATA_TOKEN = ""
-        if self.MARKETDATA_TOKEN != "":
+            log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
-            schedule.every().day.do(self.clear_charts)
+            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")
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+
-        url = "https://api.marketdata.app/v1/" + endpoint
+        if self.MARKETDATA_TOKEN != "":
-
+            schedule.every().day.do(self.clear_charts)
-        # set token param if it wasn't passed.
+
-        params["token"] = self.MARKETDATA_TOKEN
+        self.get_symbol_list()
-
+        schedule.every().day.do(self.get_symbol_list)
-        # Undocumented query variable that ensures bot usage can be
+
-        # monitored even if someone doesn't make it through an affiliate link.
+    def get(self, endpoint, params=None, timeout=10, headers=None) -> dict:
-        params["application"] = "simplestockbot"
+        url = "https://api.marketdata.app/v1/" + endpoint
-
+
-        resp = r.get(url, params=params, timeout=timeout)
+        if params is None:
-
+            params = {}
-        # Make sure API returned a proper status code
+
-        try:
+        # set token param if it wasn't passed.
-            resp.raise_for_status()
+        params["token"] = self.MARKETDATA_TOKEN
-        except r.exceptions.HTTPError as e:
+
-            logging.error(e)
+        # Undocumented query variable that ensures bot usage can be
-            return {}
+        # monitored even if someone doesn't make it through an affiliate link.
-
+        params["application"] = "simplestockbot"
-        # Make sure API returned valid JSON
+
-        try:
+        if headers is None:
-            resp_json = resp.json()
+            headers = {}
-
+        headers = {"User-Agent": "Simple Stock Bot anson@ansonbiggs.com"} | headers
-            match resp_json["s"]:
+
-                case "ok":
+        resp = r.get(url, params=params, timeout=timeout, headers=headers)
-                    return resp_json
+
-                case "no_data":
+        logging.debug(resp.headers.items())
-                    return resp_json
+
-                case "error":
+        # Make sure API returned a proper status code
-                    logging.error("MarketData Error:\n" + resp_json["errmsg"])
+        try:
-                    return {}
+            resp.raise_for_status()
-
+        except r.exceptions.HTTPError as e:
-        except r.exceptions.JSONDecodeError as e:
+            logging.error(e)
-            logging.error(e)
+            return {}
-
+
-        return {}
+        # Make sure API returned valid JSON
-
+        try:
-    def clear_charts(self) -> None:
+            resp_json = resp.json()
-        """
+
-        Clears cache of chart data.
+            match resp_json["s"]:
-        Charts are cached so that only 1 API call per 24 hours is needed since the
+                case "ok":
-            chart data is expensive and a large download.
+                    return resp_json
-        """
+                case "no_data":
-        self.charts = {}
+                    return resp_json
-
+                case "error":
-    def status(self) -> str:
+                    logging.error("MarketData Error:\n" + resp_json["errmsg"])
-        # TODO: At the moment this API is poorly documented, this function likely needs to be revisited later.
+                    return {}
-
+
-        try:
+        except r.exceptions.JSONDecodeError as e:
-            status = r.get(
+            logging.error(e)
-                "https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A",
+
-                timeout=5,
+        return {}
-            )
+
-            status.raise_for_status()
+    def symbol_id(self, symbol: str) -> Dict[str, Dict]:
-        except r.HTTPError:
+        return self.symbol_list.get(symbol.upper(), None)
-            return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
+
-        except r.Timeout:
+    def get_symbol_list(self):
-            return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
+        # Doesn't use `self.get()` since needs are much different
-
+        sec_resp = r.get(
-        statusJSON = status.json()
+            "https://www.sec.gov/files/company_tickers.json",
-
+            headers={
-        if statusJSON["status"] == "ok":
+                "User-Agent": "Simple Stock Bot anson@ansonbiggs.com",
-            return (
+                "Accept-Encoding": "gzip, deflate",
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
+                "Host": "www.sec.gov",
-            )
+            },
-        else:
+        )
-            return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
+        sec_resp.raise_for_status()
-
+        sec_data = sec_resp.json()
-    def price_reply(self, symbol: Stock) -> str:
+
-        """Returns price movement of Stock for the last market day, or after hours.
+        for rank, ticker_info in sec_data.items():
-
+            self.symbol_list[ticker_info["ticker"]] = {
-        Parameters
+                "ticker": ticker_info["ticker"],
-        ----------
+                "title": ticker_info["title"],
-        symbol : Stock
+                "mkt_cap_rank": rank,
-
+            }
-        Returns
+
-        -------
+    def clear_charts(self) -> None:
-        str
+        """
-            Formatted markdown
+        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.
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
+        """
-            price = round(quoteResp["last"][0], 2)
+        self.charts = {}
-
+
-            try:
+    def status(self) -> str:
-                changePercent = round(quoteResp["changepct"][0], 2)
+        """Check MarketData.app API status by making a test request."""
-            except TypeError:
+        try:
-                return f"The price of {symbol} is {price}"
+            # Test the API with a simple request
-
+            status = r.get(
-            message = f"The current price of {symbol.name} is ${price} and "
+                "https://api.marketdata.app/v1/stocks/quotes/AAPL/",
-
+                timeout=5,
-            if changePercent > 0.0:
+            )
-                message += f"is currently up {changePercent}% for the day."
+            status.raise_for_status()
-            elif changePercent < 0.0:
+            return f"MarketData.app API is responding OK with status {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
-                message += f"is currently down {changePercent}% for the day."
+        except r.HTTPError:
-            else:
+            return f"MarketData.app API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
-                message += "hasn't shown any movement for the day."
+        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."
-            return message
+        except Exception as e:
-        else:
+            return f"MarketData.app API check failed: {str(e)}"
-            return f"Getting a quote for {symbol} encountered an error."
+
-
+    def price_reply(self, symbol: Stock) -> str:
-    def spark_reply(self, symbol: Stock) -> str:
+        """Returns price movement of Stock for the last market day, or after hours.
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
+
-            try:
+        Parameters
-                changePercent = round(quoteResp["changepct"][0], 2)
+        ----------
-                return f"`{symbol.tag}`: {changePercent}%"
+        symbol : Stock
-            except TypeError:
+
-                pass
+        Returns
-
+        -------
-        return f"`{symbol.tag}`"
+        str
-
+            Formatted markdown
-    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.
+        if quoteResp := self.get(f"stocks/quotes/{symbol.symbol}/"):
-
+            price = round(quoteResp["last"][0], 2)
-        Parameters
+
-        ----------
+            try:
-        symbol : str
+                changePercent = round(quoteResp["changepct"][0], 2)
-            Stock symbol.
+            except TypeError:
-
+                return f"The price of {symbol.name} is ${price}"
-        Returns
+
-        -------
+            message = f"The current price of {symbol.name} is ${price} and "
-        pd.DataFrame
+
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+            if changePercent > 0.0:
-        """
+                message += f"is currently up {changePercent}% for the day."
-        schedule.run_pending()
+            elif changePercent < 0.0:
-
+                message += f"is currently down {changePercent}% for the day."
-        try:
+            else:
-            return self.charts[symbol.id.upper()]
+                message += "hasn't shown any movement for the day."
-        except KeyError:
+
-            pass
+            return message
-
+        else:
-        resolution = "15"  # minutes
+            return f"Getting a quote for {symbol} encountered an error."
-        now = dt.datetime.now(self.marketTimeZone)
+
-
+    def spark_reply(self, symbol: Stock) -> str:
-        if self.openTime < now.time():
+        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
-            startTime = now.replace(hour=9, minute=30)
+            try:
-        else:
+                changePercent = round(quoteResp["changepct"][0], 2)
-            startTime = now - dt.timedelta(days=1)
+                return f"`{symbol.tag}`: {changePercent}%"
-
+            except TypeError:
-        if data := self.get(
+                pass
-            f"stocks/candles/{resolution}/{symbol}",
+
-            params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
+        return f"`{symbol.tag}`"
-        ):
+
-            data.pop("s")
+    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
-            df = pd.DataFrame(data)
+        """Returns price data for a symbol of the past month up until the previous trading days close.
-            df["t"] = pd.to_datetime(df["t"], unit="s", utc=True)
+        Also caches multiple requests made in the same day.
-            df.set_index("t", inplace=True)
+
-
+        Parameters
-            df.rename(
+        ----------
-                columns={
+        symbol : str
-                    "o": "Open",
+            Stock symbol.
-                    "h": "High",
+
-                    "l": "Low",
+        Returns
-                    "c": "Close",
+        -------
-                    "v": "Volume",
+        pd.DataFrame
-                },
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-                inplace=True,
+        """
-            )
+        schedule.run_pending()
-
+
-            self.charts[symbol.id.upper()] = df
+        try:
-            return df
+            return self.charts[symbol.id.upper()]
-
+        except KeyError:
-        return pd.DataFrame()
+            pass
-
+
-    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
+        resolution = "15"  # minutes
-        """Returns price data for a symbol of the past month up until the previous trading days close.
+        now = dt.datetime.now(self.marketTimeZone)
-        Also caches multiple requests made in the same day.
+
-
+        if self.openTime < now.time():
-        Parameters
+            startTime = now.replace(hour=9, minute=30)
-        ----------
+        else:
-        symbol : str
+            startTime = now - dt.timedelta(days=1)
-            Stock symbol.
+
-
+        if data := self.get(
-        Returns
+            f"stocks/candles/{resolution}/{symbol}",
-        -------
+            params={
-        pd.DataFrame
+                "from": startTime.timestamp(),
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+                "to": now.timestamp(),
-        """
+                "extended": True,
-        schedule.run_pending()
+            },
-
+        ):
-        try:
+            data.pop("s")
-            return self.charts[symbol.id.upper()]
+            df = pd.DataFrame(data)
-        except KeyError:
+            df["t"] = pd.to_datetime(df["t"], unit="s", utc=True)
-            pass
+            df.set_index("t", inplace=True)
-
+
-        to_date = dt.datetime.today().strftime("%Y-%m-%d")
+            df.rename(
-        from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
+                columns={
-        resultion = "daily"
+                    "o": "Open",
-
+                    "h": "High",
-        if data := self.get(
+                    "l": "Low",
-            f"stocks/candles/{resultion}/{symbol}",
+                    "c": "Close",
-            params={
+                    "v": "Volume",
-                "from": from_date,
+                },
-                "to": to_date,
+                inplace=True,
-            },
+            )
-        ):
+
-            data.pop("s")
+            self.charts[symbol.id.upper()] = df
-
+            return df
-            df = pd.DataFrame(data)
+
-            df["t"] = pd.to_datetime(df["t"], unit="s")
+        return pd.DataFrame()
-            df.set_index("t", inplace=True)
+
-
+    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
-            df.rename(
+        """Returns price data for a symbol of the past month up until the previous trading days close.
-                columns={
+        Also caches multiple requests made in the same day.
-                    "o": "Open",
+
-                    "h": "High",
+        Parameters
-                    "l": "Low",
+        ----------
-                    "c": "Close",
+        symbol : str
-                    "v": "Volume",
+            Stock symbol.
-                },
+
-                inplace=True,
+        Returns
-            )
+        -------
-
+        pd.DataFrame
-            self.charts[symbol.id.upper()] = df
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-            return df
+        """
-
+        schedule.run_pending()
-        return pd.DataFrame()
+
+        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,50 +1,55 @@
-import pandas as pd
+import logging
-import logging
+
-
+import pandas as pd
-
+
-class Symbol:
+
-    """
+class Symbol:
-    symbol: What the user calls it. ie tsla or btc
+    """
-    id: What the api expects. ie tsla or bitcoin
+    symbol: What the user calls it. ie tsla or btc
-    name: Human readable. ie Tesla or Bitcoin
+    id: What the api expects. ie tsla or bitcoin
-    tag: Uppercase tag to call the symbol. ie $TSLA or $$BTC
+    name: Human readable. ie Tesla or Bitcoin
-    """
+    tag: Uppercase tag to call the symbol. ie $TSLA or $$BTC
-
+    """
-    currency = "usd"
+
-    pass
+    currency = "usd"
-
+    pass
-    def __init__(self, symbol) -> None:
+
-        self.symbol = symbol
+    def __init__(self, symbol) -> None:
-        self.id = symbol
+        self.symbol = symbol
-        self.name = symbol
+        self.id = symbol
-        self.tag = "$" + symbol
+        self.name = symbol
-
+        self.tag = "$" + symbol
-    def __repr__(self) -> str:
+
-        return f"<{self.__class__.__name__} instance of {self.id} at {id(self)}>"
+    def __repr__(self) -> str:
-
+        return f"<{self.__class__.__name__} instance of {self.id} at {id(self)}>"
-    def __str__(self) -> str:
+
-        return self.id
+    def __str__(self) -> str:
-
+        return self.id
-
+
-class Stock(Symbol):
+    def __hash__(self):
-    """Stock Market Object. Gets data from MarketData"""
+        return hash(self.id)
-
+
-    def __init__(self, symbol: str) -> None:
+
-        self.symbol = symbol
+class Stock(Symbol):
-        self.id = symbol
+    """Stock Market Object. Gets data from MarketData"""
-        self.name = "$" + symbol.upper()
+
-        self.tag = "$" + symbol.lower()
+    def __init__(self, symbol_info: dict) -> None:
-
+        self.symbol = symbol_info["ticker"]
-
+        self.id = symbol_info["ticker"]
-class Coin(Symbol):
+        self.name = symbol_info["title"]
-    """Cryptocurrency Object. Gets data from CoinGecko."""
+        self.tag = "$" + symbol_info["ticker"]
-
+        self.market_cap_rank = symbol_info["mkt_cap_rank"]
-    def __init__(self, symbol: pd.DataFrame) -> None:
+
-        if len(symbol) > 1:
+
-            logging.info(f"Crypto with shared id:\n\t{symbol.id}")
+class Coin(Symbol):
-            symbol = symbol.head(1)
+    """Cryptocurrency Object. Gets data from CoinGecko."""
-
+
-        self.symbol = symbol.symbol.values[0]
+    def __init__(self, symbol: pd.DataFrame) -> None:
-        self.id = symbol.id.values[0]
+        if len(symbol) > 1:
-        self.name = symbol.name.values[0]
+            logging.info(f"Crypto with shared id:\n\t{symbol.id}")
-        self.tag = symbol.type_id.values[0].upper()
+            symbol = symbol.head(1)
+
+        self.symbol = symbol.symbol.values[0]
+        self.id = symbol.id.values[0]
+        self.name = symbol.name.values[0]
+        self.tag = symbol.type_id.values[0].upper()

common/cg_Crypto.py

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

common/requirements.txt

@@ -1,6 +1,8 @@
-requests==2.31.0
+cachetools==7.0.1
-pandas==2.1.1
+humanize==4.15.0
-schedule==1.2.1
+markdownify==1.2.2
-mplfinance==0.12.10b0
+mplfinance==0.12.10a7
-markdownify==0.11.6
+pandas==3.0.1
-cachetools==5.3.1
+requests==2.32.5
+rush==2021.4.0
+schedule==1.2.2

common/symbol_router.py

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

discord/D_info.py

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

discord/Dockerfile

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

discord/bot.py

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

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

docker-compose.yaml

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

docs/.gitlab-ci.yml

@@ -1,12 +0,0 @@
-image: python:3.11
-pages:
-  stage: deploy
-  script:
-    - cd ./docs
-    - pip install -r requirements.txt
-    - mkdocs build --site-dir ../public --verbose
-  artifacts:
-    paths:
-      - public
-  # rules:
-  #   - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

docs/.vscode/settings.json

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

docs/requirements.txt

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

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,11 +1,2 @@
-[tool.black]
-line-length = 130
-
-[tool.flake8]
-max-line-length = 130
-
-[tool.pycodestyle]
-max_line_length = 130
-
 [tool.ruff]
 line-length = 130

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/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

@@ -1,13 +1,16 @@
 Symbols are used in headings to denote what platforms and symbol types a command supports.
 
-- Telegram Only :fontawesome-brands-telegram-plane:
+- Telegram Only :fontawesome-brands-telegram:
 - Discord Only :fontawesome-brands-discord:
 - Bot Commands :robot:
 - Cryptocurrency Support :material-currency-btc:
 - Stock Market Support :bank:
-- OTC Support :dollar:
 
-## Symbol Detection :material-currency-btc: :bank: :dollar:
+## 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.
 
@@ -25,7 +28,13 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
     </div>
 </div>
 
-## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane: 
+## 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.
 
@@ -79,7 +88,7 @@ This command makes a chart of the last 1 month of trading data up until the day
 
 </div>
 
-## `/trending` 
+## `/trending`
 
 Gets the latest trending stocks and their change in price
 
@@ -94,7 +103,9 @@ Gets the latest trending stocks and their change in price
 ━━━━━━━━━━━━━━━━━━━━━━━━━━
 $GME: Gamestop Corporation - Class A, 5.06%
 $MMAT: Meta Materials Inc, 4.77%
-$$BTC: Bitcoin, -0.83%
+
+$$
+BTC: Bitcoin, -0.83%
 $$ETH: Ethereum, 6.06%
 $$DOGE: Binance-Peg Dogecoin, 0.14%
 
@@ -167,10 +178,11 @@ Bot Status:
 
 </div>
 
-## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
+## 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

@@ -5,4 +5,4 @@ Your feedback and experience with Simple Stock Bot is invaluable. Whether you've
 - **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
 - **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
 - **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
-- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).
+- **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/host.md

@@ -2,6 +2,10 @@
 
 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:
@@ -21,27 +25,30 @@ To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` ke
 ## Setup Instructions
 
 1. **Download/Clone the Repository**:
-    - Download or clone this repository to your local machine.
+
+   - 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
+   - Navigate to the project directory and locate the `.env` file.
-    MARKETDATA=your_marketdata_api_key
+   - Fill in the `.env` file with your obtained API keys:
-    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.
+   ```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
+   - Open a terminal in the project directory.
-    docker-compose up
+   - 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

@@ -2,28 +2,38 @@
 
 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

site/mkdocs.yml

@@ -1,23 +1,23 @@
 site_name: Simple Stock Bot
 site_url: https://simplestockbot.com
-edit_uri: /simple-stock-bots/site/tree/master/docs
+repo_url: https://gitlab.com/simple-stock-bots/simple-stock-bot
-repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
 repo_name: Simple Stock Bots
 
 site_description: Simple Discord and Telegram chat bots for Stock Market Data.
 site_author: Anson Biggs
 copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
 
-
 nav:
   - Home: index.md
   - Commands: commands.md
   - Self-Host: host.md
-  - Donate: donate.md
+  # - Donate: donate.md
   - Contact: contact.md
+  - Blog: blog/index.md
 
 theme:
   name: material
+  custom_dir: overrides
   language: en
   features:
     - navigation.instant
@@ -55,23 +55,19 @@ extra:
       link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
       name: MarketData.app for stock data
 
-
-
-
 extra_css:
   - stylesheets/phone.css
 
-
 plugins:
   - search
   - social
-
+  - blog
 
 markdown_extensions:
   - attr_list
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      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

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

telegram/T_info.py

@@ -1,70 +1,69 @@
-"""Functions and Info specific to the Telegram Bot
+"""Functions and Info specific to the Telegram Bot"""
-"""
+
-
+import re
-import re
+
-
+import requests as r
-import requests as r
+
-
+
-
+class T_info:
-class T_info:
+    license = re.sub(
-    license = re.sub(
+        r"\b\n",
-        r"\b\n",
+        " ",
-        " ",
+        r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text,
-        r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
+    )
-    )
+
-
+    help_text = """
-    help_text = """
+Appreciate this bot? Show support by [buying me a beer](https://www.buymeacoffee.com/Anson) 🍻.
-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
-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).
-[affiliate link](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
-
+📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews.
-📢 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).
-**Guide**: All about using and setting up the bot is in the [docs](https://docs.simplestockbot.com).
+
-
+The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
-The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
+- `/chart $$eth` gets a month's Ethereum chart.
-- `/chart $$eth` gets a month's Ethereum chart.
+- `/dividend $psec` shows Prospect Capital's dividend info.
-- `/dividend $psec` shows Prospect Capital's dividend info.
+
-
+Mention a symbol, and the bot reveals its price.
-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.
-E.g., `What's $$btc's price since $tsla accepts it?` gives Bitcoin and Tesla prices.
+
-
+**Commands**
-**Commands**
+- `/donate [USD]`: Support the bot. 🎗️
-- `/donate [USD]`: Support the bot. 🎗️
+- `/intra $[symbol]`: Today's stock activity. 📈
-- `/intra $[symbol]`: Today's stock activity. 📈
+- `/chart $[symbol]`: Past month's stock chart. 📊
-- `/chart $[symbol]`: Past month's stock chart. 📊
+- `/trending`: What's hot in stocks and cryptos. 💬
-- `/trending`: What's hot in stocks and cryptos. 💬
+- `/help`: Bot assistance. 🆘
-- `/help`: Bot assistance. 🆘
+
-
+**Inline Features**
-**Inline Features**
+Search with @SimpleStockBot `[query]` anywhere.
-Search with @SimpleStockBot `[query]` anywhere.
+Pick a ticker, and the bot shares the current price in chat. Note: Prices can lag by an hour.
-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).
-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).
-Bot issues? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
+
-
+    """
-    """
+
-
+    donate_text = """
-    donate_text = """
+Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
-Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
+All funds help maintain servers, with data from
-All funds help maintain servers, with data from
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
-
+**How to Donate?**
-**How to Donate?**
+1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
-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.
-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).
-For questions, visit our [website](https://docs.simplestockbot.com).
+"""
-"""
+
-
+
-
+# Not used by the bot but for updating commands with BotFather
-# Not used by the bot but for updating commands with BotFather
+commands = """
-commands = """
+donate - Donate to the bot 🎗️
-donate - Donate to the bot 🎗️
+help - Get some help using the bot. 🆘
-help - Get some help using the bot. 🆘
+trending - Trending Stocks and Cryptos. 💬
-trending - Trending Stocks and Cryptos. 💬
+intra - $[symbol] Plot since the last market open. 📈
-intra - $[symbol] Plot since the last market open. 📈
+chart - $[chart] Plot of the past month. 📊
-chart - $[chart] Plot of the past month. 📊
+"""
-"""

telegram/bot.py

@@ -1,457 +1,508 @@
-# Works with Python 3.8
+# Works with Python 3.8
-import datetime
+import datetime
-import html
+import html
-import io
+import io
-import json
+import json
-import logging
+import logging
-import os
+import os
-import random
+import random
-import string
+import string
-import traceback
+import traceback
-from uuid import uuid4
+from uuid import uuid4
-
+
-import mplfinance as mpf
+import mplfinance as mpf
-import telegram
+from T_info import T_info
-from telegram import (
+
-    InlineQueryResultArticle,
+import telegram
-    InputTextMessageContent,
+from common.symbol_router import Router
-    LabeledPrice,
+from telegram import InlineQueryResultArticle, InputTextMessageContent, LabeledPrice, Update
-    Update,
+from telegram.ext import (
-)
+    Application,
-
+    CommandHandler,
-from telegram.ext import (
+    ContextTypes,
-    Application,
+    InlineQueryHandler,
-    CommandHandler,
+    MessageHandler,
-    InlineQueryHandler,
+    PreCheckoutQueryHandler,
-    PreCheckoutQueryHandler,
+    filters,
-    MessageHandler,
+)
-    filters,
+
-    ContextTypes,
+# Enable logging
-)
+logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
-
+
-from common.symbol_router import Router
+# set higher logging level for httpx to avoid all GET and POST requests being logged
-from T_info import T_info
+logging.getLogger("httpx").setLevel(logging.WARNING)
-
+
-# Enable logging
+log = logging.getLogger(__name__)
-logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
+
-
+TELEGRAM_TOKEN = os.environ["TELEGRAM"]
-# set higher logging level for httpx to avoid all GET and POST requests being logged
+
-logging.getLogger("httpx").setLevel(logging.WARNING)
+try:
-
+    STRIPE_TOKEN = os.environ["STRIPE"]
-log = logging.getLogger(__name__)
+except KeyError:
-
+    STRIPE_TOKEN = ""
-TELEGRAM_TOKEN = os.environ["TELEGRAM"]
+    log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
-
+
-try:
+s = Router()
-    STRIPE_TOKEN = os.environ["STRIPE"]
+t = T_info()
-except KeyError:
+
-    STRIPE_TOKEN = ""
+
-    log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
+log.info("Bot script started.")
-
+
-s = Router()
+
-t = T_info()
+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}")
-log.info("Bot script started.")
+    await update.message.reply_text(
-
+        text=t.help_text,
-
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-async def start(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        disable_notification=True,
-    """Send help text when the command /start is issued."""
+    )
-    log.info(f"Start command ran by {update.message.chat.username}")
+
-    await update.message.reply_text(
+
-        text=t.help_text,
+async def help(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    """Send help text when the command /help is issued."""
-        disable_notification=True,
+    log.info(f"Help command ran by {update.message.chat.username}")
-    )
+    await update.message.reply_text(
-
+        text=t.help_text,
-
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-async def help(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        disable_notification=True,
-    """Send help text when the command /help is issued."""
+    )
-    log.info(f"Help command ran by {update.message.chat.username}")
+
-    await update.message.reply_text(
+
-        text=t.help_text,
+async def license(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    """Send bots license when the /license command is issued."""
-        disable_notification=True,
+    log.info(f"License command ran by {update.message.chat.username}")
-    )
+    await update.message.reply_text(
-
+        text=t.license,
-
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-async def license(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        disable_notification=True,
-    """Send bots license when the /license command is issued."""
+    )
-    log.info(f"License command ran by {update.message.chat.username}")
+
-    await update.message.reply_text(
+
-        text=t.license,
+async def status(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    """Gather status of bot and dependant services and return important status updates."""
-        disable_notification=True,
+    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.")
-async def status(update: Update, context: ContextTypes.DEFAULT_TYPE):
+
-    """Gather status of bot and dependant services and return important status updates."""
+    await update.message.reply_text(
-    log.warning(f"Status command ran by {update.message.chat.username}")
+        text=bot_status,
-    bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-
+    )
-    bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.")
+
-
+
-    await update.message.reply_text(
+async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        text=bot_status,
+    """Sets up donation."""
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    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:
-async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        await update.message.reply_text(
-    """Sets up donation."""
+            text=t.donate_text,
-    log.info(f"Donate command ran by {update.message.chat.username}")
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-    chat_id = update.message.chat_id
+            disable_notification=True,
-
+        )
-    if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
+        amount = 1.0
-        await update.message.reply_text(
+    else:
-            text=t.donate_text,
+        amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+
-            disable_notification=True,
+    try:
-        )
+        price = int(amount * 100)
-        amount = 1.0
+    except ValueError:
-    else:
+        await update.message.reply_text(f"{amount} is not a valid donation amount or number.")
-        amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
+        return
-
+    log.info(f"Donation amount: {price} by {update.message.chat.username}")
-    try:
+
-        price = int(amount * 100)
+    await context.bot.send_invoice(
-    except ValueError:
+        chat_id=chat_id,
-        await update.message.reply_text(f"{amount} is not a valid donation amount or number.")
+        title="Simple Stock Bot Donation",
-        return
+        description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
-    log.info(f"Donation amount: {price} by {update.message.chat.username}")
+        payload=f"simple-stock-bot-{chat_id}",
-
+        provider_token=STRIPE_TOKEN,
-    await context.bot.send_invoice(
+        currency="USD",
-        chat_id=chat_id,
+        prices=[LabeledPrice("Donation:", price)],
-        title="Simple Stock Bot Donation",
+        start_parameter="",
-        description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
+        # suggested_tip_amounts=[100, 500, 1000, 2000],
-        payload=f"simple-stock-bot-{chat_id}",
+        photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
-        provider_token=STRIPE_TOKEN,
+        photo_width=500,
-        currency="USD",
+        photo_height=500,
-        prices=[LabeledPrice("Donation:", price)],
+    )
-        start_parameter="",
+
-        # suggested_tip_amounts=[100, 500, 1000, 2000],
+
-        photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
+async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        photo_width=500,
+    """Approves donation"""
-        photo_height=500,
+    log.info("precheckout_callback queried")
-    )
+    query = update.pre_checkout_query
-
+
-
+    await query.answer(ok=True)
-async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    # I dont think I need to check since its only donations.
-    """Approves donation"""
+    # if query.invoice_payload == "simple-stock-bot":
-    log.info("precheckout_callback queried")
+    #     # answer False pre_checkout_query
-    query = update.pre_checkout_query
+    #     await query.answer(ok=True)
-
+    # else:
-    await query.answer(ok=True)
+    #     await query.answer(ok=False, error_message="Something went wrong...")
-    # I dont think I need to check since its only donations.
+
-    # if query.invoice_payload == "simple-stock-bot":
+
-    #     # answer False pre_checkout_query
+async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    #     await query.answer(ok=True)
+    """Thanks user for donation"""
-    # else:
+    log.info("Successful payment!")
-    #     await query.answer(ok=False, error_message="Something went wrong...")
+    await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
-
+
-
+
-async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
+async def symbol_detect_image(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Thanks user for donation"""
+    """
-    log.info("Successful payment!")
+    Makes image captions into text then passes the `update` and `context`
-    await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
+        to symbol detect so that it can reply cashtags in image captions.
-
+    """
-
+    try:
-async def symbol_detect_image(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        if update.message.caption:
-    """
+            update.message.text = update.message.caption
-    Makes image captions into text then passes the `update` and `context`
+            await symbol_detect(update, context)
-        to symbol detect so that it can reply cashtags in image captions.
+    except AttributeError:
-    """
+        return
-    try:
+
-        if update.message.caption:
+
-            update.message.text = update.message.caption
+async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
-            await symbol_detect(update, context)
+    """
-    except AttributeError:
+    Runs on any message that doesn't have a command and searches for cashtags,
-        return
+        then returns the prices of any symbols found.
-
+    """
-
+    try:
-async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        message = update.message.text
-    """
+        chat_id = update.message.chat_id
-    Runs on any message that doesn't have a command and searches for cashtags,
+        if "$" in message:
-        then returns the prices of any symbols found.
+            log.info("Looking for Symbols")
-    """
+            symbols = s.find_symbols(message)
-    try:
+        else:
-        message = update.message.text
+            return
-        chat_id = update.message.chat_id
+    except AttributeError as ex:
-        if "$" in message:
+        log.info(ex)
-            symbols = s.find_symbols(message)
+        return
-            log.info("Looking for Symbols")
+
-        else:
+    # Detect Options
-            return
+    if ("call" in message.lower()) or ("put" in message.lower()):
-    except AttributeError as ex:
+        log.info("Options detected")
-        log.info(ex)
+        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-        return
+        try:
-    if symbols:
+            options_data = s.options(message, symbols)
-        # Let user know bot is working
+
-        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
+            await update.message.reply_text(
-        log.info(f"Symbols found: {symbols}")
+                text=generate_options_reply(options_data),
-
+                parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        for reply in s.price_reply(symbols):
+            )
-            await update.message.reply_text(
+            return
-                text=reply,
+        except KeyError as ex:
-                parse_mode=telegram.constants.ParseMode.MARKDOWN,
+            logging.warning(ex)
-                disable_notification=True,
+            pass
-            )
+
-
+    if symbols:
-
+        log.info(f"Symbols found: {symbols}")
-async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE):
+        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-    """returns a chart of intraday data for a symbol"""
+
-    log.info(f"Intra command ran by {update.message.chat.username}")
+        for reply in s.price_reply(symbols):
-
+            await update.message.reply_text(
-    message = update.message.text
+                text=reply,
-    chat_id = update.message.chat_id
+                parse_mode=telegram.constants.ParseMode.MARKDOWN,
-
+                disable_notification=True,
-    if message.strip().split("@")[0] == "/intra":
+            )
-        await update.message.reply_text(
+
-            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
+
-        )
+def generate_options_reply(options_data: dict):
-        return
+    # Header with Option Symbol and Underlying
-
+    message_text = f"*{options_data['Option Symbol']} ({options_data['Underlying']})*\n\n"
-    symbols = s.find_symbols(message, trending_weight=5)
+
-    symbol = symbols[0]
+    # Key details
-
+    details = (
-    if len(symbols):
+        f"*Expiration:* `{options_data['Expiration']}`\n"
-        symbol = symbols[0]
+        f"*Side:* `{options_data['side']}`\n"
-    else:
+        f"*Strike:* `{options_data['strike']}`\n"
-        await update.message.reply_text("No symbols or coins found.")
+        f"*First Traded:* `{options_data['First Traded']}`\n"
-        return
+        f"*Last Updated:* `{options_data['Last Updated']}`\n\n"
-
+    )
-    df = s.intra_reply(symbol)
+    message_text += details
-    if df.empty:
+
-        await update.message.reply_text(
+    # Pricing info
-            text="Invalid symbol please see `/help` for usage details.",
+    pricing_info = (
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        f"*Bid:* `{options_data['bid']}` (Size: `{options_data['bidSize']}`)\n"
-            disable_notification=True,
+        f"*Mid:* `{options_data['mid']}`\n"
-        )
+        f"*Ask:* `{options_data['ask']}` (Size: `{options_data['askSize']}`)\n"
-        return
+        f"*Last:* `{options_data['last']}`\n\n"
-
+    )
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
+    message_text += pricing_info
-
+
-    buf = io.BytesIO()
+    # Volume and open interest
-    mpf.plot(
+    volume_info = f"*Open Interest:* `{options_data['Open Interest']}`\n*Volume:* `{options_data['Volume']}`\n\n"
-        df,
+    message_text += volume_info
-        type="renko",
+
-        title=f"\n{symbol.name}",
+    # Greeks
-        volume="Volume" in df.keys(),
+    greeks_info = (
-        style="yahoo",
+        f"*IV:* `{options_data['Implied Volatility']}`\n"
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+        f"*Delta:* `{options_data['delta']}`\n"
-    )
+        f"*Gamma:* `{options_data['gamma']}`\n"
-    buf.seek(0)
+        f"*Theta:* `{options_data['theta']}`\n"
-
+        f"*Vega:* `{options_data['vega']}`\n"
-    await update.message.reply_photo(
+        f"*Rho:* `{options_data['rho']}`\n"
-        photo=buf,
+    )
-        caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+    message_text += greeks_info
-        + f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
+
-        + f"\n\n{s.price_reply([symbol])[0]}",
+    return message_text
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+
-        disable_notification=True,
+
-    )
+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}")
-async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE):
+
-    """returns a chart of the past month of data for a symbol"""
+    message = update.message.text
-    log.info(f"Chart command ran by {update.message.chat.username}")
+    chat_id = update.message.chat_id
-
+
-    message = update.message.text
+    if message.strip().split("@")[0] == "/intra":
-    chat_id = update.message.chat_id
+        await update.message.reply_text(
-
+            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
-    if message.strip().split("@")[0] == "/chart":
+        )
-        await update.message.reply_text(
+        return
-            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
+
-        )
+    symbols = s.find_symbols(message, trending_weight=5)
-        return
+    symbol = symbols[0]
-
+
-    symbols = s.find_symbols(message, trending_weight=10)
+    if len(symbols):
-
+        symbol = symbols[0]
-    if len(symbols):
+    else:
-        symbol = symbols[0]
+        await update.message.reply_text("No symbols or coins found.")
-    else:
+        return
-        await update.message.reply_text("No symbols or coins found.")
+
-        return
+    df = s.intra_reply(symbol)
-
+    if df.empty:
-    df = s.chart_reply(symbol)
+        await update.message.reply_text(
-    if df.empty:
+            text="Invalid symbol please see `/help` for usage details.",
-        await update.message.reply_text(
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            text="Invalid symbol please see `/help` for usage details.",
+            disable_notification=True,
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        )
-            disable_notification=True,
+        return
-        )
+
-        return
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
+
-
+    buf = io.BytesIO()
-    buf = io.BytesIO()
+    mpf.plot(
-    mpf.plot(
+        df,
-        df,
+        type="renko",
-        type="candle",
+        title=f"\n{symbol.name}",
-        title=f"\n{symbol.name}",
+        volume="Volume" in df.keys(),
-        volume="Volume" in df.keys(),
+        style="yahoo",
-        style="yahoo",
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+    )
-    )
+    buf.seek(0)
-    buf.seek(0)
+
-
+    await update.message.reply_photo(
-    await update.message.reply_photo(
+        photo=buf,
-        photo=buf,
+        caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
-        caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+        + f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
-        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
+        + f"\n\n{s.price_reply([symbol])[0]}",
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
+        disable_notification=True,
-    )
+    )
-
+
-
+
-async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE):
+async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """returns currently trending symbols and how much they've moved in the past trading day."""
+    """returns a chart of the past month of data for a symbol"""
-    log.info(f"Trending command ran by {update.message.chat.username}")
+    log.info(f"Chart command ran by {update.message.chat.username}")
-
+
-    chat_id = update.message.chat_id
+    message = update.message.text
-
+    chat_id = update.message.chat_id
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
+
-
+    if message.strip().split("@")[0] == "/chart":
-    trending_list = s.trending()
+        await update.message.reply_text(
-
+            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
-    await update.message.reply_text(
+        )
-        text=trending_list,
+        return
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+
-        disable_notification=True,
+    symbols = s.find_symbols(message, trending_weight=10)
-    )
+
-
+    if len(symbols):
-
+        symbol = symbols[0]
-async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    else:
-    """
+        await update.message.reply_text("No symbols or coins found.")
-    Handles inline query. Searches by looking if query is contained
+        return
-        in the symbol and returns matches in alphabetical order.
+
-    """
+    df = s.chart_reply(symbol)
-
+    if df.empty:
-    if not update.inline_query.query:
+        await update.message.reply_text(
-        return
+            text="Invalid symbol please see `/help` for usage details.",
-
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-    print(f"Query: {update.inline_query.query}")
+            disable_notification=True,
-
+        )
-    ignored_queries = {"$", "$$", " ", ""}
+        return
-
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
-    if update.inline_query.query.strip() in ignored_queries:
+
-        default_message = """
+    buf = io.BytesIO()
-        You can type:\n@SimpleStockBot `[search]`
+    mpf.plot(
-        in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
+        df,
-        """
+        type="candle",
-
+        title=f"\n{symbol.name}",
-        await update.inline_query.answer(
+        volume="Volume" in df.keys(),
-            [
+        style="yahoo",
-                InlineQueryResultArticle(
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-                    str(uuid4()),
+    )
-                    title="Please enter a query. It can be a ticker or a name of a company.",
+    buf.seek(0)
-                    input_message_content=InputTextMessageContent(
+
-                        default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
+    await update.message.reply_photo(
-                    ),
+        photo=buf,
-                )
+        caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
-            ]
+        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
-        )
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-
+        disable_notification=True,
-    matches = s.inline_search(update.inline_query.query)
+    )
-
+
-    results = []
+
-    for _, row in matches.iterrows():
+async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE):
-        results.append(
+    """returns currently trending symbols and how much they've moved in the past trading day."""
-            InlineQueryResultArticle(
+    log.info(f"Trending command ran by {update.message.chat.username}")
-                str(uuid4()),
+
-                title=row["description"],
+    chat_id = update.message.chat_id
-                input_message_content=InputTextMessageContent(
+
-                    row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-                ),
+
-            )
+    trending_list = s.trending()
-        )
+
-
+    await update.message.reply_text(
-        if len(results) == 5:
+        text=trending_list,
-            await update.inline_query.answer(results, cache_time=60 * 60)
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            log.info("Inline Command was successful")
+        disable_notification=True,
-            return
+    )
-    await update.inline_query.answer(results)
+
-
+
-
+async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
-async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """
-    """For the gamblers. Returns a random symbol to buy and a sell date"""
+    Handles inline query. Searches by looking if query is contained
-    log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}")
+        in the symbol and returns matches in alphabetical order.
-
+    """
-    await update.message.reply_text(
+
-        text=s.random_pick(),
+    if not update.inline_query.query:
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        return
-        disable_notification=True,
+
-    )
+    print(f"Query: {update.inline_query.query}")
-
+
-
+    ignored_queries = {"$", "$$", " ", ""}
-async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
+
-    """Log Errors caused by Updates."""
+    if update.inline_query.query.strip() in ignored_queries:
-    log.warning('Update "%s" caused error "%s"', update, error)
+        default_message = """
-
+        You can type:\n@SimpleStockBot `[search]`
-    tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
+        in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
-    tb_string = "".join(tb_list)
+        """
-
+
-    err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
+        await update.inline_query.answer(
-    log.warning(f"Logging error: {err_code}")
+            [
-
+                InlineQueryResultArticle(
-    if update:
+                    str(uuid4()),
-        log.warning(
+                    title="Please enter a query. It can be a ticker or a name of a company.",
-            f"An exception was raised while handling an update\n"
+                    input_message_content=InputTextMessageContent(
-            f"\tupdate = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}\n"
+                        default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
-            f"\tcontext.chat_data = {str(context.chat_data)}\n"
+                    ),
-            f"\tcontext.user_data = {str(context.user_data)}\n"
+                )
-            f"\t{html.escape(tb_string)}"
+            ]
-        )
+        )
-
+
-        await update.message.reply_text(
+    matches = s.inline_search(update.inline_query.query)
-            text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
+
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    results = []
-        )
+    for _, row in matches.iterrows():
-    else:
+        results.append(
-        log.warning("No message to send to user.")
+            InlineQueryResultArticle(
-        log.warning(tb_string)
+                str(uuid4()),
-
+                title=row["description"],
-
+                input_message_content=InputTextMessageContent(
-def main():
+                    row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
-    """Start the context.bot."""
+                ),
-    # Create the EventHandler and pass it your bot's token.
+            )
-    application = Application.builder().token(TELEGRAM_TOKEN).build()
+        )
-
+
-    # on different commands - answer in Telegram
+        if len(results) == 5:
-    application.add_handler(CommandHandler("start", start))
+            await update.inline_query.answer(results, cache_time=60 * 60)
-    application.add_handler(CommandHandler("help", help))
+            log.info("Inline Command was successful")
-    application.add_handler(CommandHandler("license", license))
+            return
-    application.add_handler(CommandHandler("trending", trending))
+    await update.inline_query.answer(results)
-    application.add_handler(CommandHandler("random", rand_pick))
+
-    application.add_handler(CommandHandler("donate", donate))
+
-    application.add_handler(CommandHandler("status", status))
+async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    application.add_handler(CommandHandler("inline", inline_query))
+    """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}")
-    # Charting can be slow so they run async.
+
-    application.add_handler(CommandHandler("intra", intra, block=False))
+    await update.message.reply_text(
-    application.add_handler(CommandHandler("intraday", intra, block=False))
+        text=s.random_pick(),
-    application.add_handler(CommandHandler("day", intra, block=False))
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-    application.add_handler(CommandHandler("chart", chart, block=False))
+        disable_notification=True,
-    application.add_handler(CommandHandler("month", chart, block=False))
+    )
-
+
-    # on noncommand i.e message - echo the message on Telegram
+
-    application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
+async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
+    """Log Errors caused by Updates."""
-
+    log.warning('Update "%s" caused error "%s"', update, error)
-    # Inline Bot commands
+
-    application.add_handler(InlineQueryHandler(inline_query))
+    tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
-
+    tb_string = "".join(tb_list)
-    # Pre-checkout handler to final check
+
-    application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
+    err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
-
+    log.warning(f"Logging error: {err_code}")
-    # Payment success
+
-    application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
+    if update:
-
+        log.warning(
-    # log all errors
+            f"An exception was raised while handling an update\n"
-    application.add_error_handler(error)
+            f"\tupdate = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}\n"
-
+            f"\tcontext.chat_data = {str(context.chat_data)}\n"
-    # Start the Bot
+            f"\tcontext.user_data = {str(context.user_data)}\n"
-    application.run_polling(allowed_updates=Update.ALL_TYPES)
+            f"\t{html.escape(tb_string)}"
-
+        )
-
+
-if __name__ == "__main__":
+        await update.message.reply_text(
-    main()
+            text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        )
+    else:
+        log.warning("No message to send to user.")
+        log.warning(tb_string)
+
+
+def main():
+    """Start the context.bot."""
+    # Create the EventHandler and pass it your bot's token.
+    application = Application.builder().token(TELEGRAM_TOKEN).build()
+
+    # on different commands - answer in Telegram
+    application.add_handler(CommandHandler("start", start))
+    application.add_handler(CommandHandler("help", help))
+    application.add_handler(CommandHandler("license", license))
+    application.add_handler(CommandHandler("trending", trending))
+    application.add_handler(CommandHandler("random", rand_pick))
+    application.add_handler(CommandHandler("donate", donate))
+    application.add_handler(CommandHandler("status", status))
+    application.add_handler(CommandHandler("inline", inline_query))
+
+    # Charting can be slow so they run async.
+    application.add_handler(CommandHandler("intra", intra, block=False))
+    application.add_handler(CommandHandler("intraday", intra, block=False))
+    application.add_handler(CommandHandler("day", intra, block=False))
+    application.add_handler(CommandHandler("chart", chart, block=False))
+    application.add_handler(CommandHandler("month", chart, block=False))
+
+    # on noncommand i.e message - echo the message on Telegram
+    application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
+    application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
+
+    # Inline Bot commands
+    application.add_handler(InlineQueryHandler(inline_query))
+
+    # Pre-checkout handler to final check
+    application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
+
+    # Payment success
+    application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
+
+    # log all errors
+    application.add_error_handler(error)
+
+    # Start the Bot
+    application.run_polling(allowed_updates=Update.ALL_TYPES)
+
+
+if __name__ == "__main__":
+    main()

telegram/telegram-reqs.txt

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

tests.py

@@ -1,33 +1,21 @@
-import keyboard
+import time
-import time
+
-
+import keyboard
-
+
-tests = """$$xno
+tests = """$$xno
-/info $tsla
+$tsla
-/info $$btc
+/intra $tsla
-/news $tsla
+/intra $$btc
-/news $$btc
+/chart $tsla
-/stat $tsla
+/chart $$btc
-/stat $$btc
+/help
-/cap $tsla
+/trending""".split("\n")
-/cap $$btc
+
-/dividend $tsla
+print("press enter to start")
-/dividend $msft
+keyboard.wait("enter")
-/dividend $$btc
+
-/intra $tsla
+for test in tests:
-/intra $$btc
+    print(test)
-/chart $tsla
+    keyboard.write(test)
-/chart $$btc
+    time.sleep(1)
-/help
+    keyboard.press_and_release("enter")
-/trending""".split(
-    "\n"
-)
-
-print("press enter to start")
-keyboard.wait("enter")
-
-for test in tests:
-    print(test)
-    keyboard.write(test)
-    time.sleep(1)
-    keyboard.press_and_release("enter")

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)