1
0
mirror of https://gitlab.com/simple-stock-bots/simple-stock-bot.git synced 2026-06-03 21:00:26 +00:00

Compare commits

..

28 Commits

Author SHA1 Message Date
Anson 9180c2fadd dev tooling improvements 2023-09-07 04:50:29 +00:00
Anson 541be6c783 patch to stop inline queries from failing until stock data is added 2023-09-07 04:50:20 +00:00
Anson 160170409e update dependencies 2023-09-04 04:43:45 +00:00
Anson 319c21d790 improve dev tooling 2023-09-03 22:29:04 -06:00
Anson 7b471fcc67 update status commmand 2023-09-04 04:23:30 +00:00
Anson c72978fcac improve dev tooling 2023-09-04 04:20:28 +00:00
Anson 9c51f68bb5 update ptb to v20 2023-09-04 04:19:59 +00:00
Anson 677d720168 give coingecko some credit 2023-09-04 04:19:31 +00:00
Anson 8cb7bce34c fix for marketdata after hours 2023-09-04 04:19:18 +00:00
Anson f364a82aad improve dev tooling 2023-09-04 03:24:49 +00:00
Anson 10c9a5a9e4 Merge branch '101-combine-discord-and-telegram-bots-into-one-repo-and-deploy-with-docker-compose' into 'master'
Resolve "Combine Discord and Telegram bots into one repo and deploy with docker compose"

Closes #101

See merge request simple-stock-bots/simple-telegram-stock-bot!49
2023-09-03 19:01:09 +00:00
Anson 8d749774d4 Resolve "Combine Discord and Telegram bots into one repo and deploy with docker compose" 2023-09-03 19:01:09 +00:00
Anson d6dd6f7353 revert changes to master 2023-09-03 12:02:45 -06:00
Anson 4cf0330734 remove building of containers entirely 2023-09-03 11:56:00 -06:00
Anson b70b0b5d42 try with correct compose 2023-09-03 09:41:47 -06:00
Anson 94c140e96a really fixed this time 2023-09-03 09:33:05 -06:00
Anson aa96ab7af9 move config to correct location 2023-09-03 09:31:38 -06:00
Anson 1f30e73cdc trying circleci 2023-09-03 09:30:31 -06:00
Anson 21b359c756 ignore env file 2023-09-03 01:34:19 -06:00
Anson 2ed995393b refactor telegram bot to use docker compose 2023-09-03 01:29:10 -06:00
Anson 68eca88034 Accidentally pushed stuff I shouldnt have. This is why I need tests and to stop pushing to master 2023-04-11 07:33:00 -06:00
Anson 19e3813e57 Merge branch 'master' of gitlab.com:simple-stock-bots/simple-telegram-stock-bot 2023-04-11 07:28:08 -06:00
Anson 3bcb7d0743 Accidentally pushed stuff I shouldnt have. This is why I need tests and to stop pushing to master 2023-04-11 07:27:31 -06:00
Anson 0cc47c5a5f some message types were causing an error and flooding the logs 2023-04-11 06:51:18 -06:00
Anson 85ff7b7452 Merge branch '89-intra-command-not-working-for-marketdata' into 'master'
Resolve "`/intra` command not working for marketdata"

Closes #89

See merge request simple-stock-bots/simple-telegram-stock-bot!47
2023-04-11 05:21:29 +00:00
Anson 14f461424e Resolve "/intra command not working for marketdata" 2023-04-11 05:21:29 +00:00
Anson 845c929311 Merge branch '97-update-bot-to-use-market-data-affiliate-link' into 'master'
Resolve "Update bot to use market data affiliate link"

Closes #97

See merge request simple-stock-bots/simple-telegram-stock-bot!46
2023-04-11 00:43:28 +00:00
Anson ed7c9f423a Resolve "Update bot to use market data affiliate link" 2023-04-11 00:43:28 +00:00
24 changed files with 901 additions and 625 deletions
+3 -20
View File
@@ -1,20 +1,3 @@
FROM python:3.11-buster AS builder FROM python:3.11
COPY . .
COPY requirements.txt /requirements.txt
RUN pip install --user -r requirements.txt
FROM python:3.11-slim
ENV MPLBACKEND=Agg
COPY --from=builder /root/.local /root/.local
RUN pip install --no-cache-dir black
ENV TELEGRAM=TOKEN
ENV MARKETDATA=TOKEN
COPY . .
# CMD [ "python", "./bot.py" ]
+35 -22
View File
@@ -1,26 +1,39 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: // For format details, see https://aka.ms/devcontainer.json. For config options, see the
// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/docker-existing-dockerfile // README at: https://github.com/devcontainers/templates/tree/main/src/python
{ {
"name": "DockerDev", "name": "Python 3",
// Sets the run context to one level up instead of the .devcontainer folder. // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"context": "..", // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename. "build": {
"dockerFile": "Dockerfile", "dockerfile": "Dockerfile"
// Set *default* container specific settings.json values on container create. },
"settings": {}, "features": {
// Add the IDs of extensions you want installed when the container is created. "ghcr.io/devcontainers-contrib/features/black:2": {},
"extensions": [ "ghcr.io/devcontainers-contrib/features/mypy:2": {},
"ghcr.io/devcontainers-contrib/features/pylint:2": {},
"ghcr.io/devcontainers/features/docker-in-docker": {}
},
"customizations": {
"vscode": {
"extensions": [
"ms-python.python", "ms-python.python",
"ms-azuretools.vscode-docker" "ms-python.black-formatter",
"ms-python.flake8",
"ms-python.vscode-pylance",
"ms-python.isort",
"charliermarsh.ruff"
] ]
// Use 'forwardPorts' to make a list of ports inside the container available locally. }
// "forwardPorts": [], },
// Uncomment the next line to run commands after the container is created - for example installing curl. "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
// "postCreateCommand": "apt-get update && apt-get install -y curl", // Features to add to the dev container. More info: https://containers.dev/features.
// Uncomment when using a ptrace-based debugger like C++, Go, and Rust // "features": {},
// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ], // Use 'forwardPorts' to make a list of ports inside the container available locally.
// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker. // "forwardPorts": [],
// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ], // Use 'postCreateCommand' to run commands after the container is created.
// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root. // "postCreateCommand": "pip3 install --user -r requirements.txt",
// "remoteUser": "vscode" // Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
} }
View File
+2 -1
View File
@@ -1 +1,2 @@
__pycache__ __pycache__
.env
+1 -30
View File
@@ -1,34 +1,5 @@
black: black:
stage: .pre # stage: .pre
image: registry.gitlab.com/pipeline-components/black:latest image: registry.gitlab.com/pipeline-components/black:latest
script: script:
- black --check --verbose -- . - black --check --verbose -- .
build:master:
stage: build
image:
name: gcr.io/kaniko-project/executor:v1.9.0-debug
entrypoint: [""]
script:
- /kaniko/executor
--context "${CI_PROJECT_DIR}"
--dockerfile "${CI_PROJECT_DIR}/Dockerfile"
--destination "${CI_REGISTRY_IMAGE}:latest"
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
build:branch:
stage: build
image:
name: gcr.io/kaniko-project/executor:v1.9.0-debug
entrypoint: [""]
script:
- /kaniko/executor
--context "${CI_PROJECT_DIR}"
--dockerfile "${CI_PROJECT_DIR}/Dockerfile"
--destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_SHORT_SHA}"
--destination "${CI_REGISTRY_IMAGE}:${CI_COMMIT_BRANCH}"
rules:
- if: '$CI_COMMIT_BRANCH != "master"'
-12
View File
@@ -1,12 +0,0 @@
{
"configurations": [
{
"name": "Telegram Bot",
"type": "python",
"request": "launch",
"program": "bot.py",
"console": "integratedTerminal",
"python": "python3.11"
}
]
}
+6 -3
View File
@@ -1,5 +1,8 @@
{ {
"python.formatting.provider": "black", "editor.formatOnSave": true,
"python.linting.mypyEnabled": true, "editor.formatOnPaste": true,
"python.linting.flake8Enabled": true, "editor.formatOnSaveMode": "modificationsIfAvailable",
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
}
} }
+2 -2
View File
@@ -15,7 +15,7 @@ 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 [Market Data](https://www.marketdata.app/). 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.
@@ -29,4 +29,4 @@ If you have any questions get in [touch.](contact.md)
- 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)
- [Market Data](https://www.marketdata.app/) - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
-26
View File
@@ -1,26 +0,0 @@
{
"name": "Simple Stock Bot: Telegram",
"description": "Deploy the Telegram version of the Simple Stock Bot to Heroku",
"keywords": [
"stock",
"telegram",
"chat bot"
],
"website": "https://simplestockbot.com/",
"repository": "https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot",
"logo": "https://gitlab.com/uploads/-/system/project/avatar/10295651/TelegramLogo.jpg",
"env": {
"TELEGRAM": {
"description": "Telegram API key.",
"required": true
},
"MARKETDATA": {
"description": "(https://www.marketdata.app/ API key.",
"required": false
},
"STRIPE": {
"description": "Optional, API key for stripe integration.",
"required": false
}
}
}
+37 -17
View File
@@ -1,13 +1,14 @@
import datetime as dt
import logging import logging
import os import os
import datetime as dt
from typing import Dict from typing import Dict
import pandas as pd import pandas as pd
import pytz
import requests as r import requests as r
import schedule import schedule
from Symbol import Stock from common.Symbol import Stock
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@@ -21,6 +22,9 @@ class MarketData:
charts: Dict[Stock, pd.DataFrame] = {} charts: Dict[Stock, pd.DataFrame] = {}
openTime = dt.time(hour=9, minute=30, second=0)
marketTimeZone = pytz.timezone("US/Eastern")
def __init__(self) -> None: def __init__(self) -> None:
"""Creates a Symbol Object """Creates a Symbol Object
@@ -29,6 +33,7 @@ class MarketData:
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"]
@@ -37,6 +42,8 @@ class MarketData:
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("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)
@@ -45,7 +52,11 @@ class MarketData:
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"] = params.get("token", self.MARKETDATA_TOKEN) params["token"] = self.MARKETDATA_TOKEN
# Undocumented query variable that ensures bot usage can be
# monitored even if someone doesn't make it through an affiliate link.
params["application"] = "simplestockbot"
resp = r.get(url, params=params, timeout=timeout) resp = r.get(url, params=params, timeout=timeout)
@@ -92,7 +103,7 @@ class MarketData:
) )
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."
@@ -100,7 +111,7 @@ class MarketData:
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']}"
@@ -120,7 +131,11 @@ class MarketData:
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)
changePercent = round(quoteResp["changepct"][0], 2)
try:
changePercent = round(quoteResp["changepct"][0], 2)
except TypeError:
return f"The price of {symbol} is {price}"
message = f"The current price of {symbol.name} is ${price} and " message = f"The current price of {symbol.name} is ${price} and "
@@ -137,11 +152,13 @@ class MarketData:
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}/"):
changePercent = round(quoteResp["changepct"][0], 2) try:
return f"`{symbol.tag}`: {changePercent}%" changePercent = round(quoteResp["changepct"][0], 2)
else: return f"`{symbol.tag}`: {changePercent}%"
logging.warning(f"{symbol} did not have 'changepct' field.") except TypeError:
return f"`{symbol.tag}`" pass
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.
@@ -164,18 +181,21 @@ class MarketData:
except KeyError: except KeyError:
pass pass
resolution = "5" # minutes resolution = "15" # minutes
now = dt.datetime.now(self.marketTimeZone)
if self.openTime < now.time():
startTime = now.replace(hour=9, minute=30)
else:
startTime = now - dt.timedelta(days=1)
if data := self.get( if data := self.get(
f"stocks/candles/{resolution}/{symbol}", f"stocks/candles/{resolution}/{symbol}",
params={ params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
"from": dt.datetime.now().strftime("%Y-%m-%d"),
"to": dt.datetime.now().isoformat(),
},
): ):
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", utc=True)
df.set_index("t", inplace=True) df.set_index("t", inplace=True)
df.rename( df.rename(
View File
+367 -367
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 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
+10 -8
View File
@@ -10,9 +10,9 @@ import pandas as pd
import schedule import schedule
from cachetools import TTLCache, cached from cachetools import TTLCache, cached
from cg_Crypto import cg_Crypto from common.cg_Crypto import cg_Crypto
from MarketData import MarketData from common.MarketData import MarketData
from Symbol import Coin, Stock, Symbol from common.Symbol import Coin, Stock, Symbol
from typing import Dict from typing import Dict
@@ -80,7 +80,7 @@ class Router:
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.warning(self.trending_count) log.debug(self.trending_count)
return symbols return symbols
@@ -123,7 +123,8 @@ class Router:
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 = 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()
@@ -338,8 +339,8 @@ class Router:
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 Crypto:\n`" reply += "\n\n🦎Trending on CoinGecko:\n`"
reply += "" * len("Trending Crypto:") + "`\n" reply += "" * len("Trending on CoinGecko:") + "`\n"
for coin in coins: for coin in coins:
reply += coin + "\n" reply += coin + "\n"
@@ -353,7 +354,8 @@ class Router:
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"]))
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}"
+7 -5
View File
@@ -1,7 +1,9 @@
-r requirements.txt -r telegram/requirements.txt
black==23.3.0 black==23.7.0
flake8==5.0.4 flake8==6.1.0
Flake8-pyproject==1.2.3 Flake8-pyproject==1.2.3
pylama==8.4.1 pylama==8.4.1
mypy==1.2.0 mypy==1.5.1
types-cachetools==5.3.0.5 types-cachetools==5.3.0.6
types-pytz==2023.3.0.1
ruff==0.0.287
+65
View File
@@ -0,0 +1,65 @@
"""Functions and Info specific to the discord Bot
"""
import re
import requests as r
class D_info:
license = re.sub(
r"\b\n",
" ",
r.get("https://gitlab.com/simple-stock-bots/simple-discord-stock-bot/-/raw/master/LICENSE").text,
)
help_text = """
Thanks for using this bot, consider supporting it 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=discord)
Keep up with the latest news for the bot in its discord Channel: https://t.me/simplestockbotnews
Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla.
**Commands**
- `/donate [amount in USD]` to donate. 🎗️
- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
- `/trending` Trending Stocks and Cryptos. 💬
- `/help` Get some help using the bot. 🆘
**Inline Features**
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
Market data is provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord)
If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
"""
donate_text = """
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
All donations go directly towards paying for servers, and market data is provided by
[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
Example: `/donate 2` would donate 2 USD.
An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
If you have any questions see the [website](https://docs.simplestockbot.com)
"""
commands = """ # 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. 📊
"""
+4 -3
View File
@@ -1,7 +1,8 @@
FROM python:3.11-buster AS builder FROM python:3.11-buster AS builder
COPY requirements.txt /requirements.txt COPY discord/requirements.txt .
RUN pip install --user -r requirements.txt RUN pip install --user -r requirements.txt
@@ -11,7 +12,7 @@ ENV MPLBACKEND=Agg
COPY --from=builder /root/.local /root/.local COPY --from=builder /root/.local /root/.local
COPY common common
COPY . . COPY discord .
CMD [ "python", "./bot.py" ] CMD [ "python", "./bot.py" ]
+202
View File
@@ -0,0 +1,202 @@
import datetime
import io
import logging
import os
import mplfinance as mpf
import nextcord
from nextcord.ext import commands
from D_info import D_info
from common.symbol_router import Router
DISCORD_TOKEN = os.environ["DISCORD"]
s = Router()
d = D_info()
intents = nextcord.Intents.default()
client = nextcord.Client(intents=intents)
bot = commands.Bot(command_prefix="/", description=d.help_text, intents=intents)
logger = logging.getLogger("nextcord")
logger.setLevel(logging.INFO)
handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
logger.addHandler(handler)
@bot.event
async def on_ready():
logging.info("Starting Simple Stock Bot")
logging.info(f"Logged in as {bot.user.name} {bot.user.id}")
@bot.command()
async def status(ctx: commands):
"""Debug command for diagnosing if the bot is experiencing any issues."""
logging.warning(f"Status command ran by {ctx.message.author}")
message = ""
try:
message = "Contact MisterBiggs#0465 if you need help.\n"
message += s.status(f"Bot recieved your message in: {bot.latency*10:.4f} seconds") + "\n"
except Exception as ex:
logging.critical(ex)
message += (
f"*\n\nERROR ENCOUNTERED:*\n{ex}\n\n"
+ "*The bot encountered an error while attempting to find errors. Please contact the bot admin.*"
)
await ctx.send(message)
@bot.command()
async def license(ctx: commands):
"""Returns the bots license agreement."""
await ctx.send(d.license)
@bot.command()
async def donate(ctx: commands):
"""Details on how to support the development and hosting of the bot."""
await ctx.send(d.donate_text)
@bot.command()
async def search(ctx: commands, *, query: str):
"""Search for a stock symbol using either symbol of company name."""
results = s.search_symbols(query)
if results:
reply = "*Search Results:*\n`$ticker: Company Name`\n"
for query in results:
reply += "`" + query[1] + "`\n"
await ctx.send(reply)
@bot.command()
async def crypto(ctx: commands, _: str):
"""Get the price of a cryptocurrency using in USD."""
await ctx.send("Crypto now has native support. Any crypto can be called using two dollar signs: `$$eth` `$$btc` `$$doge`")
@bot.command()
async def intra(ctx: commands, sym: str):
"""Get a chart for the stocks movement since market open."""
symbols = s.find_symbols(sym)
if len(symbols):
symbol = symbols[0]
else:
await ctx.send("No symbols or coins found.")
return
df = s.intra_reply(symbol)
if df.empty:
await ctx.send("Invalid symbol please see `/help` for usage details.")
return
with ctx.channel.typing():
buf = io.BytesIO()
mpf.plot(
df,
type="renko",
title=f"\n{symbol.name}",
volume="volume" in df.keys(),
style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
)
buf.seek(0)
# Get price so theres no request lag after the image is sent
price_reply = s.price_reply([symbol])[0]
await ctx.send(
file=nextcord.File(
buf,
filename=f"{symbol.name}:intra{datetime.date.today().strftime('%S%M%d%b%Y')}.png",
),
content=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+ f" {df.last_valid_index().strftime('%d %b at %H:%M')}",
)
await ctx.send(price_reply)
@bot.command()
async def chart(ctx: commands, sym: str):
"""returns a chart of the past month of data for a symbol"""
symbols = s.find_symbols(sym)
if len(symbols):
symbol = symbols[0]
else:
await ctx.send("No symbols or coins found.")
return
df = s.chart_reply(symbol)
if df.empty:
await ctx.send("Invalid symbol please see `/help` for usage details.")
return
with ctx.channel.typing():
buf = io.BytesIO()
mpf.plot(
df,
type="candle",
title=f"\n{symbol.name}",
volume="volume" in df.keys(),
style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
)
buf.seek(0)
# Get price so theres no request lag after the image is sent
price_reply = s.price_reply([symbol])[0]
await ctx.send(
file=nextcord.File(
buf,
filename=f"{symbol.name}:1M{datetime.date.today().strftime('%d%b%Y')}.png",
),
content=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+ f" to {df.last_valid_index().strftime('%d, %b %Y')}",
)
await ctx.send(price_reply)
@bot.command()
async def cap(ctx: commands, sym: str):
"""Get the market cap of a symbol"""
symbols = s.find_symbols(sym)
if symbols:
with ctx.channel.typing():
for reply in s.cap_reply(symbols):
await ctx.send(reply)
@bot.command()
async def trending(ctx: commands):
"""Get a list of Trending Stocks and Coins"""
with ctx.channel.typing():
await ctx.send(s.trending())
@bot.event
async def on_message(message):
if message.author.id == bot.user.id:
return
if message.content:
if message.content[0] == "/":
await bot.process_commands(message)
return
if "$" in message.content:
symbols = s.find_symbols(message.content)
if symbols:
for reply in s.price_reply(symbols):
await message.channel.send(reply)
return
bot.run(DISCORD_TOKEN)
@@ -1,4 +1,4 @@
python-telegram-bot==13.5 nextcord==2.4.2
requests==2.25.1 requests==2.25.1
pandas==2.0.0 pandas==2.0.0
schedule==1.0.0 schedule==1.0.0
+13
View File
@@ -0,0 +1,13 @@
version: '3'
services:
telegram:
build:
context: .
dockerfile: telegram/Dockerfile
image: registry.gitlab.com/simple-stock-bots/simple-telegram-stock-bot
env_file: .env
discord:
build:
context: .
dockerfile: discord/Dockerfile
env_file: .env
+4 -1
View File
@@ -5,4 +5,7 @@ line-length = 130
max-line-length = 130 max-line-length = 130
[tool.pycodestyle] [tool.pycodestyle]
max_line_length = 130 max_line_length = 130
[tool.ruff]
line-length = 130
+21
View File
@@ -0,0 +1,21 @@
FROM python:3.11-buster AS builder
COPY telegram/requirements.txt .
RUN pip install --user -r requirements.txt
FROM python:3.11-slim
ENV MPLBACKEND=Agg
COPY --from=builder /root/.local /root/.local
COPY common common
COPY telegram .
CMD [ "python", "./bot.py" ]
+7 -10
View File
@@ -16,6 +16,8 @@ class T_info:
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, consider supporting it 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)
Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews
Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com) Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
@@ -34,7 +36,7 @@ Simply calling a symbol in any message that the bot can see will also return the
**Inline Features** **Inline Features**
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour. You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
Market data is provided by [Market Data](https://www.marketdata.app/) Market data is provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram)
If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact). If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
""" """
@@ -42,27 +44,22 @@ Simply calling a symbol in any message that the bot can see will also return the
donate_text = """ donate_text = """
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson) 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 All donations go directly towards paying for servers, and market data is provided by
[Market Data](https://www.marketdata.app/). [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. The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
Example: `/donate 2` would donate 2 USD. Example: `/donate 2` would donate 2 USD.
An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card. An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
If you have any questions see the [website](https:docs.simplestockbot.com) If you have any questions see the [website](https://docs.simplestockbot.com)
""" """
commands = """ commands = """ # Not used by the bot but for updating commands with BotFather
donate - Donate to the bot 🎗 donate - Donate to the bot 🎗
help - Get some help using the bot. 🆘 help - Get some help using the bot. 🆘
info - $[symbol] General information about the symbol.
news - $[symbol] News about the symbol. 📰
stat - $[symbol] Key statistics about the symbol. 🔢
cap - $[symbol] Market Capitalization of symbol. 💰
dividend - $[symbol] Dividend info 📅
trending - Trending Stocks and Cryptos. 💬 trending - Trending Stocks and Cryptos. 💬
intra - $[symbol] Plot since the last market open. 📈 intra - $[symbol] Plot since the last market open. 📈
chart - $[chart] Plot of the past month. 📊 chart - $[chart] Plot of the past month. 📊
""" # Not used by the bot but for updaing commands with BotFather """
+107 -97
View File
@@ -18,21 +18,26 @@ from telegram import (
LabeledPrice, LabeledPrice,
Update, Update,
) )
from telegram.ext import ( from telegram.ext import (
CallbackContext, Application,
CommandHandler, CommandHandler,
Filters,
InlineQueryHandler, InlineQueryHandler,
MessageHandler,
PreCheckoutQueryHandler, PreCheckoutQueryHandler,
Updater, MessageHandler,
filters,
ContextTypes,
) )
from 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
logging.getLogger("httpx").setLevel(logging.WARNING)
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
TELEGRAM_TOKEN = os.environ["TELEGRAM"] TELEGRAM_TOKEN = os.environ["TELEGRAM"]
@@ -50,58 +55,58 @@ t = T_info()
log.info("Bot script started.") log.info("Bot script started.")
def start(update: Update, context: CallbackContext): 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}")
update.message.reply_text( await update.message.reply_text(
text=t.help_text, text=t.help_text,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def help(update: Update, context: CallbackContext): 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}")
update.message.reply_text( await update.message.reply_text(
text=t.help_text, text=t.help_text,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def license(update: Update, context: CallbackContext): 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}")
update.message.reply_text( await update.message.reply_text(
text=t.license, text=t.license,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def status(update: Update, context: CallbackContext): 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.")
update.message.reply_text( await update.message.reply_text(
text=bot_status, text=bot_status,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
) )
def donate(update: Update, context: CallbackContext): 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:
update.message.reply_text( await update.message.reply_text(
text=t.donate_text, text=t.donate_text,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
amount = 1.0 amount = 1.0
@@ -111,11 +116,11 @@ def donate(update: Update, context: CallbackContext):
try: try:
price = int(amount * 100) price = int(amount * 100)
except ValueError: except ValueError:
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}")
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}",
@@ -131,37 +136,40 @@ def donate(update: Update, context: CallbackContext):
) )
def precheckout_callback(update: Update, context: CallbackContext): 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
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
# query.answer(ok=True) # await query.answer(ok=True)
# else: # else:
# query.answer(ok=False, error_message="Something went wrong...") # await query.answer(ok=False, error_message="Something went wrong...")
def successful_payment_callback(update: Update, context: CallbackContext): 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!")
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!")
def symbol_detect_image(update: Update, context: CallbackContext): 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.
""" """
if update.message.caption: try:
update.message.text = update.message.caption if update.message.caption:
symbol_detect(update, context) update.message.text = update.message.caption
await symbol_detect(update, context)
except AttributeError:
return
def symbol_detect(update: Update, context: CallbackContext): 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.
@@ -179,18 +187,18 @@ def symbol_detect(update: Update, context: CallbackContext):
return return
if symbols: if symbols:
# Let user know bot is working # Let user know bot is working
context.bot.send_chat_action(chat_id=chat_id, action=telegram.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):
update.message.reply_text( await update.message.reply_text(
text=reply, text=reply,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def intra(update: Update, context: CallbackContext): 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}")
@@ -198,7 +206,7 @@ def intra(update: Update, context: CallbackContext):
chat_id = update.message.chat_id chat_id = update.message.chat_id
if message.strip().split("@")[0] == "/intra": if message.strip().split("@")[0] == "/intra":
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
@@ -209,19 +217,19 @@ def intra(update: Update, context: CallbackContext):
if len(symbols): if len(symbols):
symbol = symbols[0] symbol = symbols[0]
else: else:
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:
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.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
return return
context.bot.send_chat_action(chat_id=chat_id, action=telegram.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(
@@ -234,17 +242,17 @@ def intra(update: Update, context: CallbackContext):
) )
buf.seek(0) buf.seek(0)
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')}" + 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.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def chart(update: Update, context: CallbackContext): 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}")
@@ -252,7 +260,7 @@ def chart(update: Update, context: CallbackContext):
chat_id = update.message.chat_id chat_id = update.message.chat_id
if message.strip().split("@")[0] == "/chart": if message.strip().split("@")[0] == "/chart":
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
@@ -262,18 +270,18 @@ def chart(update: Update, context: CallbackContext):
if len(symbols): if len(symbols):
symbol = symbols[0] symbol = symbols[0]
else: else:
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:
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.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
return return
context.bot.send_chat_action(chat_id=chat_id, action=telegram.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(
@@ -286,39 +294,42 @@ def chart(update: Update, context: CallbackContext):
) )
buf.seek(0) buf.seek(0)
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.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def trending(update: Update, context: CallbackContext): 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
context.bot.send_chat_action(chat_id=chat_id, action=telegram.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()
update.message.reply_text( await update.message.reply_text(
text=trending_list, text=trending_list,
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def inline_query(update: Update, context: CallbackContext): 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.
""" """
# info(f"Inline command ran by {update.message.chat.username}")
log.info(f"Query: {update.inline_query.query}") if not update.inline_query.query:
return
print(f"Query: {update.inline_query.query}")
ignored_queries = {"$", "$$", " ", ""} ignored_queries = {"$", "$$", " ", ""}
@@ -328,12 +339,14 @@ def inline_query(update: Update, context: CallbackContext):
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.
""" """
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(default_message, parse_mode=telegram.ParseMode.MARKDOWN), input_message_content=InputTextMessageContent(
default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
),
) )
] ]
) )
@@ -346,29 +359,31 @@ def inline_query(update: Update, context: CallbackContext):
InlineQueryResultArticle( InlineQueryResultArticle(
str(uuid4()), str(uuid4()),
title=row["description"], title=row["description"],
input_message_content=InputTextMessageContent(row["price_reply"], parse_mode=telegram.ParseMode.MARKDOWN), input_message_content=InputTextMessageContent(
row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
),
) )
) )
if len(results) == 5: if len(results) == 5:
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
update.inline_query.answer(results) await update.inline_query.answer(results)
def rand_pick(update: Update, context: CallbackContext): 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}")
update.message.reply_text( await update.message.reply_text(
text=s.random_pick(), text=s.random_pick(),
parse_mode=telegram.ParseMode.MARKDOWN, parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, disable_notification=True,
) )
def error(update: Update, context: CallbackContext): async def 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)
@@ -387,9 +402,9 @@ def error(update: Update, context: CallbackContext):
f"\t{html.escape(tb_string)}" f"\t{html.escape(tb_string)}"
) )
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.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.")
@@ -399,48 +414,43 @@ def error(update: Update, context: CallbackContext):
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.
updater = Updater(TELEGRAM_TOKEN) application = Application.builder().token(TELEGRAM_TOKEN).build()
# Get the dispatcher to register handlers
dp = updater.dispatcher
# on different commands - answer in Telegram # on different commands - answer in Telegram
dp.add_handler(CommandHandler("start", start)) application.add_handler(CommandHandler("start", start))
dp.add_handler(CommandHandler("help", help)) application.add_handler(CommandHandler("help", help))
dp.add_handler(CommandHandler("license", license)) application.add_handler(CommandHandler("license", license))
dp.add_handler(CommandHandler("trending", trending)) application.add_handler(CommandHandler("trending", trending))
dp.add_handler(CommandHandler("random", rand_pick)) application.add_handler(CommandHandler("random", rand_pick))
dp.add_handler(CommandHandler("donate", donate)) application.add_handler(CommandHandler("donate", donate))
dp.add_handler(CommandHandler("status", status)) application.add_handler(CommandHandler("status", status))
dp.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.
dp.add_handler(CommandHandler("intra", intra, run_async=True)) application.add_handler(CommandHandler("intra", intra, block=False))
dp.add_handler(CommandHandler("intraday", intra, run_async=True)) application.add_handler(CommandHandler("intraday", intra, block=False))
dp.add_handler(CommandHandler("day", intra, run_async=True)) application.add_handler(CommandHandler("day", intra, block=False))
dp.add_handler(CommandHandler("chart", chart, run_async=True)) application.add_handler(CommandHandler("chart", chart, block=False))
dp.add_handler(CommandHandler("month", chart, run_async=True)) 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
dp.add_handler(MessageHandler(Filters.text, symbol_detect)) application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
dp.add_handler(MessageHandler(Filters.photo, symbol_detect_image)) application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
# Inline Bot commands # Inline Bot commands
dp.add_handler(InlineQueryHandler(inline_query)) application.add_handler(InlineQueryHandler(inline_query))
# Pre-checkout handler to final check # Pre-checkout handler to final check
dp.add_handler(PreCheckoutQueryHandler(precheckout_callback)) application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
# Payment success # Payment success
dp.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
dp.add_error_handler(error) application.add_error_handler(error)
# Start the Bot # Start the Bot
updater.start_polling() application.run_polling(allowed_updates=Update.ALL_TYPES)
updater.idle()
if __name__ == "__main__": if __name__ == "__main__":
+7
View File
@@ -0,0 +1,7 @@
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