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.

.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
+node_modules

.gitlab-ci.yml

@@ -1,21 +1,23 @@
 stages:
   - lint
+  - build_site
   - deploy
 
-black:
-  stage: lint
-  image: registry.gitlab.com/pipeline-components/black:latest
-  script:
-    - black --check --verbose -- .
-
 ruff:
   stage: lint
-  # image: registry.gitlab.com/pipeline-components/ruff:latest
+  image: python:3.12-slim
-  image: python:3.11-slim
   script:
-    - pip3 install ruff
+    - pip3 install ruff==0.15.2
-    - ruff --output-format gitlab .
+    - ruff check . --output-format gitlab
+    - ruff format . --check
+  allow_failure: false
 
+# prettier:
+#   stage: lint
+#   image: node:16-slim # Use Node.js image since prettier is a Node.js tool
+#   script:
+#     - npm install prettier
+#     - npx prettier --check . # Adjust the path as needed
 
 include:
-  - local: /docs/.gitlab-ci.yml
+  - 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,13 +1,16 @@
 import datetime as dt
 import logging
 import os
+from collections import OrderedDict
 from typing import Dict
 
+import humanize
 import pandas as pd
 import pytz
 import requests as r
 import schedule
 
+
 from common.Symbol import Stock
 
 log = logging.getLogger(__name__)
@@ -20,6 +23,7 @@ class MarketData:
 
     SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
 
+    symbol_list: Dict[str, Dict] = {}
     charts: Dict[Stock, pd.DataFrame] = {}
 
     openTime = dt.time(hour=9, minute=30, second=0)
@@ -48,9 +52,15 @@ class MarketData:
         if self.MARKETDATA_TOKEN != "":
             schedule.every().day.do(self.clear_charts)
 
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+        self.get_symbol_list()
+        schedule.every().day.do(self.get_symbol_list)
+
+    def get(self, endpoint, params=None, timeout=10, headers=None) -> dict:
         url = "https://api.marketdata.app/v1/" + endpoint
 
+        if params is None:
+            params = {}
+
         # set token param if it wasn't passed.
         params["token"] = self.MARKETDATA_TOKEN
 
@@ -58,7 +68,13 @@ class MarketData:
         # monitored even if someone doesn't make it through an affiliate link.
         params["application"] = "simplestockbot"
 
-        resp = r.get(url, params=params, timeout=timeout)
+        if headers is None:
+            headers = {}
+        headers = {"User-Agent": "Simple Stock Bot anson@ansonbiggs.com"} | headers
+
+        resp = r.get(url, params=params, timeout=timeout, headers=headers)
+
+        logging.debug(resp.headers.items())
 
         # Make sure API returned a proper status code
         try:
@@ -85,6 +101,29 @@ class MarketData:
 
         return {}
 
+    def symbol_id(self, symbol: str) -> Dict[str, Dict]:
+        return self.symbol_list.get(symbol.upper(), None)
+
+    def get_symbol_list(self):
+        # Doesn't use `self.get()` since needs are much different
+        sec_resp = r.get(
+            "https://www.sec.gov/files/company_tickers.json",
+            headers={
+                "User-Agent": "Simple Stock Bot anson@ansonbiggs.com",
+                "Accept-Encoding": "gzip, deflate",
+                "Host": "www.sec.gov",
+            },
+        )
+        sec_resp.raise_for_status()
+        sec_data = sec_resp.json()
+
+        for rank, ticker_info in sec_data.items():
+            self.symbol_list[ticker_info["ticker"]] = {
+                "ticker": ticker_info["ticker"],
+                "title": ticker_info["title"],
+                "mkt_cap_rank": rank,
+            }
+
     def clear_charts(self) -> None:
         """
         Clears cache of chart data.
@@ -94,27 +133,21 @@ class MarketData:
         self.charts = {}
 
     def status(self) -> str:
-        # TODO: At the moment this API is poorly documented, this function likely needs to be revisited later.
+        """Check MarketData.app API status by making a test request."""
-
         try:
+            # Test the API with a simple request
             status = r.get(
-                "https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A",
+                "https://api.marketdata.app/v1/stocks/quotes/AAPL/",
                 timeout=5,
             )
             status.raise_for_status()
+            return f"MarketData.app API is responding OK with status {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
         except r.HTTPError:
-            return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
+            return f"MarketData.app API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds():.2f} seconds."
         except r.Timeout:
-            return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
+            return "MarketData.app API timed out before it could respond. This is likely due to a surge in usage or a complete outage."
-
+        except Exception as e:
-        statusJSON = status.json()
+            return f"MarketData.app API check failed: {str(e)}"
-
-        if statusJSON["status"] == "ok":
-            return (
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
-            )
-        else:
-            return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
 
     def price_reply(self, symbol: Stock) -> str:
         """Returns price movement of Stock for the last market day, or after hours.
@@ -129,13 +162,13 @@ class MarketData:
             Formatted markdown
         """
 
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
+        if quoteResp := self.get(f"stocks/quotes/{symbol.symbol}/"):
             price = round(quoteResp["last"][0], 2)
 
             try:
                 changePercent = round(quoteResp["changepct"][0], 2)
             except TypeError:
-                return f"The price of {symbol} is {price}"
+                return f"The price of {symbol.name} is ${price}"
 
             message = f"The current price of {symbol.name} is ${price} and "
 
@@ -191,7 +224,11 @@ class MarketData:
 
         if data := self.get(
             f"stocks/candles/{resolution}/{symbol}",
-            params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
+            params={
+                "from": startTime.timestamp(),
+                "to": now.timestamp(),
+                "extended": True,
+            },
         ):
             data.pop("s")
             df = pd.DataFrame(data)
@@ -267,3 +304,58 @@ class MarketData:
             return df
 
         return pd.DataFrame()
+
+    def options_reply(self, request: str) -> str:
+        """Undocumented API Usage!"""
+
+        options_data = self.get(f"options/quotes/{request}")
+
+        for key in options_data.keys():
+            options_data[key] = options_data[key][0]
+
+        options_data["underlying"] = "$" + options_data["underlying"]
+
+        options_data["updated"] = humanize.naturaltime(dt.datetime.now() - dt.datetime.fromtimestamp(options_data["updated"]))
+
+        options_data["expiration"] = humanize.naturaltime(
+            dt.datetime.now() - dt.datetime.fromtimestamp(options_data["expiration"])
+        )
+
+        options_data["firstTraded"] = humanize.naturaltime(
+            dt.datetime.now() - dt.datetime.fromtimestamp(options_data["firstTraded"])
+        )
+
+        rename = {
+            "optionSymbol": "Option Symbol",
+            "underlying": "Underlying",
+            "expiration": "Expiration",
+            "side": "side",
+            "strike": "strike",
+            "firstTraded": "First Traded",
+            "updated": "Last Updated",
+            "bid": "bid",
+            "bidSize": "bidSize",
+            "mid": "mid",
+            "ask": "ask",
+            "askSize": "askSize",
+            "last": "last",
+            "openInterest": "Open Interest",
+            "volume": "Volume",
+            "inTheMoney": "inTheMoney",
+            "intrinsicValue": "Intrinsic Value",
+            "extrinsicValue": "Extrinsic Value",
+            "underlyingPrice": "Underlying Price",
+            "iv": "Implied Volatility",
+            "delta": "delta",
+            "gamma": "gamma",
+            "theta": "theta",
+            "vega": "vega",
+            "rho": "rho",
+        }
+
+        options_cleaned = OrderedDict()
+        for old, new in rename.items():
+            if old in options_data:
+                options_cleaned[new] = options_data[old]
+
+        return options_cleaned

common/Symbol.py

@@ -1,6 +1,7 @@
-import pandas as pd
 import logging
 
+import pandas as pd
+
 
 class Symbol:
     """
@@ -25,15 +26,19 @@ class Symbol:
     def __str__(self) -> str:
         return self.id
 
+    def __hash__(self):
+        return hash(self.id)
+
 
 class Stock(Symbol):
     """Stock Market Object. Gets data from MarketData"""
 
-    def __init__(self, symbol: str) -> None:
+    def __init__(self, symbol_info: dict) -> None:
-        self.symbol = symbol
+        self.symbol = symbol_info["ticker"]
-        self.id = symbol
+        self.id = symbol_info["ticker"]
-        self.name = "$" + symbol.upper()
+        self.name = symbol_info["title"]
-        self.tag = "$" + symbol.lower()
+        self.tag = "$" + symbol_info["ticker"]
+        self.market_cap_rank = symbol_info["mkt_cap_rank"]
 
 
 class Coin(Symbol):

common/cg_Crypto.py

@@ -5,8 +5,10 @@ import pandas as pd
 import requests as r
 import schedule
 from markdownify import markdownify
-
 from common.Symbol import Coin
+from common.utilities import rate_limited
+
+import time
 
 log = logging.getLogger(__name__)
 
@@ -24,10 +26,30 @@ class cg_Crypto:
         self.get_symbol_list()
         schedule.every().day.do(self.get_symbol_list)
 
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+    # Coingecko's rate limit is 30 requests per minute.
+    # Since there are two bots sharing the same IP, we allocate half of that limit to each bot.
+    # This results in a rate limit of 15 requests per minute for each bot.
+    # Given this, the rate limit effectively becomes 1 request every 4 seconds for each bot.
+    @rate_limited(0.25)
+    def get(self, endpoint, params: dict = {}, timeout=10, retry_count=0, max_retries=3) -> dict:
         url = "https://api.coingecko.com/api/v3" + endpoint
         resp = r.get(url, params=params, timeout=timeout)
         # Make sure API returned a proper status code
+
+        if resp.status_code == 429:
+            if retry_count >= max_retries:
+                log.error(f"CoinGecko 429 retry limit ({max_retries}) exceeded for endpoint: {endpoint}")
+                return {}
+
+            backoff_time = (2**retry_count) * 10  # Exponential backoff: 10s, 20s, 40s
+            log.warning(
+                f"CoinGecko returned 429 - Too Many Requests for endpoint: {endpoint}. Retry {retry_count + 1}/{max_retries} after {backoff_time}s."
+            )
+            time.sleep(backoff_time)
+            return self.get(
+                endpoint=endpoint, params=params, timeout=timeout, retry_count=retry_count + 1, max_retries=max_retries
+            )
+
         try:
             resp.raise_for_status()
         except r.exceptions.HTTPError as e:
@@ -201,14 +223,14 @@ class cg_Crypto:
             },
         ):
             return f"""
-                [{data['name']}]({data['links']['homepage'][0]}) Statistics:
+                [{data["name"]}]({data["links"]["homepage"][0]}) Statistics:
-                Market Cap: ${data['market_data']['market_cap'][self.vs_currency]:,}
+                Market Cap: ${data["market_data"]["market_cap"][self.vs_currency]:,}
-                Market Cap Ranking: {data.get('market_cap_rank',"Not Available")}
+                Market Cap Ranking: {data.get("market_cap_rank", "Not Available")}
                 CoinGecko Scores:
-                    Overall: {data.get('coingecko_score','Not Available')}
+                    Overall: {data.get("coingecko_score", "Not Available")}
-                    Development: {data.get('developer_score','Not Available')}
+                    Development: {data.get("developer_score", "Not Available")}
-                    Community: {data.get('community_score','Not Available')}
+                    Community: {data.get("community_score", "Not Available")}
-                    Public Interest: {data.get('public_interest_score','Not Available')}
+                    Public Interest: {data.get("public_interest_score", "Not Available")}
                     """
         else:
             return f"{symbol.symbol} returned an error."
@@ -248,7 +270,7 @@ class cg_Crypto:
 
             message = (
                 f"The current price of {coin.name} is $**{price:,}** and"
-                + " its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
+                + f" its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
             )
 
         else:
@@ -361,7 +383,7 @@ class cg_Crypto:
                     p["usd_24h_change"] = 0
 
                 replies.append(
-                    f"{coin.name}: ${p.get('usd',0):,} and has moved {p.get('usd_24h_change',0.0):.2f}% in the past 24 hours."
+                    f"{coin.name}: ${p.get('usd', 0):,} and has moved {p.get('usd_24h_change', 0.0):.2f}% in the past 24 hours."
                 )
 
         return replies

common/requirements.txt

@@ -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,10 +1,10 @@
-"""Function that routes symbols to the correct API provider.
+"""Function that routes symbols to the correct API provider."""
-"""
 
 import datetime
 import logging
 import random
 import re
+from typing import Dict
 
 import pandas as pd
 import schedule
@@ -14,8 +14,6 @@ from common.cg_Crypto import cg_Crypto
 from common.MarketData import MarketData
 from common.Symbol import Coin, Stock, Symbol
 
-from typing import Dict
-
 log = logging.getLogger(__name__)
 
 
@@ -38,7 +36,7 @@ class Router:
             t_copy = self.trending_count.copy()
             for key in t_copy.keys():
                 if t_copy[key] < 0.01:
-                    # This just makes sure were not keeping around keys that havent been called in a very long time.
+                    # Prune Keys
                     dead_keys.append(key)
                 else:
                     t_copy[key] = t_copy[key] * decay
@@ -48,7 +46,7 @@ class Router:
         self.trending_count = t_copy.copy()
         log.info("Decayed trending symbols.")
 
-    def find_symbols(self, text: str, *, trending_weight: int = 1) -> list[Stock | Symbol]:
+    def find_symbols(self, text: str, *, trending_weight: int = 1) -> list[Stock | Coin]:
         """Finds stock tickers starting with a dollar sign, and cryptocurrencies with two dollar signs
         in a blob of text and returns them in a list.
 
@@ -65,16 +63,20 @@ class Router:
         schedule.run_pending()
 
         symbols: list[Symbol] = []
-        stocks = set(re.findall(self.STOCK_REGEX, text))
+        stock_matches = set(re.findall(self.STOCK_REGEX, text))
-        for stock in stocks:
+        coin_matches = set(re.findall(self.CRYPTO_REGEX, text))
-            # Market data lacks tools to check if a symbol is valid.
-            symbols.append(Stock(stock))
 
-        coins = set(re.findall(self.CRYPTO_REGEX, text))
+        for stock_match in stock_matches:
-        for coin in coins:
+            # Market data lacks tools to check if a symbol is valid.
-            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin.lower(), case=False)]
+            if stock_info := self.stock.symbol_id(stock_match):
+                symbols.append(Stock(stock_info))
+            else:
+                log.info(f"{stock_match} is not in list of stocks")
+
+        for coin_match in coin_matches:
+            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin_match.lower(), case=False)]
             if sym.empty:
-                log.info(f"{coin} is not in list of coins")
+                log.info(f"{coin_match} is not in list of coins")
             else:
                 symbols.append(Coin(sym))
         if symbols:
@@ -393,3 +395,12 @@ class Router:
             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 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
 mypy==1.5.1
 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,5 +1,4 @@
-"""Functions and Info specific to the discord Bot
+"""Functions and Info specific to the discord Bot"""
-"""
 
 import re
 
@@ -10,7 +9,7 @@ class D_info:
     license = re.sub(
         r"\b\n",
         " ",
-        r.get("https://gitlab.com/simple-stock-bots/simple-discord-stock-bot/-/raw/master/LICENSE").text,
+        r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text,
     )
 
     help_text = """
@@ -21,7 +20,7 @@ For stock data or hosting your own bot, use my link. This helps keep the bot fre
 
 **Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
 
-**Documentation**: All details about the bot are at [docs](https://docs.simplestockbot.com).
+**Documentation**: All details about the bot are at [docs](https://simplestockbot.com).
 
 The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
 - `/chart $$eth` gives Ethereum's monthly chart.
@@ -41,7 +40,7 @@ Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. No
 
 Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
 
-Issues with the bot? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
+Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact).
     """
 
     donate_text = """
@@ -55,5 +54,5 @@ Every donation supports server costs and
 2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
     - It's quick, doesn't need an account, and accepts Paypal or Credit card.
 
-Questions? Visit our [website](https://docs.simplestockbot.com).
+Questions? Visit our [website](https://simplestockbot.com).
 """

discord/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.11-buster AS builder
+FROM python:3.12-bookworm AS builder
 
 
 COPY discord/discord-reqs.txt .
@@ -7,7 +7,7 @@ COPY common/requirements.txt .
 RUN pip install --user -r discord-reqs.txt
 
 
-FROM python:3.11-slim
+FROM python:3.12-slim
 
 ENV MPLBACKEND=Agg
 

discord/bot.py

@@ -5,9 +5,9 @@ import os
 
 import mplfinance as mpf
 import nextcord
+from D_info import D_info
 from nextcord.ext import commands
 
-from D_info import D_info
 from common.symbol_router import Router
 
 DISCORD_TOKEN = os.environ["DISCORD"]
@@ -38,11 +38,11 @@ async def on_ready():
 @bot.command()
 async def status(ctx: commands):
     """Debug command for diagnosing if the bot is experiencing any issues."""
-    logging.warning(f"Status command ran by {ctx.message.author}")
+    logging.info(f"Status command ran by {ctx.message.author}")
     message = ""
     try:
         message = "Contact MisterBiggs#0465 if you need help.\n"
-        message += s.status(f"Bot recieved your message in: {bot.latency*10:.4f} seconds") + "\n"
+        message += s.status(f"Bot recieved your message in: {bot.latency * 10:.4f} seconds") + "\n"
 
     except Exception as ex:
         logging.critical(ex)
@@ -183,20 +183,72 @@ async def trending(ctx: commands):
 
 @bot.event
 async def on_message(message):
+    # Ignore messages from the bot itself
     if message.author.id == bot.user.id:
         return
-    if message.content:
-        if message.content[0] == "/":
-            await bot.process_commands(message)
-            return
 
-        if "$" in message.content:
+    content_lower = message.content.lower()
-            symbols = s.find_symbols(message.content)
 
-            if symbols:
+    # Process commands starting with "/"
-                for reply in s.price_reply(symbols):
+    if message.content.startswith("/"):
-                    await message.channel.send(reply)
+        await bot.process_commands(message)
-                return
+        return
+
+    symbols = None
+    if "$" in message.content:
+        symbols = s.find_symbols(message.content)
+
+    if "call" in content_lower or "put" in content_lower:
+        await handle_options(message, symbols)
+        return
+
+    if symbols:
+        for reply in s.price_reply(symbols):
+            await message.channel.send(reply)
+        return
+
+
+async def handle_options(message, symbols):
+    logging.info("Options detected")
+    try:
+        options_data = s.options(message.content.lower(), symbols)
+
+        # Create the embed directly within the function
+        embed = nextcord.Embed(title=options_data["Option Symbol"], description=options_data["Underlying"], color=0x3498DB)
+
+        # Key details
+        details = f"Expiration: {options_data['Expiration']}\nSide: {options_data['side']}\nStrike: {options_data['strike']}"
+        embed.add_field(name="Details", value=details, inline=False)
+
+        # Pricing info
+        pricing_info = (
+            f"Bid: {options_data['bid']} (Size: {options_data['bidSize']})\n"
+            f"Mid: {options_data['mid']}\n"
+            f"Ask: {options_data['ask']} (Size: {options_data['askSize']})\n"
+            f"Last: {options_data['last']}"
+        )
+        embed.add_field(name="Pricing", value=pricing_info, inline=False)
+
+        # Volume and open interest
+        volume_info = f"Open Interest: {options_data['Open Interest']}\nVolume: {options_data['Volume']}"
+        embed.add_field(name="Activity", value=volume_info, inline=False)
+
+        # Greeks
+        greeks_info = (
+            f"IV: {options_data['Implied Volatility']}\n"
+            f"Delta: {options_data['delta']}\n"
+            f"Gamma: {options_data['gamma']}\n"
+            f"Theta: {options_data['theta']}\n"
+            f"Vega: {options_data['vega']}\n"
+            f"Rho: {options_data['rho']}"
+        )
+        embed.add_field(name="Greeks", value=greeks_info, inline=False)
+
+        # Send the created embed
+        await message.channel.send(embed=embed)
+
+    except KeyError as ex:
+        logging.warning(f"KeyError processing options for message {message.content}: {ex}")
 
 
 bot.run(DISCORD_TOKEN)

discord/discord-reqs.txt

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

docker-compose.yaml

@@ -1,10 +1,9 @@
-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:

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,6 +28,12 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
     </div>
 </div>
 
+## Options Detection :bank:
+
+This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
+
+![Image of the telegram bot providing options info.](img/telegram_options.png)
+
 ## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
 
 The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
@@ -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,4 +1,4 @@
-FROM python:3.11-buster AS builder
+FROM python:3.12-bookworm AS builder
 
 
 COPY telegram/telegram-reqs.txt .
@@ -7,7 +7,7 @@ COPY common/requirements.txt .
 RUN pip install --user -r telegram-reqs.txt
 
 
-FROM python:3.11-slim
+FROM python:3.12-slim
 
 ENV MPLBACKEND=Agg
 

telegram/T_info.py

@@ -1,5 +1,4 @@
-"""Functions and Info specific to the Telegram Bot
+"""Functions and Info specific to the Telegram Bot"""
-"""
 
 import re
 
@@ -10,7 +9,7 @@ class T_info:
     license = re.sub(
         r"\b\n",
         " ",
-        r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
+        r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text,
     )
 
     help_text = """
@@ -21,7 +20,7 @@ Want stock data or to host your own bot? Help keep this bot free by using my
 
 📢 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://docs.simplestockbot.com).
+**Guide**: All about using and setting up the bot is in the [docs](https://simplestockbot.com).
 
 The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
 - `/chart $$eth` gets a month's Ethereum chart.
@@ -43,7 +42,7 @@ Pick a ticker, and the bot shares the current price in chat. Note: Prices can la
 
 Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
 
-Bot issues? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
+Bot issues? Use `/status` or [contact us](https://simplestockbot.com/contact).
 
     """
 
@@ -56,7 +55,7 @@ All funds help maintain servers, with data from
 1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
 2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
 
-For questions, visit our [website](https://docs.simplestockbot.com).
+For questions, visit our [website](https://simplestockbot.com).
 """
 
 

telegram/bot.py

@@ -11,27 +11,21 @@ import traceback
 from uuid import uuid4
 
 import mplfinance as mpf
-import telegram
+from T_info import T_info
-from telegram import (
-    InlineQueryResultArticle,
-    InputTextMessageContent,
-    LabeledPrice,
-    Update,
-)
 
+import telegram
+from common.symbol_router import Router
+from telegram import InlineQueryResultArticle, InputTextMessageContent, LabeledPrice, Update
 from telegram.ext import (
     Application,
     CommandHandler,
-    InlineQueryHandler,
-    PreCheckoutQueryHandler,
-    MessageHandler,
-    filters,
     ContextTypes,
+    InlineQueryHandler,
+    MessageHandler,
+    PreCheckoutQueryHandler,
+    filters,
 )
 
-from common.symbol_router import Router
-from T_info import T_info
-
 # Enable logging
 logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
 
@@ -178,17 +172,33 @@ async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
         message = update.message.text
         chat_id = update.message.chat_id
         if "$" in message:
-            symbols = s.find_symbols(message)
             log.info("Looking for Symbols")
+            symbols = s.find_symbols(message)
         else:
             return
     except AttributeError as ex:
         log.info(ex)
         return
-    if symbols:
+
-        # Let user know bot is working
+    # Detect Options
+    if ("call" in message.lower()) or ("put" in message.lower()):
+        log.info("Options detected")
         await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
+        try:
+            options_data = s.options(message, symbols)
+
+            await update.message.reply_text(
+                text=generate_options_reply(options_data),
+                parse_mode=telegram.constants.ParseMode.MARKDOWN,
+            )
+            return
+        except KeyError as ex:
+            logging.warning(ex)
+            pass
+
+    if symbols:
         log.info(f"Symbols found: {symbols}")
+        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
 
         for reply in s.price_reply(symbols):
             await update.message.reply_text(
@@ -198,6 +208,47 @@ async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
             )
 
 
+def generate_options_reply(options_data: dict):
+    # Header with Option Symbol and Underlying
+    message_text = f"*{options_data['Option Symbol']} ({options_data['Underlying']})*\n\n"
+
+    # Key details
+    details = (
+        f"*Expiration:* `{options_data['Expiration']}`\n"
+        f"*Side:* `{options_data['side']}`\n"
+        f"*Strike:* `{options_data['strike']}`\n"
+        f"*First Traded:* `{options_data['First Traded']}`\n"
+        f"*Last Updated:* `{options_data['Last Updated']}`\n\n"
+    )
+    message_text += details
+
+    # Pricing info
+    pricing_info = (
+        f"*Bid:* `{options_data['bid']}` (Size: `{options_data['bidSize']}`)\n"
+        f"*Mid:* `{options_data['mid']}`\n"
+        f"*Ask:* `{options_data['ask']}` (Size: `{options_data['askSize']}`)\n"
+        f"*Last:* `{options_data['last']}`\n\n"
+    )
+    message_text += pricing_info
+
+    # Volume and open interest
+    volume_info = f"*Open Interest:* `{options_data['Open Interest']}`\n*Volume:* `{options_data['Volume']}`\n\n"
+    message_text += volume_info
+
+    # Greeks
+    greeks_info = (
+        f"*IV:* `{options_data['Implied Volatility']}`\n"
+        f"*Delta:* `{options_data['delta']}`\n"
+        f"*Gamma:* `{options_data['gamma']}`\n"
+        f"*Theta:* `{options_data['theta']}`\n"
+        f"*Vega:* `{options_data['vega']}`\n"
+        f"*Rho:* `{options_data['rho']}`\n"
+    )
+    message_text += greeks_info
+
+    return message_text
+
+
 async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE):
     """returns a chart of intraday data for a symbol"""
     log.info(f"Intra command ran by {update.message.chat.username}")

telegram/telegram-reqs.txt

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

tests.py

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

tests/conftest.py

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

tests/test_rate_limited.py

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

tests/test_router.py

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

tests/test_symbols.py

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