Anson/Simple-Telegram-Stock-Bot
1
0
Fork 0
mirror of https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot.git synced 2025-06-15 22:46:49 +00:00
Code Releases Activity

Resolve "Move docs into the monorepo"

Browse Source
This commit is contained in:
Anson Biggs 2023-10-09 03:31:40 +00:00
parent ad4262777d
commit 045ef09f93
48 changed files with 2590 additions and 2089 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.devcontainer/Dockerfile
View File

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

76
.devcontainer/devcontainer.json
View File

@ -1,39 +1,39 @@
// 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: https://github.com/devcontainers/templates/tree/main/src/python // README at: https://github.com/devcontainers/templates/tree/main/src/python
{ {
"name": "Python 3", "name": "Python 3",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm", // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
"build": { "build": {
"dockerfile": "Dockerfile" "dockerfile": "Dockerfile"
}, },
"features": { "features": {
"ghcr.io/devcontainers-contrib/features/black:2": {}, "ghcr.io/devcontainers-contrib/features/black:2": {},
"ghcr.io/devcontainers-contrib/features/mypy:2": {}, "ghcr.io/devcontainers-contrib/features/mypy:2": {},
"ghcr.io/devcontainers-contrib/features/pylint:2": {}, "ghcr.io/devcontainers-contrib/features/pylint:2": {},
"ghcr.io/devcontainers/features/docker-in-docker": {} "ghcr.io/devcontainers/features/docker-in-docker": {}
}, },
"customizations": { "customizations": {
"vscode": { "vscode": {
"extensions": [ "extensions": [
"ms-python.python", "ms-python.python",
"ms-python.black-formatter", "ms-python.black-formatter",
"ms-python.flake8", "ms-python.flake8",
"ms-python.vscode-pylance", "ms-python.vscode-pylance",
"ms-python.isort", "ms-python.isort",
"charliermarsh.ruff" "charliermarsh.ruff"
] ]
} }
}, },
"postCreateCommand": "pip3 install --user -r dev-reqs.txt" "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
// Features to add to the dev container. More info: https://containers.dev/features. // Features to add to the dev container. More info: https://containers.dev/features.
// "features": {}, // "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally. // Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [], // "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created. // Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "pip3 install --user -r requirements.txt", // "postCreateCommand": "pip3 install --user -r requirements.txt",
// Configure tool-specific properties. // Configure tool-specific properties.
// "customizations": {}, // "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root" // "remoteUser": "root"
} }

2
.gitignore vendored
View File

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

26
.gitlab-ci.yml
View File

@ -1,5 +1,21 @@
black: stages:
# stage: .pre - lint
image: registry.gitlab.com/pipeline-components/black:latest - deploy
script:
- black --check --verbose -- . black:
stage: lint
image: registry.gitlab.com/pipeline-components/black:latest
script:
- black --check --verbose -- .
ruff:
stage: lint
# image: registry.gitlab.com/pipeline-components/ruff:latest
image: python:3.11-slim
script:
- pip3 install ruff
- ruff --output-format gitlab .
include:
- local: /docs/.gitlab-ci.yml

14
.vscode/settings.json vendored
View File

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

42
LICENSE
View File

@ -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.

64
README.md
View File

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

538
common/MarketData.py
View File

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

100
common/Symbol.py
View File

@ -1,50 +1,50 @@
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 MarketData"""
def __init__(self, symbol: str) -> None: def __init__(self, symbol: str) -> None:
self.symbol = symbol self.symbol = symbol
self.id = symbol self.id = symbol
self.name = "$" + symbol.upper() self.name = "$" + symbol.upper()
self.tag = "$" + symbol.lower() self.tag = "$" + symbol.lower()
class Coin(Symbol): class Coin(Symbol):
"""Cryptocurrency Object. Gets data from CoinGecko.""" """Cryptocurrency Object. Gets data from CoinGecko."""
def __init__(self, symbol: pd.DataFrame) -> None: def __init__(self, symbol: pd.DataFrame) -> None:
if len(symbol) > 1: if len(symbol) > 1:
logging.info(f"Crypto with shared id:\n\t{symbol.id}") logging.info(f"Crypto with shared id:\n\t{symbol.id}")
symbol = symbol.head(1) symbol = symbol.head(1)
self.symbol = symbol.symbol.values[0] self.symbol = symbol.symbol.values[0]
self.id = symbol.id.values[0] self.id = symbol.id.values[0]
self.name = symbol.name.values[0] self.name = symbol.name.values[0]
self.tag = symbol.type_id.values[0].upper() self.tag = symbol.type_id.values[0].upper()

734
common/cg_Crypto.py
View File

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

6
common/requirements.txt Normal file
View File

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

790
common/symbol_router.py
View File

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

19
dev-reqs.txt
View File

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

124
discord/D_info.py
View File

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

35
discord/Dockerfile
View File

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

404
discord/bot.py
View File

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

2
discord/discord-reqs.txt Normal file
View File

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

7
discord/requirements.txt
View File

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

24
docker-compose.yaml
View File

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

1
docs/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.cache

12
docs/.gitlab-ci.yml Normal file
View File

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

12
docs/.vscode/settings.json vendored Normal file
View File

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

21
docs/LICENSE Normal file
View File

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

30
docs/README.md Normal file
View File

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

23
docs/docs/LICENSE.md Normal file
View File

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

176
docs/docs/commands.md Normal file
View File

@ -0,0 +1,176 @@
Symbols are used in headings to denote what platforms and symbol types a command supports.
- Telegram Only :fontawesome-brands-telegram-plane:
- Discord Only :fontawesome-brands-discord:
- Bot Commands :robot:
- Cryptocurrency Support :material-currency-btc:
- Stock Market Support :bank:
- OTC Support :dollar:
## 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.

6
docs/docs/contact.md Normal file
View File

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

15
docs/docs/donate.md Normal file
View File

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

41
docs/docs/host.md Normal file
View File

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

BIN
docs/docs/img/Broadcast.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 467 KiB

BIN
docs/docs/img/Chat.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 433 KiB

BIN
docs/docs/img/Connect.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 455 KiB

BIN
docs/docs/img/Discord.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 486 KiB

BIN
docs/docs/img/Telegram-Canary.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 490 KiB

BIN
docs/docs/img/Telegram.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 474 KiB

BIN
docs/docs/img/TgChartChat.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

BIN
docs/docs/img/TgIntraChat.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

29
docs/docs/index.md Normal file
View File

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

40
docs/docs/stylesheets/phone.css Normal file
View File

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

74
docs/mkdocs.yml Normal file
View File

@ -0,0 +1,74 @@
site_name: Simple Stock Bot Docs
site_url: https://docs.simplestockbot.com
edit_uri: /simple-stock-bots/site/tree/master/docs
repo_url: https://gitlab.com/simple-stock-bots
repo_name: Simple Stock Bots
site_description: Simple Discord and Telegram chat bots for Stock Market Data.
site_author: Anson Biggs
copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
nav:
- Home: index.md
- Commands: commands.md
- Hosting: host.md
- Donate: donate.md
- Contact: contact.md
theme:
name: material
language: en
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
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=repo
name: MarketData.app for stock data
extra_css:
- stylesheets/phone.css
plugins:
- search
- social
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg

5
docs/requirements.txt Normal file
View File

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

20
pyproject.toml
View File

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

41
telegram/Dockerfile
View File

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

135
telegram/T_info.py
View File

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

914
telegram/bot.py
View File

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

7
telegram/requirements.txt
View File

@ -1,7 +0,0 @@
python-telegram-bot==20.5
requests==2.31.0
pandas==2.1.0
schedule==1.2.0
mplfinance==0.12.10b0
markdownify==0.11.6
cachetools==5.3.1

2
telegram/telegram-reqs.txt Normal file
View File

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

66
tests.py
View File

@ -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")