had wrong telegram chat linked

.devcontainer/Dockerfile

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

.devcontainer/devcontainer.json

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

.gitlab-ci.yml

@@ -1,24 +1,104 @@
-stages:
+black:
-  - lint
+  stage: .pre
-  - build
+  image: registry.gitlab.com/pipeline-components/black:latest
-  - build_site
+  script:
-  - deploy
+    - black --check --verbose -- .
-  - deploy_site
+
-
+
-black:
+#Following instructions (as of 2020-04-01): https://docs.gitlab.com/ee/ci/docker/using_kaniko.html
-  stage: lint
+#Kaniko docs are here: https://github.com/GoogleContainerTools/kaniko
-  image: registry.gitlab.com/pipeline-components/black:latest
+#While this example shows building to multiple registries for all branches, with a few modifications
-  script:
+#  it can be used to build non-master branches to a "dev" container registry and only build master to 
-    - black --check --verbose -- .
+#  a production container registry
-
+
-ruff:
+image: 
-  stage: lint
+  name: gcr.io/kaniko-project/executor:debug
-  # image: registry.gitlab.com/pipeline-components/ruff:latest
+  entrypoint: [""]
-  image: python:3.11-slim
+
-  script:
+variables: 
-    - pip3 install ruff
+  #More Information on Kaniko Caching: https://cloud.google.com/build/docs/kaniko-cache
-    - ruff --output-format gitlab .
+  KANIKO_CACHE_ARGS: "--cache=true --cache-copy-layers=true --cache-ttl=24h"
-
+  VERSIONLABELMETHOD: "OnlyIfThisCommitHasVersion" # options: "OnlyIfThisCommitHasVersion","LastVersionTagInGit"
-
+  IMAGE_LABELS: >
-include:
+    --label org.opencontainers.image.vendor=$CI_SERVER_URL/$GITLAB_USER_LOGIN
-  - local: /site/.gitlab-ci.yml
+    --label org.opencontainers.image.authors=$CI_SERVER_URL/$GITLAB_USER_LOGIN
+    --label org.opencontainers.image.revision=$CI_COMMIT_SHA
+    --label org.opencontainers.image.source=$CI_PROJECT_URL
+    --label org.opencontainers.image.documentation=$CI_PROJECT_URL
+    --label org.opencontainers.image.licenses=$CI_PROJECT_URL
+    --label org.opencontainers.image.url=$CI_PROJECT_URL
+    --label vcs-url=$CI_PROJECT_URL
+    --label com.gitlab.ci.user=$CI_SERVER_URL/$GITLAB_USER_LOGIN
+    --label com.gitlab.ci.email=$GITLAB_USER_EMAIL
+    --label com.gitlab.ci.tagorbranch=$CI_COMMIT_REF_NAME
+    --label com.gitlab.ci.pipelineurl=$CI_PIPELINE_URL
+    --label com.gitlab.ci.commiturl=$CI_PROJECT_URL/commit/$CI_COMMIT_SHA
+    --label com.gitlab.ci.cijoburl=$CI_JOB_URL
+    --label com.gitlab.ci.mrurl=$CI_PROJECT_URL/-/merge_requests/$CI_MERGE_REQUEST_ID
+
+get-latest-git-version:
+  stage: .pre
+  image: 
+    name: alpine/git
+    entrypoint: [""]
+  rules:
+    - if: '$VERSIONLABELMETHOD == "LastVersionTagInGit"'    
+  script:
+    - |
+      echo "the google kaniko container does not have git and does not have a packge manager to install it"
+      git clone https://github.com/GoogleContainerTools/kaniko.git
+      cd kaniko
+      echo "$(git describe --abbrev=0 --tags)" > ../VERSIONTAG.txt
+      echo "VERSIONTAG.txt contains $(cat ../VERSIONTAG.txt)"
+  artifacts:
+    paths:
+      - VERSIONTAG.txt
+
+
+.build_with_kaniko:
+  #Hidden job to use as an "extends" template
+  stage: build
+  script:
+    - | 
+      echo "Building and shipping image to $CI_REGISTRY_IMAGE"
+      #Build date for opencontainers
+      BUILDDATE="'$(date '+%FT%T%z' | sed -E -n 's/(\+[0-9]{2})([0-9]{2})$/\1:\2/p')'" #rfc 3339 date
+      IMAGE_LABELS="$IMAGE_LABELS --label org.opencontainers.image.created=$BUILDDATE --label build-date=$BUILDDATE"
+      #Description for opencontainers
+      BUILDTITLE=$(echo $CI_PROJECT_TITLE | tr " " "_")
+      IMAGE_LABELS="$IMAGE_LABELS --label org.opencontainers.image.title=$BUILDTITLE --label org.opencontainers.image.description=$BUILDTITLE"
+      #Add ref.name for opencontainers
+      IMAGE_LABELS="$IMAGE_LABELS --label org.opencontainers.image.ref.name=$CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME"
+
+      #Build Version Label and Tag from git tag, LastVersionTagInGit was placed by a previous job artifact
+      if [[ "$VERSIONLABELMETHOD" == "LastVersionTagInGit" ]]; then VERSIONLABEL=$(cat VERSIONTAG.txt); fi
+      if [[ "$VERSIONLABELMETHOD" == "OnlyIfThisCommitHasVersion" ]]; then VERSIONLABEL=$CI_COMMIT_TAG; fi
+      if [[ ! -z "$VERSIONLABEL" ]]; then 
+        IMAGE_LABELS="$IMAGE_LABELS --label org.opencontainers.image.version=$VERSIONLABEL"
+        ADDITIONALTAGLIST="$ADDITIONALTAGLIST $VERSIONLABEL"
+      fi
+      
+      ADDITIONALTAGLIST="$ADDITIONALTAGLIST $CI_COMMIT_REF_NAME $CI_COMMIT_SHORT_SHA"
+      if [[ "$CI_COMMIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]]; then ADDITIONALTAGLIST="$ADDITIONALTAGLIST latest"; fi
+      if [[ -n "$ADDITIONALTAGLIST" ]]; then 
+        for TAG in $ADDITIONALTAGLIST; do 
+          FORMATTEDTAGLIST="${FORMATTEDTAGLIST} --tag $CI_REGISTRY_IMAGE:$TAG "; 
+        done; 
+      fi
+      
+      #Reformat Docker tags to kaniko's --destination argument:
+      FORMATTEDTAGLIST=$(echo "${FORMATTEDTAGLIST}" | sed s/\-\-tag/\-\-destination/g) 
+
+      echo "Kaniko arguments to run: --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile $KANIKO_CACHE_ARGS $FORMATTEDTAGLIST $IMAGE_LABELS"
+      mkdir -p /kaniko/.docker
+      echo "{\"auths\":{\"$CI_REGISTRY\":{\"auth\":\"$(echo -n $CI_REGISTRY_USER:$CI_REGISTRY_PASSWORD | base64)\"}}}" > /kaniko/.docker/config.json
+      /kaniko/executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile $KANIKO_CACHE_ARGS $FORMATTEDTAGLIST $IMAGE_LABELS
+
+
+build-for-gitlab-project-registry:
+  extends: .build_with_kaniko
+  environment:
+    #This is only here for completeness, since there are no CI CD Variables with this scope, the project defaults are used
+    # to push to this projects docker registry
+    name: push-to-gitlab-project-registry
+

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Telegram Bot",
+            "type": "python",
+            "request": "launch",
+            "program": "bot.py",
+            "console": "integratedTerminal"
+        }
+    ]
+}

.vscode/settings.json

@@ -1,8 +1,13 @@
-{
+{
-    "editor.formatOnSave": true,
+    "workbench.iconTheme": "vscode-icons",
-    "editor.formatOnPaste": true,
+    "editor.suggestSelection": "first",
-    "editor.formatOnSaveMode": "modificationsIfAvailable",
+    "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
-    "[python]": {
+    "python.languageServer": "Pylance",
-        "editor.defaultFormatter": "ms-python.black-formatter",
+    "git.autofetch": true,
-    }
+    "editor.formatOnSave": true,
+    "files.associations": {
+        "DockerDev": "dockerfile",
+    },
+    "python.formatting.provider": "black",
+    "python.showStartPage": false,
 }

Dockerfile

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

IEX_Symbol.py

@@ -0,0 +1,497 @@
+"""Class with functions for running the bot with IEX Cloud.
+"""
+
+import logging
+import os
+from datetime import datetime
+from logging import warning
+from typing import List, Optional, Tuple
+
+import pandas as pd
+import requests as r
+import schedule
+
+from Symbol import Stock
+
+
+class IEX_Symbol:
+    """
+    Functions for finding stock market information about symbols.
+    """
+
+    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
+
+    searched_symbols = {}
+    otc_list = []
+    charts = {}
+    trending_cache = None
+
+    def __init__(self) -> None:
+        """Creates a Symbol Object
+
+        Parameters
+        ----------
+        IEX_TOKEN : str
+            IEX API Token
+        """
+        try:
+            self.IEX_TOKEN = os.environ["IEX"]
+
+            if self.IEX_TOKEN == "TOKEN":
+                self.IEX_TOKEN = ""
+        except KeyError:
+            self.IEX_TOKEN = ""
+            warning(
+                "Starting without an IEX Token will not allow you to get market data!"
+            )
+
+        if self.IEX_TOKEN != "":
+            self.get_symbol_list()
+
+            schedule.every().day.do(self.get_symbol_list)
+            schedule.every().day.do(self.clear_charts)
+
+    def get(self, endpoint, params: dict = {}, timeout=5) -> dict:
+
+        url = "https://cloud.iexapis.com/stable" + endpoint
+
+        # set token param if it wasn't passed.
+        params["token"] = params.get("token", self.IEX_TOKEN)
+
+        resp = r.get(url, params=params, timeout=timeout)
+
+        # Make sure API returned a proper status code
+        try:
+            resp.raise_for_status()
+        except r.exceptions.HTTPError as e:
+            logging.error(e)
+            return {}
+
+        # Make sure API returned valid JSON
+        try:
+            resp_json = resp.json()
+
+            # IEX uses backtick ` as apostrophe which breaks telegram markdown parsing
+            if type(resp_json) is dict:
+                resp_json["companyName"] = resp_json.get("companyName", "").replace(
+                    "`", "'"
+                )
+
+            return resp_json
+        except r.exceptions.JSONDecodeError as e:
+            logging.error(e)
+            return {}
+
+    def clear_charts(self) -> None:
+        """
+        Clears cache of chart data.
+        Charts are cached so that only 1 API call per 24 hours is needed since the
+            chart data is expensive and a large download.
+        """
+        self.charts = {}
+
+    def get_symbol_list(
+        self, return_df=False
+    ) -> Optional[Tuple[pd.DataFrame, datetime]]:
+        """Gets list of all symbols supported by IEX
+
+        Parameters
+        ----------
+        return_df : bool, optional
+            return the dataframe of all stock symbols, by default False
+
+        Returns
+        -------
+        Optional[Tuple[pd.DataFrame, datetime]]
+            If `return_df` is set to `True` returns a dataframe, otherwise returns `None`.
+        """
+
+        reg_symbols = self.get("/ref-data/symbols")
+        otc_symbols = self.get("/ref-data/otc/symbols")
+
+        reg = pd.DataFrame(data=reg_symbols)
+        otc = pd.DataFrame(data=otc_symbols)
+        self.otc_list = set(otc["symbol"].to_list())
+
+        symbols = pd.concat([reg, otc])
+
+        # IEX uses backtick ` as apostrophe which breaks telegram markdown parsing
+        symbols["name"] = symbols["name"].str.replace("`", "'")
+
+        symbols["description"] = "$" + symbols["symbol"] + ": " + symbols["name"]
+        symbols["id"] = symbols["symbol"]
+        symbols["type_id"] = "$" + symbols["symbol"].str.lower()
+
+        symbols = symbols[["id", "symbol", "name", "description", "type_id"]]
+        self.symbol_list = symbols
+        if return_df:
+            return symbols, datetime.now()
+
+    def status(self) -> str:
+        """Checks IEX Status dashboard for any current API issues.
+
+        Returns
+        -------
+        str
+            Human readable text on status of IEX API
+        """
+
+        if self.IEX_TOKEN == "":
+            return "The `IEX_TOKEN` is not set so Stock Market data is not available."
+
+        resp = r.get(
+            "https://pjmps0c34hp7.statuspage.io/api/v2/status.json",
+            timeout=15,
+        )
+
+        if resp.status_code == 200:
+            status = resp.json()["status"]
+        else:
+            return "IEX Cloud did not respond. Please check their status page for more information. https://status.iexapis.com"
+
+        if status["indicator"] == "none":
+            return "IEX Cloud is currently not reporting any issues with its API."
+        else:
+            return (
+                f"{status['indicator']}: {status['description']}."
+                + " Please check the status page for more information. https://status.iexapis.com"
+            )
+
+    def price_reply(self, symbol: Stock) -> str:
+        """Returns price movement of Stock for the last market day, or after hours.
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+
+        if IEXData := self.get(f"/stock/{symbol.id}/quote"):
+
+            if symbol.symbol.upper() in self.otc_list:
+                return f"OTC - {symbol.symbol.upper()}, {IEXData['companyName']} most recent price is: $**{IEXData['latestPrice']}**"
+
+            keys = (
+                "extendedChangePercent",
+                "extendedPrice",
+                "companyName",
+                "latestPrice",
+                "changePercent",
+            )
+
+            if set(keys).issubset(IEXData):
+
+                if change := IEXData.get("changePercent", 0):
+                    change = round(change * 100, 2)
+                else:
+                    change = 0
+
+                if (
+                    IEXData.get("isUSMarketOpen", True)
+                    or (IEXData["extendedChangePercent"] is None)
+                    or (IEXData["extendedPrice"] is None)
+                ):  # Check if market is open.
+                    message = f"The current stock price of {IEXData['companyName']} is $**{IEXData['latestPrice']}**"
+                else:
+                    message = (
+                        f"{IEXData['companyName']} closed at $**{IEXData['latestPrice']}** with a change of {change}%,"
+                        + f" after hours _(15 minutes delayed)_ the stock price is $**{IEXData['extendedPrice']}**"
+                    )
+                    if change := IEXData.get("extendedChangePercent", 0):
+                        change = round(change * 100, 2)
+                    else:
+                        change = 0
+
+                # Determine wording of change text
+                if change > 0:
+                    message += f", the stock is currently **up {change}%**"
+                elif change < 0:
+                    message += f", the stock is currently **down {change}%**"
+                else:
+                    message += ", the stock hasn't shown any movement today."
+            else:
+                message = (
+                    f"The symbol: {symbol} encountered and error. This could be due to "
+                )
+
+        else:
+            message = f"The symbol: {symbol} was not found."
+
+        return message
+
+    def dividend_reply(self, symbol: Stock) -> str:
+        """Returns the most recent, or next dividend date for a stock symbol.
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        if symbol.symbol.upper() in self.otc_list:
+            return "OTC stocks do not currently support any commands."
+
+        if resp := self.get(f"/stock/{symbol.id}/dividends/next"):
+            try:
+                IEXData = resp[0]
+            except IndexError as e:
+                logging.info(e)
+                return f"Getting dividend information for ${symbol.id.upper()} encountered an error. The provider for upcoming dividend information has been having issues recently which has likely caused this error. It is also possible that the stock has no dividend or does not exist."
+            keys = (
+                "amount",
+                "currency",
+                "declaredDate",
+                "exDate",
+                "frequency",
+                "paymentDate",
+                "flag",
+            )
+
+            if set(keys).issubset(IEXData):
+
+                if IEXData["currency"] == "USD":
+                    price = f"${IEXData['amount']}"
+                else:
+                    price = f"{IEXData['amount']} {IEXData['currency']}"
+
+                # Pattern IEX uses for dividend date.
+                pattern = "%Y-%m-%d"
+
+                declared = datetime.strptime(IEXData["declaredDate"], pattern).strftime(
+                    "%A, %B %w"
+                )
+                ex = datetime.strptime(IEXData["exDate"], pattern).strftime("%A, %B %w")
+                payment = datetime.strptime(IEXData["paymentDate"], pattern).strftime(
+                    "%A, %B %w"
+                )
+
+                daysDelta = (
+                    datetime.strptime(IEXData["paymentDate"], pattern) - datetime.now()
+                ).days
+
+                return (
+                    "The next dividend for "
+                    + f"{self.symbol_list[self.symbol_list['symbol']==symbol.id.upper()]['description'].item()}"  # Get full name without api call
+                    + f" is on {payment} which is in {daysDelta} days."
+                    + f" The dividend is for {price} per share."
+                    + f"\n\nThe dividend was declared on {declared} and the ex-dividend date is {ex}"
+                )
+
+        return f"Getting dividend information for ${symbol.id.upper()} encountered an error. The provider for upcoming dividend information has been having issues recently which has likely caused this error. It is also possible that the stock has no dividend or does not exist."
+
+    def news_reply(self, symbol: Stock) -> str:
+        """Gets most recent, english, non-paywalled news
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        if symbol.symbol.upper() in self.otc_list:
+            return "OTC stocks do not currently support any commands."
+
+        if data := self.get(f"/stock/{symbol.id}/news/last/15"):
+            line = []
+
+            for news in data:
+                if news["lang"] == "en" and not news["hasPaywall"]:
+                    line.append(
+                        f"*{news['source']}*: [{news['headline']}]({news['url']})"
+                    )
+
+            return f"News for **{symbol.id.upper()}**:\n" + "\n".join(line[:5])
+
+        else:
+            return f"No news found for: {symbol.id}\nEither today is boring or the symbol does not exist."
+
+    def info_reply(self, symbol: Stock) -> str:
+        """Gets description for Stock
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted text
+        """
+        if symbol.symbol.upper() in self.otc_list:
+            return "OTC stocks do not currently support any commands."
+
+        if data := self.get(f"/stock/{symbol.id}/company"):
+            [data.pop(k) for k in list(data) if data[k] == ""]
+
+            if "description" in data:
+                return data["description"]
+
+        return f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
+
+    def stat_reply(self, symbol: Stock) -> str:
+        """Key statistics on a Stock
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        if symbol.symbol.upper() in self.otc_list:
+            return "OTC stocks do not currently support any commands."
+
+        if data := self.get(f"/stock/{symbol.id}/stats"):
+            [data.pop(k) for k in list(data) if data[k] == ""]
+
+            m = ""
+            if "companyName" in data:
+                m += f"Company Name: {data['companyName']}\n"
+            if "marketcap" in data:
+                m += f"Market Cap: ${data['marketcap']:,}\n"
+            if "week52high" in data:
+                m += f"52 Week (high-low): {data['week52high']:,} "
+            if "week52low" in data:
+                m += f"- {data['week52low']:,}\n"
+            if "employees" in data:
+                m += f"Number of Employees: {data['employees']:,}\n"
+            if "nextEarningsDate" in data:
+                m += f"Next Earnings Date: {data['nextEarningsDate']}\n"
+            if "peRatio" in data:
+                m += f"Price to Earnings: {data['peRatio']:.3f}\n"
+            if "beta" in data:
+                m += f"Beta: {data['beta']:.3f}\n"
+            return m
+        else:
+            return f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
+
+    def cap_reply(self, symbol: Stock) -> str:
+        """Get the Market Cap of a stock"""
+
+        if data := self.get(f"/stock/{symbol.id}/stats"):
+
+            try:
+                cap = data["marketcap"]
+            except KeyError:
+                return f"{symbol.id} returned an error."
+
+            message = f"The current market cap of {symbol.name} is $**{cap:,.2f}**"
+
+        else:
+            message = f"The Stock: {symbol.name} was not found or returned and error."
+
+        return message
+
+    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol since the last market open.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+        if symbol.symbol.upper() in self.otc_list:
+            return pd.DataFrame()
+
+        if symbol.id.upper() not in list(self.symbol_list["symbol"]):
+            return pd.DataFrame()
+
+        if data := self.get(f"/stock/{symbol.id}/intraday-prices"):
+            df = pd.DataFrame(data)
+            df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
+            df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
+            df = df.set_index("DT")
+            return df
+
+        return pd.DataFrame()
+
+    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+        schedule.run_pending()
+
+        if symbol.symbol.upper() in self.otc_list:
+            return pd.DataFrame()
+
+        if symbol.id.upper() not in list(self.symbol_list["symbol"]):
+            return pd.DataFrame()
+
+        try:  # https://stackoverflow.com/a/3845776/8774114
+            return self.charts[symbol.id.upper()]
+        except KeyError:
+            pass
+
+        if data := self.get(
+            f"/stock/{symbol.id}/chart/1mm",
+            params={"chartInterval": 3, "includeToday": "false"},
+        ):
+            df = pd.DataFrame(data)
+            df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
+            df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
+            df = df.set_index("DT")
+            self.charts[symbol.id.upper()] = df
+            return df
+
+        return pd.DataFrame()
+
+    def spark_reply(self, symbol: Stock) -> str:
+        quote = self.get(f"/stock/{symbol.id}/quote")
+
+        open_change = quote.get("changePercent", 0)
+        after_change = quote.get("extendedChangePercent", 0)
+
+        change = 0
+
+        if open_change:
+            change = change + open_change
+        if after_change:
+            change = change + after_change
+
+        change = change * 100
+
+        return f"`{symbol.tag}`: {quote['companyName']}, {change:.2f}%"
+
+    def trending(self) -> list[str]:
+        """Gets current coins trending on IEX. Only returns when market is open.
+
+        Returns
+        -------
+        list[str]
+            list of $ID: NAME, CHANGE%
+        """
+
+        if data := self.get(f"/stock/market/list/mostactive"):
+            self.trending_cache = [
+                f"`${s['symbol']}`: {s['companyName']}, {100*s['changePercent']:.2f}%"
+                for s in data
+            ]
+
+        return self.trending_cache

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

Symbol.py

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

T_info.py

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

bot.py

@@ -0,0 +1,637 @@
+# Works with Python 3.8
+import datetime
+import html
+import io
+import json
+import logging
+import os
+import random
+import string
+import traceback
+from logging import critical, debug, error, info, warning
+from uuid import uuid4
+
+import mplfinance as mpf
+import telegram
+from telegram import (
+    InlineQueryResultArticle,
+    InputTextMessageContent,
+    LabeledPrice,
+    Update,
+)
+from telegram.ext import (
+    CallbackContext,
+    CommandHandler,
+    Filters,
+    InlineQueryHandler,
+    MessageHandler,
+    PreCheckoutQueryHandler,
+    Updater,
+)
+
+from symbol_router import Router
+from T_info import T_info
+
+TELEGRAM_TOKEN = os.environ["TELEGRAM"]
+
+try:
+    STRIPE_TOKEN = os.environ["STRIPE"]
+except KeyError:
+    STRIPE_TOKEN = ""
+    warning("Starting without a STRIPE Token will not allow you to accept Donations!")
+
+s = Router()
+t = T_info()
+
+# Enable logging
+logging.basicConfig(
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
+)
+
+logger = logging.getLogger(__name__)
+info("Bot script started.")
+
+
+def start(update: Update, context: CallbackContext):
+    """Send help text when the command /start is issued."""
+    info(f"Start command ran by {update.message.chat.username}")
+    update.message.reply_text(
+        text=t.help_text,
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def help(update: Update, context: CallbackContext):
+    """Send help text when the command /help is issued."""
+    info(f"Help command ran by {update.message.chat.username}")
+    update.message.reply_text(
+        text=t.help_text,
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def license(update: Update, context: CallbackContext):
+    """Send bots license when the /license command is issued."""
+    info(f"License command ran by {update.message.chat.username}")
+    update.message.reply_text(
+        text=t.license,
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def status(update: Update, context: CallbackContext):
+    """Gather status of bot and dependant services and return important status updates."""
+    warning(f"Status command ran by {update.message.chat.username}")
+    bot_resp_time = (
+        datetime.datetime.now(update.message.date.tzinfo) - update.message.date
+    )
+
+    bot_status = s.status(
+        f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message."
+    )
+
+    update.message.reply_text(
+        text=bot_status,
+        parse_mode=telegram.ParseMode.MARKDOWN,
+    )
+
+
+def donate(update: Update, context: CallbackContext):
+    """Sets up donation."""
+    info(f"Donate command ran by {update.message.chat.username}")
+    chat_id = update.message.chat_id
+
+    if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
+        update.message.reply_text(
+            text=t.donate_text,
+            parse_mode=telegram.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        amount = 1
+    else:
+        amount = update.message.text.replace("/donate", "").replace("$", "").strip()
+
+    try:
+        price = int(float(amount) * 100)
+    except ValueError:
+        update.message.reply_text(f"{amount} is not a valid donation amount or number.")
+        return
+    info(f"Donation amount: {price} by {update.message.chat.username}")
+
+    context.bot.send_invoice(
+        chat_id=chat_id,
+        title="Simple Stock Bot Donation",
+        description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
+        payload=f"simple-stock-bot-{chat_id}",
+        provider_token=STRIPE_TOKEN,
+        currency="USD",
+        prices=[LabeledPrice("Donation:", price)],
+        start_parameter="",
+        # suggested_tip_amounts=[100, 500, 1000, 2000],
+        photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
+        photo_width=500,
+        photo_height=500,
+    )
+
+
+def precheckout_callback(update: Update, context: CallbackContext):
+    """Approves donation"""
+    info(f"precheckout_callback queried")
+    query = update.pre_checkout_query
+
+    query.answer(ok=True)
+    # I dont think I need to check since its only donations.
+    # if query.invoice_payload == "simple-stock-bot":
+    #     # answer False pre_checkout_query
+    #     query.answer(ok=True)
+    # else:
+    #     query.answer(ok=False, error_message="Something went wrong...")
+
+
+def successful_payment_callback(update: Update, context: CallbackContext):
+    """Thanks user for donation"""
+    info(f"Successful payment!")
+    update.message.reply_text(
+        "Thank you for your donation! It goes a long way to keeping the bot free!"
+    )
+
+
+def symbol_detect_image(update: Update, context: CallbackContext):
+    """
+    Makes image captions into text then passes the `update` and `context`
+        to symbol detect so that it can reply cashtags in image captions.
+    """
+    if update.message.caption:
+        update.message.text = update.message.caption
+        symbol_detect(update, context)
+
+
+def symbol_detect(update: Update, context: CallbackContext):
+    """
+    Runs on any message that doesn't have a command and searches for cashtags,
+        then returns the prices of any symbols found.
+    """
+    try:
+        message = update.message.text
+        chat_id = update.message.chat_id
+        if "$" in message:
+            symbols = s.find_symbols(message)
+            info("Looking for Symbols")
+        else:
+            return
+    except AttributeError as ex:
+        info(ex)
+        return
+    if symbols:
+        # Let user know bot is working
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+        info(f"Symbols found: {symbols}")
+
+        for reply in s.price_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def dividend(update: Update, context: CallbackContext):
+    """/dividend or /div command and then finds dividend info on that symbol."""
+    info(f"Dividend command ran by {update.message.chat.username}")
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/dividend":
+        update.message.reply_text(
+            "This command gives info on the next dividend date for a symbol.\nExample: /dividend $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message)
+
+    if symbols:
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+        for reply in s.dividend_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def news(update: Update, context: CallbackContext):
+    """/news command then finds news info on that symbol."""
+    info(f"News command ran by {update.message.chat.username}")
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/news":
+        update.message.reply_text(
+            "This command gives the most recent english news for a symbol.\nExample: /news $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message, trending_weight=10)
+
+    if symbols:
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for reply in s.news_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def information(update: Update, context: CallbackContext):
+    """/info command then finds info on that symbol."""
+    info(f"Information command ran by {update.message.chat.username}")
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/info":
+        update.message.reply_text(
+            "This command gives information on a symbol.\nExample: /info $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message)
+
+    if symbols:
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for reply in s.info_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def search(update: Update, context: CallbackContext):
+    """
+    Searches on full list of stocks and crypto descriptions
+    then returns the top matches in order of smallest symbol name length.
+    """
+    info(f"Search command ran by {update.message.chat.username}")
+    message = update.message.text.replace("/search ", "")
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/search":
+        update.message.reply_text(
+            "This command searches for symbols supported by the bot.\nExample: /search Tesla Motors or /search $tsla"
+        )
+        return
+
+    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+    queries = s.inline_search(message, matches=10)
+    if not queries.empty:
+        reply = "*Search Results:*\n`$ticker` : Company Name\n`" + ("-" * 21) + "`\n"
+        for _, query in queries.iterrows():
+            desc = query["description"]
+            reply += "`" + desc.replace(": ", "` : ") + "\n"
+
+        update.message.reply_text(
+            text=reply,
+            parse_mode=telegram.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+
+
+def intra(update: Update, context: CallbackContext):
+    """returns a chart of intraday data for a symbol"""
+    info(f"Intra command ran by {update.message.chat.username}")
+
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/intra":
+        update.message.reply_text(
+            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message, trending_weight=5)
+    symbol = symbols[0]
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        update.message.reply_text("No symbols or coins found.")
+        return
+
+    df = s.intra_reply(symbol)
+    if df.empty:
+        update.message.reply_text(
+            text="Invalid symbol please see `/help` for usage details.",
+            parse_mode=telegram.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        return
+
+    context.bot.send_chat_action(
+        chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO
+    )
+
+    buf = io.BytesIO()
+    mpf.plot(
+        df,
+        type="renko",
+        title=f"\n{symbol.name}",
+        volume="volume" in df.keys(),
+        style="yahoo",
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+    )
+    buf.seek(0)
+
+    update.message.reply_photo(
+        photo=buf,
+        caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+        + f" {df.last_valid_index().strftime('%d %b at %H:%M')}"
+        + f"\n\n{s.price_reply([symbol])[0]}",
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def chart(update: Update, context: CallbackContext):
+    """returns a chart of the past month of data for a symbol"""
+    info(f"Chart command ran by {update.message.chat.username}")
+
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/chart":
+        update.message.reply_text(
+            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message, trending_weight=10)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        update.message.reply_text("No symbols or coins found.")
+        return
+
+    df = s.chart_reply(symbol)
+    if df.empty:
+        update.message.reply_text(
+            text="Invalid symbol please see `/help` for usage details.",
+            parse_mode=telegram.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        return
+    context.bot.send_chat_action(
+        chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO
+    )
+
+    buf = io.BytesIO()
+    mpf.plot(
+        df,
+        type="candle",
+        title=f"\n{symbol.name}",
+        volume="volume" in df.keys(),
+        style="yahoo",
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+    )
+    buf.seek(0)
+
+    update.message.reply_photo(
+        photo=buf,
+        caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def stat(update: Update, context: CallbackContext):
+    """returns key statistics on symbol"""
+    info(f"Stat command ran by {update.message.chat.username}")
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/stat":
+        update.message.reply_text(
+            "This command returns key statistics for a symbol.\nExample: /stat $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message)
+
+    if symbols:
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for reply in s.stat_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def cap(update: Update, context: CallbackContext):
+    """returns market cap for symbol"""
+    info(f"Cap command ran by {update.message.chat.username}")
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/cap":
+        update.message.reply_text(
+            "This command returns the market cap for a symbol.\nExample: /cap $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message)
+
+    if symbols:
+        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+        for reply in s.cap_reply(symbols):
+            update.message.reply_text(
+                text=reply,
+                parse_mode=telegram.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+def trending(update: Update, context: CallbackContext):
+    """returns currently trending symbols and how much they've moved in the past trading day."""
+    info(f"Trending command ran by {update.message.chat.username}")
+
+    chat_id = update.message.chat_id
+
+    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
+
+    trending_list = s.trending()
+    info(trending_list)
+
+    update.message.reply_text(
+        text=trending_list,
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def inline_query(update: Update, context: CallbackContext):
+    """
+    Handles inline query. Searches by looking if query is contained
+        in the symbol and returns matches in alphabetical order.
+    """
+    # info(f"Inline command ran by {update.message.chat.username}")
+    info(f"Query: {update.inline_query.query}")
+
+    ignored_queries = {"$", "$$", " ", ""}
+
+    if update.inline_query.query.strip() in ignored_queries:
+        default_message = """
+        You can type:\n@SimpleStockBot `[search]`\nin any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
+        """
+
+        update.inline_query.answer(
+            [
+                InlineQueryResultArticle(
+                    str(uuid4()),
+                    title="Please enter a query. It can be a ticker or a name of a company.",
+                    input_message_content=InputTextMessageContent(
+                        default_message, parse_mode=telegram.ParseMode.MARKDOWN
+                    ),
+                )
+            ]
+        )
+
+    matches = s.inline_search(update.inline_query.query)
+
+    results = []
+    for _, row in matches.iterrows():
+
+        results.append(
+            InlineQueryResultArticle(
+                str(uuid4()),
+                title=row["description"],
+                input_message_content=InputTextMessageContent(
+                    row["price_reply"], parse_mode=telegram.ParseMode.MARKDOWN
+                ),
+            )
+        )
+
+        if len(results) == 5:
+            update.inline_query.answer(results, cache_time=60 * 60)
+            info("Inline Command was successful")
+            return
+    update.inline_query.answer(results)
+
+
+def rand_pick(update: Update, context: CallbackContext):
+    """For the gamblers. Returns a random symbol to buy and a sell date"""
+    info(
+        f"Someone is gambling! Random_pick command ran by {update.message.chat.username}"
+    )
+
+    update.message.reply_text(
+        text=s.random_pick(),
+        parse_mode=telegram.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+def error(update: Update, context: CallbackContext):
+    """Log Errors caused by Updates."""
+    warning('Update "%s" caused error "%s"', update, error)
+
+    tb_list = traceback.format_exception(
+        None, context.error, context.error.__traceback__
+    )
+    tb_string = "".join(tb_list)
+
+    err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
+    warning(f"Logging error: {err_code}")
+
+    if update:
+        message = (
+            f"An exception was raised while handling an update\n"
+            f"<pre>update = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}"
+            "</pre>\n\n"
+            f"<pre>context.chat_data = {html.escape(str(context.chat_data))}</pre>\n\n"
+            f"<pre>context.user_data = {html.escape(str(context.user_data))}</pre>\n\n"
+            f"<pre>{html.escape(tb_string)}</pre>"
+        )
+        warning(message)
+    else:
+        warning(tb_string)
+
+    # update.message.reply_text(
+    #     text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
+    #     parse_mode=telegram.ParseMode.MARKDOWN,
+    # )
+
+    # Finally, send the message
+    # update.message.reply_text(text=message, parse_mode=telegram.ParseMode.HTML)
+    # update.message.reply_text(text="Please inform the bot admin of this issue.")
+
+
+def main():
+    """Start the context.bot."""
+    # Create the EventHandler and pass it your bot's token.
+    updater = Updater(TELEGRAM_TOKEN)
+
+    # Get the dispatcher to register handlers
+    dp = updater.dispatcher
+
+    # on different commands - answer in Telegram
+    dp.add_handler(CommandHandler("start", start))
+    dp.add_handler(CommandHandler("help", help))
+    dp.add_handler(CommandHandler("license", license))
+    dp.add_handler(CommandHandler("dividend", dividend))
+    dp.add_handler(CommandHandler("div", dividend))
+    dp.add_handler(CommandHandler("news", news))
+    dp.add_handler(CommandHandler("info", information))
+    dp.add_handler(CommandHandler("stat", stat))
+    dp.add_handler(CommandHandler("stats", stat))
+    dp.add_handler(CommandHandler("cap", cap))
+    dp.add_handler(CommandHandler("trending", trending))
+    dp.add_handler(CommandHandler("search", search))
+    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))
+
+    # Charting can be slow so they run async.
+    dp.add_handler(CommandHandler("intra", intra, run_async=True))
+    dp.add_handler(CommandHandler("intraday", intra, run_async=True))
+    dp.add_handler(CommandHandler("day", intra, run_async=True))
+    dp.add_handler(CommandHandler("chart", chart, run_async=True))
+    dp.add_handler(CommandHandler("month", chart, run_async=True))
+
+    # on noncommand i.e message - echo the message on Telegram
+    dp.add_handler(MessageHandler(Filters.text, symbol_detect))
+    dp.add_handler(MessageHandler(Filters.photo, symbol_detect_image))
+
+    # Inline Bot commands
+    dp.add_handler(InlineQueryHandler(inline_query))
+
+    # Pre-checkout handler to final check
+    dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
+
+    # Payment success
+    dp.add_handler(
+        MessageHandler(Filters.successful_payment, successful_payment_callback)
+    )
+
+    # log all errors
+    dp.add_error_handler(error)
+
+    # Start the Bot
+    updater.start_polling()
+
+    updater.idle()
+
+
+if __name__ == "__main__":
+    main()

cg_Crypto.py

@@ -1,14 +1,17 @@
+"""Class with functions for running the bot with IEX Cloud.
+"""
+
 import logging
-from typing import List
+from datetime import datetime
+from logging import critical, debug, error, info, warning
+from typing import List, Optional, Tuple
 
 import pandas as pd
 import requests as r
 import schedule
 from markdownify import markdownify
 
-from common.Symbol import Coin
+from Symbol import Coin
-
-log = logging.getLogger(__name__)
 
 
 class cg_Crypto:
@@ -18,20 +21,29 @@ class cg_Crypto:
 
     vs_currency = "usd"  # simple/supported_vs_currencies for list of options
 
-    trending_cache: List[str] = []
+    searched_symbols = {}
+    trending_cache = None
 
     def __init__(self) -> None:
+        """Creates a Symbol Object
+
+        Parameters
+        ----------
+        IEX_TOKEN : str
+            IEX Token
+        """
         self.get_symbol_list()
         schedule.every().day.do(self.get_symbol_list)
 
     def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+
         url = "https://api.coingecko.com/api/v3" + endpoint
         resp = r.get(url, params=params, timeout=timeout)
         # Make sure API returned a proper status code
         try:
             resp.raise_for_status()
         except r.exceptions.HTTPError as e:
-            log.error(e)
+            logging.error(e)
             return {}
 
         # Make sure API returned valid JSON
@@ -39,27 +51,36 @@ class cg_Crypto:
             resp_json = resp.json()
             return resp_json
         except r.exceptions.JSONDecodeError as e:
-            log.error(e)
+            logging.error(e)
             return {}
 
     def symbol_id(self, symbol) -> str:
         try:
-            return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[0]
+            return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[
+                0
+            ]
         except KeyError:
             return ""
 
-    def get_symbol_list(self):
+    def get_symbol_list(
+        self, return_df=False
+    ) -> Optional[Tuple[pd.DataFrame, datetime]]:
+
         raw_symbols = self.get("/coins/list")
         symbols = pd.DataFrame(data=raw_symbols)
 
         # Removes all binance-peg symbols
         symbols = symbols[~symbols["id"].str.contains("binance-peg")]
 
-        symbols["description"] = "$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
+        symbols["description"] = (
+            "$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
+        )
         symbols = symbols[["id", "symbol", "name", "description"]]
         symbols["type_id"] = "$$" + symbols["symbol"]
 
         self.symbol_list = symbols
+        if return_df:
+            return symbols, datetime.now()
 
     def status(self) -> str:
         """Checks CoinGecko /ping endpoint for API issues.
@@ -76,11 +97,9 @@ class cg_Crypto:
 
         try:
             status.raise_for_status()
-            return (
+            return f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} Seconds."
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
+        except:
-            )
+            return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} Seconds."
-        except r.HTTPError:
-            return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
 
     def price_reply(self, coin: Coin) -> str:
         """Returns current market price or after hours if its available for a given coin symbol.
@@ -148,7 +167,9 @@ class cg_Crypto:
             f"/coins/{symbol.id}/ohlc",
             params={"vs_currency": self.vs_currency, "days": 1},
         ):
-            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
+            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")
             return df
@@ -174,7 +195,9 @@ class cg_Crypto:
             f"/coins/{symbol.id}/ohlc",
             params={"vs_currency": self.vs_currency, "days": 30},
         ):
-            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
+            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")
             return df
@@ -200,6 +223,7 @@ class cg_Crypto:
                 "localization": "false",
             },
         ):
+
             return f"""
                 [{data['name']}]({data['links']['homepage'][0]}) Statistics:
                 Market Cap: ${data['market_data']['market_cap'][self.vs_currency]:,}
@@ -227,14 +251,14 @@ class cg_Crypto:
         """
 
         if resp := self.get(
-            "/simple/price",
+            f"/simple/price",
             params={
                 "ids": coin.id,
                 "vs_currencies": self.vs_currency,
                 "include_market_cap": "true",
             },
         ):
-            log.debug(resp)
+            debug(resp)
             try:
                 data = resp[coin.id]
 
@@ -246,10 +270,7 @@ class cg_Crypto:
             if cap == 0:
                 return f"The market cap for {coin.name} is not available for unknown reasons."
 
-            message = (
+            message = f"The current price of {coin.name} is $**{price:,}** and its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
-                f"The current price of {coin.name} is $**{price:,}** and"
-                + " its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
-            )
 
         else:
             message = f"The Coin: {coin.name} was not found or returned and error."
@@ -282,7 +303,7 @@ class cg_Crypto:
 
     def spark_reply(self, symbol: Coin) -> str:
         change = self.get(
-            "/simple/price",
+            f"/simple/price",
             params={
                 "ids": symbol.id,
                 "vs_currencies": self.vs_currency,
@@ -310,7 +331,7 @@ class cg_Crypto:
                 sym = c["symbol"].upper()
                 name = c["name"]
                 change = self.get(
-                    "/simple/price",
+                    f"/simple/price",
                     params={
                         "ids": c["id"],
                         "vs_currencies": self.vs_currency,
@@ -323,7 +344,7 @@ class cg_Crypto:
                 trending.append(msg)
 
         except Exception as e:
-            log.warning(e)
+            logging.warning(e)
             return self.trending_cache
 
         self.trending_cache = trending
@@ -344,7 +365,7 @@ class cg_Crypto:
         query = ",".join([c.id for c in coins])
 
         prices = self.get(
-            "/simple/price",
+            f"/simple/price",
             params={
                 "ids": query,
                 "vs_currencies": self.vs_currency,

common/MarketData.py

@@ -1,269 +0,0 @@
-import datetime as dt
-import logging
-import os
-from typing import Dict
-
-import pandas as pd
-import pytz
-import requests as r
-import schedule
-
-from common.Symbol import Stock
-
-log = logging.getLogger(__name__)
-
-
-class MarketData:
-    """
-    Functions for finding stock market information about symbols from MarkData.app
-    """
-
-    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
-
-    charts: Dict[Stock, pd.DataFrame] = {}
-
-    openTime = dt.time(hour=9, minute=30, second=0)
-    marketTimeZone = pytz.timezone("US/Eastern")
-
-    def __init__(self) -> None:
-        """Creates a Symbol Object
-
-        Parameters
-        ----------
-        MARKETDATA_TOKEN : str
-            MarketData.app API Token
-        """
-
-        try:
-            self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
-
-            if self.MARKETDATA_TOKEN == "TOKEN":
-                self.MARKETDATA_TOKEN = ""
-        except KeyError:
-            self.MARKETDATA_TOKEN = ""
-            log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
-            log.warning("Use this affiliate link so that the bot can stay free:")
-            log.warning("https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo")
-
-        if self.MARKETDATA_TOKEN != "":
-            schedule.every().day.do(self.clear_charts)
-
-    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
-        url = "https://api.marketdata.app/v1/" + endpoint
-
-        # set token param if it wasn't passed.
-        params["token"] = self.MARKETDATA_TOKEN
-
-        # Undocumented query variable that ensures bot usage can be
-        # monitored even if someone doesn't make it through an affiliate link.
-        params["application"] = "simplestockbot"
-
-        resp = r.get(url, params=params, timeout=timeout)
-
-        # Make sure API returned a proper status code
-        try:
-            resp.raise_for_status()
-        except r.exceptions.HTTPError as e:
-            logging.error(e)
-            return {}
-
-        # Make sure API returned valid JSON
-        try:
-            resp_json = resp.json()
-
-            match resp_json["s"]:
-                case "ok":
-                    return resp_json
-                case "no_data":
-                    return resp_json
-                case "error":
-                    logging.error("MarketData Error:\n" + resp_json["errmsg"])
-                    return {}
-
-        except r.exceptions.JSONDecodeError as e:
-            logging.error(e)
-
-        return {}
-
-    def clear_charts(self) -> None:
-        """
-        Clears cache of chart data.
-        Charts are cached so that only 1 API call per 24 hours is needed since the
-            chart data is expensive and a large download.
-        """
-        self.charts = {}
-
-    def status(self) -> str:
-        # TODO: At the moment this API is poorly documented, this function likely needs to be revisited later.
-
-        try:
-            status = r.get(
-                "https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A",
-                timeout=5,
-            )
-            status.raise_for_status()
-        except r.HTTPError:
-            return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
-        except r.Timeout:
-            return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
-
-        statusJSON = status.json()
-
-        if statusJSON["status"] == "ok":
-            return (
-                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
-            )
-        else:
-            return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
-
-    def price_reply(self, symbol: Stock) -> str:
-        """Returns price movement of Stock for the last market day, or after hours.
-
-        Parameters
-        ----------
-        symbol : Stock
-
-        Returns
-        -------
-        str
-            Formatted markdown
-        """
-
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
-            price = round(quoteResp["last"][0], 2)
-
-            try:
-                changePercent = round(quoteResp["changepct"][0], 2)
-            except TypeError:
-                return f"The price of {symbol} is {price}"
-
-            message = f"The current price of {symbol.name} is ${price} and "
-
-            if changePercent > 0.0:
-                message += f"is currently up {changePercent}% for the day."
-            elif changePercent < 0.0:
-                message += f"is currently down {changePercent}% for the day."
-            else:
-                message += "hasn't shown any movement for the day."
-
-            return message
-        else:
-            return f"Getting a quote for {symbol} encountered an error."
-
-    def spark_reply(self, symbol: Stock) -> str:
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
-            try:
-                changePercent = round(quoteResp["changepct"][0], 2)
-                return f"`{symbol.tag}`: {changePercent}%"
-            except TypeError:
-                pass
-
-        return f"`{symbol.tag}`"
-
-    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        schedule.run_pending()
-
-        try:
-            return self.charts[symbol.id.upper()]
-        except KeyError:
-            pass
-
-        resolution = "15"  # minutes
-        now = dt.datetime.now(self.marketTimeZone)
-
-        if self.openTime < now.time():
-            startTime = now.replace(hour=9, minute=30)
-        else:
-            startTime = now - dt.timedelta(days=1)
-
-        if data := self.get(
-            f"stocks/candles/{resolution}/{symbol}",
-            params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
-        ):
-            data.pop("s")
-            df = pd.DataFrame(data)
-            df["t"] = pd.to_datetime(df["t"], unit="s", utc=True)
-            df.set_index("t", inplace=True)
-
-            df.rename(
-                columns={
-                    "o": "Open",
-                    "h": "High",
-                    "l": "Low",
-                    "c": "Close",
-                    "v": "Volume",
-                },
-                inplace=True,
-            )
-
-            self.charts[symbol.id.upper()] = df
-            return df
-
-        return pd.DataFrame()
-
-    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        schedule.run_pending()
-
-        try:
-            return self.charts[symbol.id.upper()]
-        except KeyError:
-            pass
-
-        to_date = dt.datetime.today().strftime("%Y-%m-%d")
-        from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
-        resultion = "daily"
-
-        if data := self.get(
-            f"stocks/candles/{resultion}/{symbol}",
-            params={
-                "from": from_date,
-                "to": to_date,
-            },
-        ):
-            data.pop("s")
-
-            df = pd.DataFrame(data)
-            df["t"] = pd.to_datetime(df["t"], unit="s")
-            df.set_index("t", inplace=True)
-
-            df.rename(
-                columns={
-                    "o": "Open",
-                    "h": "High",
-                    "l": "Low",
-                    "c": "Close",
-                    "v": "Volume",
-                },
-                inplace=True,
-            )
-
-            self.charts[symbol.id.upper()] = df
-            return df
-
-        return pd.DataFrame()

common/requirements.txt

@@ -1,6 +0,0 @@
-requests==2.31.0
-pandas==2.1.1
-schedule==1.2.1
-mplfinance==0.12.10b0
-markdownify==0.11.6
-cachetools==5.3.1

dev-reqs.txt

@@ -1,10 +0,0 @@
--r common/requirements.txt
--r docs/requirements.txt
-black==23.7.0
-flake8==6.1.0
-Flake8-pyproject==1.2.3
-pylama==8.4.1
-mypy==1.5.1
-types-cachetools==5.3.0.6
-types-pytz==2023.3.0.1
-ruff==0.0.292

discord/D_info.py

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

discord/Dockerfile

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

discord/bot.py

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

discord/discord-reqs.txt

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

docker-compose.yaml

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

placeholder_Symbol.py

@@ -0,0 +1,158 @@
+"""Class with functions for running the bot with IEX Cloud.
+"""
+
+import logging
+
+import pandas as pd
+
+from Symbol import Stock
+
+
+class placeholder_Symbol:
+    """
+    Functions for finding stock market information about symbols.
+    """
+
+    placeholder_message = """
+    Due to increased costs for market data from IEX Cloud, a new provider will be required for the bot to have stock market data. Until then only cryptocurrency data will be available on the bot.
+    *Track this issue here:* https://t.me/simplestockbotnews
+    """
+
+    def __init__(self) -> None:
+        """Creates a placeholder Symbol Object"""
+
+        logging.warning("Creating a placeholder Symbol.")
+
+    def status(self) -> str:
+        """Checks IEX Status dashboard for any current API issues.
+
+        Returns
+        -------
+        str
+            Human readable text on status of stock market data
+        """
+
+        return self.placeholder_message
+
+    def price_reply(self, symbol: Stock) -> str:
+        """Returns price movement of Stock for the last market day, or after hours.
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+
+        return self.placeholder_message
+
+    def dividend_reply(self, symbol: Stock) -> str:
+        """Returns the most recent, or next dividend date for a stock symbol.
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        return self.placeholder_message
+
+    def news_reply(self, symbol: Stock) -> str:
+        """Gets most recent, english, non-paywalled news
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        return self.placeholder_message
+
+    def info_reply(self, symbol: Stock) -> str:
+        """Gets description for Stock
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted text
+        """
+        return self.placeholder_message
+
+    def stat_reply(self, symbol: Stock) -> str:
+        """Key statistics on a Stock
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+        return self.placeholder_message
+
+    def cap_reply(self, symbol: Stock) -> str:
+        """Get the Market Cap of a stock"""
+
+        return self.placeholder_message
+
+    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol since the last market open.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+
+        return pd.DataFrame()
+
+    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+
+        return pd.DataFrame()
+
+    def spark_reply(self, symbol: Stock) -> str:
+        return ""
+
+    def trending(self) -> list[str]:
+        """Gets current coins trending on IEX. Only returns when market is open.
+
+        Returns
+        -------
+        list[str]
+            list of $ID: NAME, CHANGE%
+        """
+
+        return [self.placeholder_message]

pyproject.toml

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

requirements.txt

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

site/.gitignore

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

site/.gitlab-ci.yml

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

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

site/LICENSE

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

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

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

site/docs/blog/index.md

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

site/docs/blog/posts/intro.md

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

@@ -1,180 +0,0 @@
-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:
-- OTC Support :dollar:
-
-## Get the Bots
-
-[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
-
-## Symbol Detection :material-currency-btc: :bank: :dollar:
-
-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>
-
-## `/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: :dollar:
-
-You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
-full list of stock symbols and return the price of the ticker. Then once you select the ticker
-want the bot will send a message as you in that chat with the latest stock price.
-The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
-`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.

site/docs/contact.md

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

site/docs/donate.md

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

site/docs/host.md

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

site/docs/index.md

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

site/docs/stylesheets/phone.css

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

@@ -1,79 +0,0 @@
-site_name: Simple Stock Bot
-site_url: https://simplestockbot.com
-edit_uri: /simple-stock-bots/site/tree/master/site
-repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
-repo_name: Simple Stock Bots
-
-site_description: Simple Discord and Telegram chat bots for Stock Market Data.
-site_author: Anson Biggs
-copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
-
-
-nav:
-  - Home: index.md
-  - Commands: commands.md
-  - Self-Host: host.md
-  - Donate: donate.md
-  - Contact: contact.md
-  - Blog: /blog
-
-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

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

symbol_router.py

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

telegram/Dockerfile

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

telegram/T_info.py

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

telegram/bot.py

@@ -1,457 +0,0 @@
-# Works with Python 3.8
-import datetime
-import html
-import io
-import json
-import logging
-import os
-import random
-import string
-import traceback
-from uuid import uuid4
-
-import mplfinance as mpf
-import telegram
-from telegram import (
-    InlineQueryResultArticle,
-    InputTextMessageContent,
-    LabeledPrice,
-    Update,
-)
-
-from telegram.ext import (
-    Application,
-    CommandHandler,
-    InlineQueryHandler,
-    PreCheckoutQueryHandler,
-    MessageHandler,
-    filters,
-    ContextTypes,
-)
-
-from common.symbol_router import Router
-from T_info import T_info
-
-# Enable logging
-logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
-
-# set higher logging level for httpx to avoid all GET and POST requests being logged
-logging.getLogger("httpx").setLevel(logging.WARNING)
-
-log = logging.getLogger(__name__)
-
-TELEGRAM_TOKEN = os.environ["TELEGRAM"]
-
-try:
-    STRIPE_TOKEN = os.environ["STRIPE"]
-except KeyError:
-    STRIPE_TOKEN = ""
-    log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
-
-s = Router()
-t = T_info()
-
-
-log.info("Bot script started.")
-
-
-async def start(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send help text when the command /start is issued."""
-    log.info(f"Start command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.help_text,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def help(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send help text when the command /help is issued."""
-    log.info(f"Help command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.help_text,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def license(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Send bots license when the /license command is issued."""
-    log.info(f"License command ran by {update.message.chat.username}")
-    await update.message.reply_text(
-        text=t.license,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def status(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Gather status of bot and dependant services and return important status updates."""
-    log.warning(f"Status command ran by {update.message.chat.username}")
-    bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date
-
-    bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.")
-
-    await update.message.reply_text(
-        text=bot_status,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-    )
-
-
-async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Sets up donation."""
-    log.info(f"Donate command ran by {update.message.chat.username}")
-    chat_id = update.message.chat_id
-
-    if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
-        await update.message.reply_text(
-            text=t.donate_text,
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            disable_notification=True,
-        )
-        amount = 1.0
-    else:
-        amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
-
-    try:
-        price = int(amount * 100)
-    except ValueError:
-        await update.message.reply_text(f"{amount} is not a valid donation amount or number.")
-        return
-    log.info(f"Donation amount: {price} by {update.message.chat.username}")
-
-    await context.bot.send_invoice(
-        chat_id=chat_id,
-        title="Simple Stock Bot Donation",
-        description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
-        payload=f"simple-stock-bot-{chat_id}",
-        provider_token=STRIPE_TOKEN,
-        currency="USD",
-        prices=[LabeledPrice("Donation:", price)],
-        start_parameter="",
-        # suggested_tip_amounts=[100, 500, 1000, 2000],
-        photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
-        photo_width=500,
-        photo_height=500,
-    )
-
-
-async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Approves donation"""
-    log.info("precheckout_callback queried")
-    query = update.pre_checkout_query
-
-    await query.answer(ok=True)
-    # I dont think I need to check since its only donations.
-    # if query.invoice_payload == "simple-stock-bot":
-    #     # answer False pre_checkout_query
-    #     await query.answer(ok=True)
-    # else:
-    #     await query.answer(ok=False, error_message="Something went wrong...")
-
-
-async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Thanks user for donation"""
-    log.info("Successful payment!")
-    await 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):
-    """
-    Makes image captions into text then passes the `update` and `context`
-        to symbol detect so that it can reply cashtags in image captions.
-    """
-    try:
-        if update.message.caption:
-            update.message.text = update.message.caption
-            await symbol_detect(update, context)
-    except AttributeError:
-        return
-
-
-async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """
-    Runs on any message that doesn't have a command and searches for cashtags,
-        then returns the prices of any symbols found.
-    """
-    try:
-        message = update.message.text
-        chat_id = update.message.chat_id
-        if "$" in message:
-            symbols = s.find_symbols(message)
-            log.info("Looking for Symbols")
-        else:
-            return
-    except AttributeError as ex:
-        log.info(ex)
-        return
-    if symbols:
-        # Let user know bot is working
-        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-        log.info(f"Symbols found: {symbols}")
-
-        for reply in s.price_reply(symbols):
-            await update.message.reply_text(
-                text=reply,
-                parse_mode=telegram.constants.ParseMode.MARKDOWN,
-                disable_notification=True,
-            )
-
-
-async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """returns a chart of intraday data for a symbol"""
-    log.info(f"Intra command ran by {update.message.chat.username}")
-
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip().split("@")[0] == "/intra":
-        await update.message.reply_text(
-            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message, trending_weight=5)
-    symbol = symbols[0]
-
-    if len(symbols):
-        symbol = symbols[0]
-    else:
-        await update.message.reply_text("No symbols or coins found.")
-        return
-
-    df = s.intra_reply(symbol)
-    if df.empty:
-        await update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            disable_notification=True,
-        )
-        return
-
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
-
-    buf = io.BytesIO()
-    mpf.plot(
-        df,
-        type="renko",
-        title=f"\n{symbol.name}",
-        volume="Volume" in df.keys(),
-        style="yahoo",
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-    )
-    buf.seek(0)
-
-    await update.message.reply_photo(
-        photo=buf,
-        caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
-        + f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
-        + f"\n\n{s.price_reply([symbol])[0]}",
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """returns a chart of the past month of data for a symbol"""
-    log.info(f"Chart command ran by {update.message.chat.username}")
-
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip().split("@")[0] == "/chart":
-        await update.message.reply_text(
-            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message, trending_weight=10)
-
-    if len(symbols):
-        symbol = symbols[0]
-    else:
-        await update.message.reply_text("No symbols or coins found.")
-        return
-
-    df = s.chart_reply(symbol)
-    if df.empty:
-        await update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.constants.ParseMode.MARKDOWN,
-            disable_notification=True,
-        )
-        return
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
-
-    buf = io.BytesIO()
-    mpf.plot(
-        df,
-        type="candle",
-        title=f"\n{symbol.name}",
-        volume="Volume" in df.keys(),
-        style="yahoo",
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-    )
-    buf.seek(0)
-
-    await update.message.reply_photo(
-        photo=buf,
-        caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
-        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """returns currently trending symbols and how much they've moved in the past trading day."""
-    log.info(f"Trending command ran by {update.message.chat.username}")
-
-    chat_id = update.message.chat_id
-
-    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
-
-    trending_list = s.trending()
-
-    await update.message.reply_text(
-        text=trending_list,
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
-    """
-    Handles inline query. Searches by looking if query is contained
-        in the symbol and returns matches in alphabetical order.
-    """
-
-    if not update.inline_query.query:
-        return
-
-    print(f"Query: {update.inline_query.query}")
-
-    ignored_queries = {"$", "$$", " ", ""}
-
-    if update.inline_query.query.strip() in ignored_queries:
-        default_message = """
-        You can type:\n@SimpleStockBot `[search]`
-        in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
-        """
-
-        await update.inline_query.answer(
-            [
-                InlineQueryResultArticle(
-                    str(uuid4()),
-                    title="Please enter a query. It can be a ticker or a name of a company.",
-                    input_message_content=InputTextMessageContent(
-                        default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
-                    ),
-                )
-            ]
-        )
-
-    matches = s.inline_search(update.inline_query.query)
-
-    results = []
-    for _, row in matches.iterrows():
-        results.append(
-            InlineQueryResultArticle(
-                str(uuid4()),
-                title=row["description"],
-                input_message_content=InputTextMessageContent(
-                    row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
-                ),
-            )
-        )
-
-        if len(results) == 5:
-            await update.inline_query.answer(results, cache_time=60 * 60)
-            log.info("Inline Command was successful")
-            return
-    await update.inline_query.answer(results)
-
-
-async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """For the gamblers. Returns a random symbol to buy and a sell date"""
-    log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}")
-
-    await update.message.reply_text(
-        text=s.random_pick(),
-        parse_mode=telegram.constants.ParseMode.MARKDOWN,
-        disable_notification=True,
-    )
-
-
-async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
-    """Log Errors caused by Updates."""
-    log.warning('Update "%s" caused error "%s"', update, error)
-
-    tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
-    tb_string = "".join(tb_list)
-
-    err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
-    log.warning(f"Logging error: {err_code}")
-
-    if update:
-        log.warning(
-            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"
-            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/telegram-reqs.txt

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

tests.py

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