black format

Update links from individual bot repos to monorepo

Closes #112

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

.devcontainer/Dockerfile

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

.devcontainer/devcontainer.json

@@ -1,26 +1,41 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/docker-existing-dockerfile
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-	"name": "DockerDev",
+  "name": "Python 3",
-	// Sets the run context to one level up instead of the .devcontainer folder.
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"context": "..",
+  // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
-	// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
+  "build": {
-	"dockerFile": "Dockerfile",
+    "dockerfile": "Dockerfile",
-	// Set *default* container specific settings.json values on container create.
+    "context": ".."
-	"settings": {},
+  },
-	// Add the IDs of extensions you want installed when the container is created.
+  "features": {
-	"extensions": [
+    "ghcr.io/devcontainers-contrib/features/black:2": {},
-		"ms-python.python",
+    "ghcr.io/devcontainers-contrib/features/mypy:2": {},
-		"ms-azuretools.vscode-docker"
+    "ghcr.io/devcontainers-contrib/features/pylint:2": {},
-	]
+    "ghcr.io/devcontainers/features/docker-in-docker": {}
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+  },
-	// "forwardPorts": [],
+  "customizations": {
-	// Uncomment the next line to run commands after the container is created - for example installing curl.
+    "vscode": {
-	// "postCreateCommand": "apt-get update && apt-get install -y curl",
+      "extensions": [
-	// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+        "ms-python.python",
-	// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
+        "ms-python.black-formatter",
-	// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
+        "ms-python.vscode-pylance",
-	// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
+        "ms-python.isort",
-	// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+        "charliermarsh.ruff",
-	// "remoteUser": "vscode"
+        "ms-toolsai.jupyter",
-}
+        "esbenp.prettier-vscode"
+      ]
+    }
+  },
+  "postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm && npm install"
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "pip3 install --user -r requirements.txt",
+  // Configure tool-specific properties.
+  // "customizations": {},
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

.gitignore

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

.gitlab-ci.yml

@@ -1,5 +1,29 @@
+stages:
+  - lint
+  - build
+  - build_site
+  - deploy
+  - deploy_site
+
 black:
-  # stage: .pre
+  stage: lint
   image: registry.gitlab.com/pipeline-components/black:latest
   script:
     - black --check --verbose -- .
+
+ruff:
+  stage: lint
+  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

.vscode/launch.json

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

.vscode/settings.json

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

LICENSE

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

README.md

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

common/MarketData.py

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

common/Symbol.py

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

common/cg_Crypto.py

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

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

common/symbol_router.py

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

common/utilities.py

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

dev-reqs.txt

@@ -1,8 +1,12 @@
--r telegram/requirements.txt
+-r common/requirements.txt
-black==23.3.0
+-r site/requirements.txt
-flake8==5.0.4
+black==23.9.1
-Flake8-pyproject==1.2.3
+ipython==8.16.1
-pylama==8.4.1
+jupyter_client==8.4.0
-mypy==1.2.0
+jupyter_core==5.4.0
-types-cachetools==5.3.0.5
+pylama==8.4.1
-types-pytz==2023.3.0.0
+mypy==1.5.1
+types-cachetools==5.3.0.6
+types-pytz==2023.3.1.1
+ruff==0.0.292
+isort==5.12.0

discord/D_info.py

@@ -1,65 +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-discord-stock-bot/-/raw/master/LICENSE").text,
+        r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text,
-    )
+    )
-
+
-    help_text = """
+    help_text = """
-Thanks for using this bot, consider supporting it by [buying me 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). 🍻
-
+
-If you are interested in stock market data, or want to host your own bot, be sure to use my affiliate link so that the bot can stay free: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord)
+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).
-Keep up with the latest news for the bot in its discord Channel: https://t.me/simplestockbotnews
+
-
+**Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
-Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
+
-
+**Documentation**: All details about the bot are at [docs](https://simplestockbot.com).
-The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
+
-
+The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
-Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla. 
+- `/chart $$eth` gives Ethereum's monthly chart.
-
+- `/dividend $psec` shows Prospect Capital's dividend.
-**Commands**
+
-        - `/donate [amount in USD]` to donate. 🎗️
+Type any symbol, and the bot shows its price. Like: `Is $$btc rising since $tsla accepts it?` will give Bitcoin and Tesla prices.
-        - `/intra $[symbol]` Plot of the stocks movement since the last market open.  📈
+
-        - `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
+**Commands**
-        - `/trending` Trending Stocks and Cryptos. 💬
+- `/donate [USD amount]`: Support the bot. 🎗️
-        - `/help` Get some help using the bot. 🆘
+- `/intra $[symbol]`: See stock's latest movement. 📈
-
+- `/chart $[symbol]`: View a month's stock activity. 📊
-**Inline Features**
+- `/trending`: Check trending stocks and cryptos. 💬
-    You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
+- `/help`: Need help? Ask here. 🆘
-
+
-    Market data is provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord)
+**Inline Features**
-
+Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. Note: Prices might be delayed up to an hour.
-    If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
+
-    """
+Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
-
+
-    donate_text = """
+Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact).
-Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
+    """
-All donations go directly towards paying for servers, and market data is provided by
+
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
+    donate_text = """
-
+Simple Stock Bot runs purely on [donations.](https://www.buymeacoffee.com/Anson)
-The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
+Every donation supports server costs and
-
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord) provides our data.
-Example: `/donate 2` would donate 2 USD.
+
-
+**How to Donate?**
-An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
+1. Use `/donate [amount in USD]` command.
-If you have any questions see the [website](https://docs.simplestockbot.com)
+   - E.g., `/donate 2` donates 2 USD.
-
+2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
-    """
+    - It's quick, doesn't need an account, and accepts Paypal or Credit card.
-
+
-
+Questions? Visit our [website](https://simplestockbot.com).
-commands = """ # Not used by the bot but for updating commands with BotFather
+"""
-donate - Donate to the bot 🎗️
-help - Get some help using the bot. 🆘
-trending - Trending Stocks and Cryptos. 💬
-intra - $[symbol] Plot since the last market open. 📈
-chart - $[chart] Plot of the past month. 📊
-"""

discord/Dockerfile

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

discord/bot.py

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

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

discord/requirements.txt

@@ -1,7 +0,0 @@
-nextcord==2.4.2
-requests==2.25.1
-pandas==2.0.0
-schedule==1.0.0
-mplfinance==0.12.7a5
-markdownify==0.6.5
-cachetools==4.2.2

docker-compose.yaml

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

package-lock.json

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

package.json

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

pyproject.toml

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

site/.gitignore

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

site/.gitlab-ci.yml

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

site/.vscode/settings.json

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

site/LICENSE

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

site/docs/LICENSE.md

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

site/docs/blog/.authors.yml

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

site/docs/blog/index.md

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

site/docs/blog/posts/intro.md

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

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

site/docs/contact.md

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

site/docs/donate.md

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

site/docs/host.md

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

site/docs/index.md

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

site/docs/stylesheets/phone.css

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

site/mkdocs.yml

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

site/requirements.txt

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

telegram/Dockerfile

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

telegram/T_info.py

@@ -1,65 +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-telegram-stock-bot/-/raw/master/LICENSE").text,
+        r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text,
-    )
+    )
-
+
-    help_text = """
+    help_text = """
-Thanks for using this bot, consider supporting it 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) 🍻.
-
+
-If you are interested in stock market data, or want to host your own bot, be sure to use my affiliate link so that the bot can stay free: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram)
+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).
-Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews
+
-
+📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews.
-Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
+
-
+**Guide**: All about using and setting up the bot is in the [docs](https://simplestockbot.com).
-The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
+
-
+The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
-Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla. 
+- `/chart $$eth` gets a month's Ethereum chart.
-
+- `/dividend $psec` shows Prospect Capital's dividend info.
-**Commands**
+
-        - `/donate [amount in USD]` to donate. 🎗️
+Mention a symbol, and the bot reveals its price.
-        - `/intra $[symbol]` Plot of the stocks movement since the last market open.  📈
+E.g., `What's $$btc's price since $tsla accepts it?` gives Bitcoin and Tesla prices.
-        - `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
+
-        - `/trending` Trending Stocks and Cryptos. 💬
+**Commands**
-        - `/help` Get some help using the bot. 🆘
+- `/donate [USD]`: Support the bot. 🎗️
-
+- `/intra $[symbol]`: Today's stock activity. 📈
-**Inline Features**
+- `/chart $[symbol]`: Past month's stock chart. 📊
-    You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
+- `/trending`: What's hot in stocks and cryptos. 💬
-
+- `/help`: Bot assistance. 🆘
-    Market data is provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram)
+
-
+**Inline Features**
-    If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
+Search with @SimpleStockBot `[query]` anywhere.
-    """
+Pick a ticker, and the bot shares the current price in chat. Note: Prices can lag by an hour.
-
+
-    donate_text = """
+Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
+
-All donations go directly towards paying for servers, and market data is provided by
+Bot issues? Use `/status` or [contact us](https://simplestockbot.com/contact).
-[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
-
+    """
-The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
+
-
+    donate_text = """
-Example: `/donate 2` would donate 2 USD.
+Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
-
+All funds help maintain servers, with data from
-An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
-If you have any questions see the [website](https://docs.simplestockbot.com)
+
-
+**How to Donate?**
-    """
+1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
-
+2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
-
+
-commands = """ # Not used by the bot but for updating commands with BotFather
+For questions, visit our [website](https://simplestockbot.com).
-donate - Donate to the bot 🎗️
+"""
-help - Get some help using the bot. 🆘
+
-trending - Trending Stocks and Cryptos. 💬
+
-intra - $[symbol] Plot since the last market open. 📈
+# Not used by the bot but for updating commands with BotFather
-chart - $[chart] Plot of the past month. 📊
+commands = """
-"""
+donate - Donate to the bot 🎗️
+help - Get some help using the bot. 🆘
+trending - Trending Stocks and Cryptos. 💬
+intra - $[symbol] Plot since the last market open. 📈
+chart - $[chart] Plot of the past month. 📊
+"""

telegram/bot.py

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

telegram/requirements.txt

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

telegram/telegram-reqs.txt

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

tests.py

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