make ruff happy

.devcontainer/Dockerfile

@@ -1,3 +1,5 @@
 FROM python:3.11
 
 COPY . .
+
+# RUN pip install -r requirements.txt

.devcontainer/devcontainer.json

@@ -5,8 +5,7 @@
   // 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": {},
@@ -17,17 +16,16 @@
   "customizations": {
     "vscode": {
       "extensions": [
-        "ms-python.python",
+		"ms-python.python",
-        "ms-python.black-formatter",
+		"ms-python.black-formatter",
-        "ms-python.vscode-pylance",
+		"ms-python.flake8",
-        "ms-python.isort",
+		"ms-python.vscode-pylance",
-        "charliermarsh.ruff",
+		"ms-python.isort",
-        "ms-toolsai.jupyter",
+		"charliermarsh.ruff"
-        "esbenp.prettier-vscode"
+	]
-      ]
     }
   },
-  "postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm --fix-missing && npm install"
+  "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
   // Features to add to the dev container. More info: https://containers.dev/features.
   // "features": {},
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
@@ -38,4 +36,4 @@
   // "customizations": {},
   // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
   // "remoteUser": "root"
-}
+}

.gitignore

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

.gitlab-ci.yml

@@ -1,21 +1,21 @@
 stages:
   - lint
-  - build_site
   - deploy
 
-# ruff:
+black:
-#   stage: lint
+  stage: lint
-#   image: python:3.11-slim
+  image: registry.gitlab.com/pipeline-components/black:latest
-#   script:
+  script:
-#     - pip3 install ruff
+    - black --check --verbose -- .
-#     - ruff . --output-format gitlab; ruff format . --diff
+
+ruff:
+  stage: lint
+  # image: registry.gitlab.com/pipeline-components/ruff:latest
+  image: python:3.11-slim
+  script:
+    - pip3 install ruff
+    - ruff --output-format gitlab .
 
-# 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: /site/.gitlab-ci.yml
+  - local: /docs/.gitlab-ci.yml

.vscode/settings.json

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

README.md

@@ -1,48 +1,32 @@
-# Simple Stock Bots
+# Simple Telegram Stock Bot
 
-[![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-blue.svg)](https://t.me/SimpleStockBot)
+
+[![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
-[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
+[![Author](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
 
-Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed.
+## Docs
 
-## Documentation
+https://docs.simplestockbot.com/
 
-Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
+## Usage
 
-- [Official Documentation](https://simplestockbot.com/)
+https://docs.simplestockbot.com/commands/
-- [Command Reference](https://simplestockbot.com/commands/)
 
-## Support the Project
+## Donate
 
-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).
+Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
 
-You can contribute by:
+The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
 
-- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
+Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
-- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
-- [Getting in touch](contact.md) for any inquiries or suggestions.
 
-### Additional Support:
+If you have any questions get in [touch.](contact.md)
 
-- Follow on [Twitter](https://twitter.com/AnsonBiggs)
+## Other Ways to Help:
-- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot)
+
-- Utilize referral links for self-hosting:
+- Follow me on [twitter](https://twitter.com/AnsonBiggs)
+- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
+- Using my referral links to host your own Bot
   - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
+  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
-
-## Hosting
-
-Self-hosting instructions are provided for those interested in running the bot on their own servers:
-
-- [Hosting Guide](https://simplestockbot.com/hosting/)
-
-## Contact
-
-Reach out for bug reports, feature requests, or other inquiries:
-
-- [Contact Page](https://simplestockbot.com/contact/)
-
----
-
-Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.

common/MarketData.py

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

common/Symbol.py

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

common/symbol_router.py

@@ -1,407 +1,395 @@
-"""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

@@ -1,31 +0,0 @@
-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,10 @@
 -r common/requirements.txt
--r site/requirements.txt
+-r docs/requirements.txt
-ipython==8.16.1
+black==23.7.0
-jupyter_client==8.4.0
+flake8==6.1.0
-jupyter_core==5.4.0
+Flake8-pyproject==1.2.3
 pylama==8.4.1
 mypy==1.5.1
 types-cachetools==5.3.0.6
-types-pytz==2023.3.1.1
+types-pytz==2023.3.0.1
-ruff==0.1.6
+ruff==0.0.292

discord/D_info.py

@@ -1,59 +1,59 @@
-"""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/bot.py

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

discord/discord-reqs.txt

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

docker-compose.yaml

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

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

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

docs/README.md

@@ -0,0 +1,30 @@
+# Simple Stock Bots
+[![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot)
+[![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+ 
+
+## Table of Contents
++ [About](#about)
++ [Getting Started](#getting_started)
++ [Usage](#usage)
++ [Contributing](../CONTRIBUTING.md)
+
+## About <a name = "about"></a>
+Simple Stock Bots is a family of messaging bots that aim to provide simple bots that provide information on the stock market. Currently there are only [Telegram](./telegram) and [Discord](./discord) Bots.
+
+## Getting Started <a name = "getting_started"></a>
+
+The simplest way to use these bots is to use the version that I host on Digital Ocean. You can find the links to access them below:
+
++ [Telegram](https://t.me/SimpleStockBot)
++ [Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot)
+
+Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. 
+
+## Source Code
+
+The source code for the bots is completely open and hosted on Gitlab. 
+
++ [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-bot)
++ [Discord](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)

docs/docs/commands.md

@@ -1,16 +1,13 @@
 Symbols are used in headings to denote what platforms and symbol types a command supports.
 
-- Telegram Only :fontawesome-brands-telegram:
+- Telegram Only :fontawesome-brands-telegram-plane:
 - Discord Only :fontawesome-brands-discord:
 - Bot Commands :robot:
 - Cryptocurrency Support :material-currency-btc:
 - Stock Market Support :bank:
+- OTC Support :dollar:
 
-## Get the Bots
+## Symbol Detection :material-currency-btc: :bank: :dollar:
-
-[: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.
 
@@ -28,13 +25,7 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
     </div>
 </div>
 
-## Options Detection :bank:
+## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane: 
-
-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.
 
@@ -88,7 +79,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
 
@@ -103,9 +94,7 @@ 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%
 
@@ -178,11 +167,10 @@ Bot Status:
 
 </div>
 
-## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank:
+## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
 
 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.
-$$

docs/docs/contact.md

@@ -0,0 +1,6 @@
+Feel free to reach out with bugs or suggestions at any of the following places:
+
+- Message me on [Telegram](https://t.me/MisterBiggs)
+- Message me on Discord `MisterBiggs#0465`
+- Tweet me on [Twitter](https://twitter.com/AnsonBiggs)
+- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)

docs/docs/donate.md

@@ -0,0 +1,15 @@
+Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
+
+The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
+
+Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
+
+If you have any questions get in [touch.](contact.md)
+
+## Other Ways to Help:
+
+- Follow me on [twitter](https://twitter.com/AnsonBiggs)
+- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
+- Using my referral links to host your own Bot
+  - [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
+  - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)

docs/docs/host.md

@@ -0,0 +1,41 @@
+# Self Hosted Bot
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+## Prerequisites
+
+This project runs neatly in a docker container, so all that you need to run it yourself is [Docker](https://hub.docker.com/?overlay=onboarding) installed on your system.
+
+Depending on what platform you'll need:
+
+- Telegram API key which can be obtained for free by talking to [BotFather](https://telegram.me/botfather), more details [here.](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
+- Discord API key which can be obtained for free at [https://discord.com/developers](https://discord.com/developers)
+
+Finally, you will need a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) API key. They offer a free tier that should be enough for any private groups, more details [here.](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
+
+!!! tip
+    The bot will function without a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key and will fall back to only using cryptocurrency data. 
+
+!!! note
+    If you want to accept donations you also need a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]
+
+## Installing
+
+Once Docker is installed and you have your API keys for Telegram and [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) getting the bot running on any platform is extremely easy.
+
+Download or clone the repository to your machine and open a terminal in the project and build the Docker container.
+
+```
+docker build -t simple-telegram-bot .
+```
+
+Then run the bot using your API keys.
+
+```
+docker run --detach \
+     -e TELEGRAM=TELEGRAM_API_KEY \
+     -e MARKETDATA=MARKETDATA_API_KEY \
+      simple-telegram-bot
+```
+
+Your bot should be running! If you are new to Docker, I would recommend checking out its documentation for full control over your bot.

docs/docs/index.md

@@ -0,0 +1,29 @@
+# Simple Stock Bots
+
+Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information.
+
+## Getting Started
+
+The bots can either be added to a server or can be direct messaged for the exact same functionality. Links for each platform are below:
+
+[Telegram Bot :fontawesome-brands-telegram:](https://t.me/SimpleStockBot){ .md-button .md-button--primary }
+
+[Discord Bot :fontawesome-brands-discord:](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button .md-button--primary }
+
+Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](host.md)
+
+## Usage
+
+The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds. For full information see [Commands](commands.md)
+
+## Source Code
+
+The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. [The full text of the license can be read here](./LICENSE)
+
+- [Telegram Bot Source](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot)
+- [Discord Bot Source](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
+
+If you decide to host your own bots using my source code please consider using my referral links for marketdata.app and DigitalOcean. We both get a kickback when you use them.
+
+- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
+- [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)

docs/mkdocs.yml

@@ -1,30 +1,30 @@
-site_name: Simple Stock Bot
+site_name: Simple Stock Bot Docs
-site_url: https://simplestockbot.com
+site_url: https://docs.simplestockbot.com
-repo_url: https://gitlab.com/simple-stock-bots/simple-stock-bot
+edit_uri: /simple-stock-bots/site/tree/master/docs
+repo_url: https://gitlab.com/simple-stock-bots
 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
+  - Hosting: 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
     - navigation.tracking
     - navigation.tabs
     - navigation.tabs.sticky
-    - content.code.copy
+    - navigation.footer
   icon:
     logo: material/robot-love
   palette:
@@ -52,22 +52,23 @@ extra:
       link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
       name: Get the Discord Bot
     - icon: material/chart-line-stacked
-      link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
+      link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo
       name: MarketData.app for stock data
 
+
+
+
 extra_css:
   - stylesheets/phone.css
 
+
 plugins:
   - search
   - social
-  - blog
+
 
 markdown_extensions:
-  - attr_list
+- attr_list
-  - pymdownx.emoji:
+- pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
+    emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+    emoji_generator: !!python/name:materialx.emoji.to_svg
-  - admonition
-  - pymdownx.details
-  - pymdownx.superfences

docs/requirements.txt

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

package-lock.json

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

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

pyproject.toml

@@ -1,2 +1,11 @@
+[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

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

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

site/docs/blog/.authors.yml

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

site/docs/blog/index.md

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

site/docs/blog/posts/intro.md

@@ -1,66 +0,0 @@
----
-title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz"
-date: 2023-10-10
-tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
-authors: [Anson]
-description: >
-  Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord!
----
-
-## What is Simple Stock Bot?
-
-Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging.
-
-<div class="phone">
-    <div class="messages-wrapper">
-        <div class="message to">
-            I wonder how $tsla is affecting the price of $$btc
-        </div>
-        <div class="message from">
-        The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
-        </div>
-        <div class="message from">
-        The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
-        </div>
-    </div>
-</div>
-
-<!-- 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

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

@@ -1,14 +0,0 @@
----
-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/
-
-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/contact.md

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

site/docs/donate.md

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

site/docs/host.md

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

site/docs/index.md

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

site/overrides/main.html

@@ -1,17 +0,0 @@
-{% 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

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

telegram/T_info.py

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

tests.py

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