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

..

2 Commits

Author SHA1 Message Date
Anson 262ae7c534 fixed typing in file 2023-04-08 18:56:01 -06:00
Anson 4ed8c59828 fixed control flow 2023-04-08 18:52:47 -06:00
50 changed files with 1427 additions and 2236 deletions
+20 -5
View File
@@ -1,5 +1,20 @@
FROM python:3.11 FROM python:3.11-buster AS builder
COPY . .
COPY requirements.txt /requirements.txt
# RUN pip install -r requirements.txt RUN pip install --user -r requirements.txt
FROM python:3.11-slim
ENV MPLBACKEND=Agg
COPY --from=builder /root/.local /root/.local
RUN pip install --no-cache-dir black
ENV TELEGRAM=TOKEN
ENV IEX=TOKEN
COPY . .
# CMD [ "python", "./bot.py" ]
+25 -38
View File
@@ -1,39 +1,26 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// README at: https://github.com/devcontainers/templates/tree/main/src/python // https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/docker-existing-dockerfile
{ {
"name": "Python 3", "name": "DockerDev",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile // Sets the run context to one level up instead of the .devcontainer folder.
// "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm", "context": "..",
"build": { // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerfile": "Dockerfile" "dockerFile": "Dockerfile",
}, // Set *default* container specific settings.json values on container create.
"features": { "settings": {},
"ghcr.io/devcontainers-contrib/features/black:2": {}, // Add the IDs of extensions you want installed when the container is created.
"ghcr.io/devcontainers-contrib/features/mypy:2": {}, "extensions": [
"ghcr.io/devcontainers-contrib/features/pylint:2": {}, "ms-python.python",
"ghcr.io/devcontainers/features/docker-in-docker": {} "ms-azuretools.vscode-docker"
}, ]
"customizations": { // Use 'forwardPorts' to make a list of ports inside the container available locally.
"vscode": { // "forwardPorts": [],
"extensions": [ // Uncomment the next line to run commands after the container is created - for example installing curl.
"ms-python.python", // "postCreateCommand": "apt-get update && apt-get install -y curl",
"ms-python.black-formatter", // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
"ms-python.flake8", // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
"ms-python.vscode-pylance", // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
"ms-python.isort", // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
"charliermarsh.ruff" // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
] // "remoteUser": "vscode"
}
},
"postCreateCommand": "pip3 install --user -r dev-reqs.txt"
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "pip3 install --user -r requirements.txt",
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
} }
View File
+1 -2
View File
@@ -1,2 +1 @@
__pycache__ __pycache__
.env
+34 -21
View File
@@ -1,21 +1,34 @@
stages: black:
- lint stage: .pre
- deploy image: registry.gitlab.com/pipeline-components/black:latest
script:
black: - black --check --verbose -- .
stage: lint
image: registry.gitlab.com/pipeline-components/black:latest
script: build:master:
- black --check --verbose -- . stage: build
image:
ruff: name: gcr.io/kaniko-project/executor:v1.9.0-debug
stage: lint entrypoint: [""]
# image: registry.gitlab.com/pipeline-components/ruff:latest script:
image: python:3.11-slim - /kaniko/executor
script: --context "${CI_PROJECT_DIR}"
- pip3 install ruff --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
- ruff --output-format gitlab . --destination "${CI_REGISTRY_IMAGE}:latest"
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
include:
- local: /docs/.gitlab-ci.yml
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
@@ -0,0 +1,12 @@
{
"configurations": [
{
"name": "Telegram Bot",
"type": "python",
"request": "launch",
"program": "bot.py",
"console": "integratedTerminal",
"python": "python3.11"
}
]
}
+4 -7
View File
@@ -1,8 +1,5 @@
{ {
"editor.formatOnSave": true, "python.formatting.provider": "black",
"editor.formatOnPaste": true, "python.linting.mypyEnabled": true,
"editor.formatOnSaveMode": "modificationsIfAvailable", "python.linting.flake8Enabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
}
} }
+16 -18
View File
@@ -1,19 +1,17 @@
FROM python:3.11-buster AS builder FROM python:3.11-buster AS builder
COPY discord/discord-reqs.txt . COPY requirements.txt /requirements.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 . .
COPY common common
COPY discord .
CMD [ "python", "./bot.py" ] CMD [ "python", "./bot.py" ]
+21 -21
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.
+223 -269
View File
@@ -1,269 +1,223 @@
import datetime as dt """Class with functions for running the bot with IEX Cloud.
import logging """
import os
from typing import Dict import logging
import os
import pandas as pd import datetime as dt
import pytz from logging import warning
import requests as r from typing import Dict
import schedule
import pandas as pd
from common.Symbol import Stock import requests as r
import schedule
log = logging.getLogger(__name__)
from Symbol import Stock
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)
marketTimeZone = pytz.timezone("US/Eastern") def __init__(self) -> None:
"""Creates a Symbol Object
def __init__(self) -> None:
"""Creates a Symbol Object Parameters
----------
Parameters MARKETDATA_TOKEN : str
---------- MarketData.app API Token
MARKETDATA_TOKEN : str """
MarketData.app API Token try:
""" self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
try: if self.MARKETDATA_TOKEN == "TOKEN":
self.MARKETDATA_TOKEN = os.environ["MARKETDATA"] self.MARKETDATA_TOKEN = ""
except KeyError:
if self.MARKETDATA_TOKEN == "TOKEN": self.MARKETDATA_TOKEN = ""
self.MARKETDATA_TOKEN = "" warning("Starting without an MarketData.app Token will not allow you to get market data!")
except KeyError:
self.MARKETDATA_TOKEN = "" if self.MARKETDATA_TOKEN != "":
log.warning("Starting without an MarketData.app Token will not allow you to get market data!") schedule.every().day.do(self.clear_charts)
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") def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
url = "https://api.marketdata.app/v1/" + endpoint
if self.MARKETDATA_TOKEN != "":
schedule.every().day.do(self.clear_charts) # set token param if it wasn't passed.
params["token"] = params.get("token", self.MARKETDATA_TOKEN)
def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
url = "https://api.marketdata.app/v1/" + endpoint resp = r.get(url, params=params, timeout=timeout)
# set token param if it wasn't passed. # Make sure API returned a proper status code
params["token"] = self.MARKETDATA_TOKEN try:
resp.raise_for_status()
# Undocumented query variable that ensures bot usage can be except r.exceptions.HTTPError as e:
# monitored even if someone doesn't make it through an affiliate link. logging.error(e)
params["application"] = "simplestockbot" return {}
resp = r.get(url, params=params, timeout=timeout) # Make sure API returned valid JSON
try:
# Make sure API returned a proper status code resp_json = resp.json()
try:
resp.raise_for_status() match resp_json["s"]:
except r.exceptions.HTTPError as e: case "ok":
logging.error(e) return resp_json
return {} case "no_data":
return resp_json
# Make sure API returned valid JSON case "error":
try: logging.error("MarketData Error:\n" + resp_json["errmsg"])
resp_json = resp.json() return {}
match resp_json["s"]: except r.exceptions.JSONDecodeError as e:
case "ok": logging.error(e)
return resp_json
case "no_data": return {}
return resp_json
case "error": def clear_charts(self) -> None:
logging.error("MarketData Error:\n" + resp_json["errmsg"]) """
return {} Clears cache of chart data.
Charts are cached so that only 1 API call per 24 hours is needed since the
except r.exceptions.JSONDecodeError as e: chart data is expensive and a large download.
logging.error(e) """
self.charts = {}
return {}
def status(self) -> str:
def clear_charts(self) -> None: return "status isnt implemented by marketdata.app"
"""
Clears cache of chart data. def price_reply(self, symbol: Stock) -> str:
Charts are cached so that only 1 API call per 24 hours is needed since the """Returns price movement of Stock for the last market day, or after hours.
chart data is expensive and a large download.
""" Parameters
self.charts = {} ----------
symbol : Stock
def status(self) -> str:
# TODO: At the moment this API is poorly documented, this function likely needs to be revisited later. Returns
-------
try: str
status = r.get( Formatted markdown
"https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A", """
timeout=5,
) if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
status.raise_for_status() price = round(quoteResp["last"][0], 2)
except r.HTTPError: changePercent = round(quoteResp["changepct"][0], 2)
return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
except r.Timeout: message = f"The current price of {symbol.name} is ${price} and "
return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
if changePercent > 0.0:
statusJSON = status.json() message += f"is currently up {changePercent}% for the day."
elif changePercent < 0.0:
if statusJSON["status"] == "ok": message += f"is currently down {changePercent}% for the day."
return ( else:
f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds." message += "hasn't shown any movement for the day."
)
else: return message
return f"MarketData.app is currently reporting the following status: {statusJSON['status']}" else:
return f"Getting a quote for {symbol} encountered an error."
def price_reply(self, symbol: Stock) -> str:
"""Returns price movement of Stock for the last market day, or after hours. 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.
Parameters Also caches multiple requests made in the same day.
----------
symbol : Stock Parameters
----------
Returns symbol : str
------- Stock symbol.
str
Formatted markdown Returns
""" -------
pd.DataFrame
if quoteResp := self.get(f"stocks/quotes/{symbol}/"): Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
price = round(quoteResp["last"][0], 2) """
schedule.run_pending()
try:
changePercent = round(quoteResp["changepct"][0], 2) try:
except TypeError: return self.charts[symbol.id.upper()]
return f"The price of {symbol} is {price}" except KeyError:
pass
message = f"The current price of {symbol.name} is ${price} and "
resolution = "5" # minutes
if changePercent > 0.0:
message += f"is currently up {changePercent}% for the day." if data := self.get(
elif changePercent < 0.0: f"stocks/candles/{resolution}/{symbol}",
message += f"is currently down {changePercent}% for the day." params={
else: "from": dt.datetime.now().strftime("%Y-%m-%d"),
message += "hasn't shown any movement for the day." "to": dt.datetime.now().isoformat(),
},
return message ):
else: data.pop("s")
return f"Getting a quote for {symbol} encountered an error." df = pd.DataFrame(data)
df["t"] = pd.to_datetime(df["t"], unit="s")
def spark_reply(self, symbol: Stock) -> str: df.set_index("t", inplace=True)
if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
try: df.rename(
changePercent = round(quoteResp["changepct"][0], 2) columns={
return f"`{symbol.tag}`: {changePercent}%" "o": "Open",
except TypeError: "h": "High",
pass "l": "Low",
"c": "Close",
return f"`{symbol.tag}`" "v": "Volume",
},
def intra_reply(self, symbol: Stock) -> pd.DataFrame: inplace=True,
"""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.
self.charts[symbol.id.upper()] = df
Parameters return df
----------
symbol : str return pd.DataFrame()
Stock symbol.
def chart_reply(self, symbol: Stock) -> pd.DataFrame:
Returns """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.
pd.DataFrame
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame. Parameters
""" ----------
schedule.run_pending() symbol : str
Stock symbol.
try:
return self.charts[symbol.id.upper()] Returns
except KeyError: -------
pass pd.DataFrame
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
resolution = "15" # minutes """
now = dt.datetime.now(self.marketTimeZone) schedule.run_pending()
if self.openTime < now.time(): try:
startTime = now.replace(hour=9, minute=30) return self.charts[symbol.id.upper()]
else: except KeyError:
startTime = now - dt.timedelta(days=1) pass
if data := self.get( to_date = dt.datetime.today().strftime("%Y-%m-%d")
f"stocks/candles/{resolution}/{symbol}", from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True}, resultion = "daily"
):
data.pop("s") if data := self.get(
df = pd.DataFrame(data) f"stocks/candles/{resultion}/{symbol}",
df["t"] = pd.to_datetime(df["t"], unit="s", utc=True) params={
df.set_index("t", inplace=True) "from": from_date,
"to": to_date,
df.rename( },
columns={ ):
"o": "Open", data.pop("s")
"h": "High",
"l": "Low", df = pd.DataFrame(data)
"c": "Close", df["t"] = pd.to_datetime(df["t"], unit="s")
"v": "Volume", df.set_index("t", inplace=True)
},
inplace=True, df.rename(
) columns={
"o": "Open",
self.charts[symbol.id.upper()] = df "h": "High",
return df "l": "Low",
"c": "Close",
return pd.DataFrame() "v": "Volume",
},
def chart_reply(self, symbol: Stock) -> pd.DataFrame: inplace=True,
"""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.
self.charts[symbol.id.upper()] = df
Parameters return df
----------
symbol : str return pd.DataFrame()
Stock symbol.
Returns
-------
pd.DataFrame
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
"""
schedule.run_pending()
try:
return self.charts[symbol.id.upper()]
except KeyError:
pass
to_date = dt.datetime.today().strftime("%Y-%m-%d")
from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
resultion = "daily"
if data := self.get(
f"stocks/candles/{resultion}/{symbol}",
params={
"from": from_date,
"to": to_date,
},
):
data.pop("s")
df = pd.DataFrame(data)
df["t"] = pd.to_datetime(df["t"], unit="s")
df.set_index("t", inplace=True)
df.rename(
columns={
"o": "Open",
"h": "High",
"l": "Low",
"c": "Close",
"v": "Volume",
},
inplace=True,
)
self.charts[symbol.id.upper()] = df
return df
return pd.DataFrame()
+32 -32
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 [IEX Cloud](https://iexcloud.io/).
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) - [IEX Cloud](https://iexcloud.io/s/62c8503e)
+50 -50
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()
+73
View File
@@ -0,0 +1,73 @@
"""Functions and Info specific to the Telegram Bot
"""
import re
import requests as r
class T_info:
license = re.sub(
r"\b\n",
" ",
r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
)
help_text = """
Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
Keep up with the latest news for the bot in its Telegram Channel: https://t.me/simplestockbotnews
Full documentation on using and running your own stock bot can be found on the bots [docs.](https://docs.simplestockbot.com)
The bot detects _"Symbols"_ using either one `$` or two `$$` dollar signs before the symbol. One dollar sign is for a stock market ticker, while two is for a cryptocurrency coin. `/chart $$eth` would return a chart of the past month of data for Ethereum, while `/dividend $psec` returns dividend information for Prospect Capital stock.
Simply calling a symbol in any message that the bot can see will also return the price. So a message like: `I wonder if $$btc will go to the Moon now that $tsla accepts it as payment` would return the current price for both Bitcoin and Tesla.
**Commands**
- `/donate [amount in USD]` to donate. 🎗️
- `/dividend $[symbol]` Dividend information for the symbol. 📅
- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
- `/news $[symbol]` News about the symbol. 📰
- `/info $[symbol]` General information about the symbol.
- `/stat $[symbol]` Key statistics about the symbol. 🔢
- `/cap $[symbol]` Market Capitalization of symbol. 💰
- `/trending` Trending Stocks and Cryptos. 💬
- `/help` Get some help using the bot. 🆘
**Inline Features**
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. Prices may be delayed by up to an hour.
Market data is provided by [IEX Cloud](https://iexcloud.io)
If you believe the bot is not behaving properly run `/status` or [get in touch](https://docs.simplestockbot.com/contact).
"""
donate_text = """
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
All donations go directly towards paying for servers, and market data is provided by
[IEX Cloud](https://iexcloud.io/).
The easiest way to donate is to run the `/donate [amount in USD]` command with US dollars you would like to donate.
Example: `/donate 2` would donate 2 USD.
An alternative way to donate is through https://www.buymeacoffee.com/Anson which requires no account and accepts Paypal or Credit card.
If you have any questions see the [website](https:docs.simplestockbot.com)
"""
commands = """
donate - Donate to the bot 🎗️
help - Get some help using the bot. 🆘
info - $[symbol] General information about the symbol.
news - $[symbol] News about the symbol. 📰
stat - $[symbol] Key statistics about the symbol. 🔢
cap - $[symbol] Market Capitalization of symbol. 💰
dividend - $[symbol] Dividend info 📅
trending - Trending Stocks and Cryptos. 💬
intra - $[symbol] Plot since the last market open. 📈
chart - $[chart] Plot of the past month. 📊
""" # Not used by the bot but for updaing commands with BotFather
+449 -457
View File
@@ -1,457 +1,449 @@
# 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 import logging as log
from uuid import uuid4
import mplfinance as mpf
import telegram import mplfinance as mpf
from telegram import ( import telegram
InlineQueryResultArticle, from telegram import (
InputTextMessageContent, InlineQueryResultArticle,
LabeledPrice, InputTextMessageContent,
Update, LabeledPrice,
) Update,
)
from telegram.ext import ( from telegram.ext import (
Application, CallbackContext,
CommandHandler, CommandHandler,
InlineQueryHandler, Filters,
PreCheckoutQueryHandler, InlineQueryHandler,
MessageHandler, MessageHandler,
filters, PreCheckoutQueryHandler,
ContextTypes, Updater,
) )
from common.symbol_router import Router from symbol_router import Router
from T_info import T_info from T_info import T_info
# Enable logging TELEGRAM_TOKEN = os.environ["TELEGRAM"]
logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
try:
# set higher logging level for httpx to avoid all GET and POST requests being logged STRIPE_TOKEN = os.environ["STRIPE"]
logging.getLogger("httpx").setLevel(logging.WARNING) except KeyError:
STRIPE_TOKEN = ""
log = logging.getLogger(__name__) log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
TELEGRAM_TOKEN = os.environ["TELEGRAM"] s = Router()
t = T_info()
try:
STRIPE_TOKEN = os.environ["STRIPE"] # Enable logging
except KeyError: logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
STRIPE_TOKEN = ""
log.warning("Starting without a STRIPE Token will not allow you to accept Donations!") logger = logging.getLogger(__name__)
log.info("Bot script started.")
s = Router()
t = T_info()
def start(update: Update, context: CallbackContext):
"""Send help text when the command /start is issued."""
log.info("Bot script started.") log.info(f"Start command ran by {update.message.chat.username}")
update.message.reply_text(
text=t.help_text,
async def start(update: Update, context: ContextTypes.DEFAULT_TYPE): parse_mode=telegram.ParseMode.MARKDOWN,
"""Send help text when the command /start is issued.""" disable_notification=True,
log.info(f"Start command ran by {update.message.chat.username}") )
await update.message.reply_text(
text=t.help_text,
parse_mode=telegram.constants.ParseMode.MARKDOWN, def help(update: Update, context: CallbackContext):
disable_notification=True, """Send help text when the command /help is issued."""
) log.info(f"Help command ran by {update.message.chat.username}")
update.message.reply_text(
text=t.help_text,
async def help(update: Update, context: ContextTypes.DEFAULT_TYPE): parse_mode=telegram.ParseMode.MARKDOWN,
"""Send help text when the command /help is issued.""" disable_notification=True,
log.info(f"Help command ran by {update.message.chat.username}") )
await update.message.reply_text(
text=t.help_text,
parse_mode=telegram.constants.ParseMode.MARKDOWN, def license(update: Update, context: CallbackContext):
disable_notification=True, """Send bots license when the /license command is issued."""
) log.info(f"License command ran by {update.message.chat.username}")
update.message.reply_text(
text=t.license,
async def license(update: Update, context: ContextTypes.DEFAULT_TYPE): parse_mode=telegram.ParseMode.MARKDOWN,
"""Send bots license when the /license command is issued.""" disable_notification=True,
log.info(f"License command ran by {update.message.chat.username}") )
await update.message.reply_text(
text=t.license,
parse_mode=telegram.constants.ParseMode.MARKDOWN, def status(update: Update, context: CallbackContext):
disable_notification=True, """Gather status of bot and dependant services and return important status updates."""
) log.warning(f"Status command ran by {update.message.chat.username}")
bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date
async def status(update: Update, context: ContextTypes.DEFAULT_TYPE): bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.")
"""Gather status of bot and dependant services and return important status updates."""
log.warning(f"Status command ran by {update.message.chat.username}") update.message.reply_text(
bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date text=bot_status,
parse_mode=telegram.ParseMode.MARKDOWN,
bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.") )
await update.message.reply_text(
text=bot_status, def donate(update: Update, context: CallbackContext):
parse_mode=telegram.constants.ParseMode.MARKDOWN, """Sets up donation."""
) log.info(f"Donate command ran by {update.message.chat.username}")
chat_id = update.message.chat_id
async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE): if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
"""Sets up donation.""" update.message.reply_text(
log.info(f"Donate command ran by {update.message.chat.username}") text=t.donate_text,
chat_id = update.message.chat_id parse_mode=telegram.ParseMode.MARKDOWN,
disable_notification=True,
if update.message.text.strip() == "/donate" or "/donate@" in update.message.text: )
await update.message.reply_text( amount = 1.0
text=t.donate_text, else:
parse_mode=telegram.constants.ParseMode.MARKDOWN, amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
disable_notification=True,
) try:
amount = 1.0 price = int(amount * 100)
else: except ValueError:
amount = float(update.message.text.replace("/donate", "").replace("$", "").strip()) update.message.reply_text(f"{amount} is not a valid donation amount or number.")
return
try: log.info(f"Donation amount: {price} by {update.message.chat.username}")
price = int(amount * 100)
except ValueError: context.bot.send_invoice(
await update.message.reply_text(f"{amount} is not a valid donation amount or number.") chat_id=chat_id,
return title="Simple Stock Bot Donation",
log.info(f"Donation amount: {price} 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}",
await context.bot.send_invoice( provider_token=STRIPE_TOKEN,
chat_id=chat_id, currency="USD",
title="Simple Stock Bot Donation", prices=[LabeledPrice("Donation:", price)],
description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}", start_parameter="",
payload=f"simple-stock-bot-{chat_id}", # suggested_tip_amounts=[100, 500, 1000, 2000],
provider_token=STRIPE_TOKEN, photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
currency="USD", photo_width=500,
prices=[LabeledPrice("Donation:", price)], photo_height=500,
start_parameter="", )
# suggested_tip_amounts=[100, 500, 1000, 2000],
photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
photo_width=500, def precheckout_callback(update: Update, context: CallbackContext):
photo_height=500, """Approves donation"""
) log.info("precheckout_callback queried")
query = update.pre_checkout_query
async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE): query.answer(ok=True)
"""Approves donation""" # I dont think I need to check since its only donations.
log.info("precheckout_callback queried") # if query.invoice_payload == "simple-stock-bot":
query = update.pre_checkout_query # # answer False pre_checkout_query
# query.answer(ok=True)
await query.answer(ok=True) # else:
# I dont think I need to check since its only donations. # query.answer(ok=False, error_message="Something went wrong...")
# if query.invoice_payload == "simple-stock-bot":
# # answer False pre_checkout_query
# await query.answer(ok=True) def successful_payment_callback(update: Update, context: CallbackContext):
# else: """Thanks user for donation"""
# await query.answer(ok=False, error_message="Something went wrong...") log.info("Successful payment!")
update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""Thanks user for donation""" def symbol_detect_image(update: Update, context: CallbackContext):
log.info("Successful payment!") """
await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!") Makes image captions into text then passes the `update` and `context`
to symbol detect so that it can reply cashtags in image captions.
"""
async def symbol_detect_image(update: Update, context: ContextTypes.DEFAULT_TYPE): if update.message.caption:
""" update.message.text = update.message.caption
Makes image captions into text then passes the `update` and `context` symbol_detect(update, context)
to symbol detect so that it can reply cashtags in image captions.
"""
try: def symbol_detect(update: Update, context: CallbackContext):
if update.message.caption: """
update.message.text = update.message.caption Runs on any message that doesn't have a command and searches for cashtags,
await symbol_detect(update, context) then returns the prices of any symbols found.
except AttributeError: """
return try:
message = update.message.text
chat_id = update.message.chat_id
async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE): if "$" in message:
""" symbols = s.find_symbols(message)
Runs on any message that doesn't have a command and searches for cashtags, log.info("Looking for Symbols")
then returns the prices of any symbols found. else:
""" return
try: except AttributeError as ex:
message = update.message.text log.info(ex)
chat_id = update.message.chat_id return
if "$" in message: if symbols:
symbols = s.find_symbols(message) # Let user know bot is working
log.info("Looking for Symbols") context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
else: log.info(f"Symbols found: {symbols}")
return
except AttributeError as ex: for reply in s.price_reply(symbols):
log.info(ex) update.message.reply_text(
return text=reply,
if symbols: parse_mode=telegram.ParseMode.MARKDOWN,
# Let user know bot is working disable_notification=True,
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING) )
log.info(f"Symbols found: {symbols}")
for reply in s.price_reply(symbols): def intra(update: Update, context: CallbackContext):
await update.message.reply_text( """returns a chart of intraday data for a symbol"""
text=reply, log.info(f"Intra command ran by {update.message.chat.username}")
parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, message = update.message.text
) chat_id = update.message.chat_id
if message.strip().split("@")[0] == "/intra":
async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE): update.message.reply_text(
"""returns a chart of intraday data for a symbol""" "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
log.info(f"Intra command ran by {update.message.chat.username}") )
return
message = update.message.text
chat_id = update.message.chat_id symbols = s.find_symbols(message, trending_weight=5)
symbol = symbols[0]
if message.strip().split("@")[0] == "/intra":
await update.message.reply_text( if len(symbols):
"This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla" symbol = symbols[0]
) else:
return update.message.reply_text("No symbols or coins found.")
return
symbols = s.find_symbols(message, trending_weight=5)
symbol = symbols[0] df = s.intra_reply(symbol)
if df.empty:
if len(symbols): update.message.reply_text(
symbol = symbols[0] text="Invalid symbol please see `/help` for usage details.",
else: parse_mode=telegram.ParseMode.MARKDOWN,
await update.message.reply_text("No symbols or coins found.") disable_notification=True,
return )
return
df = s.intra_reply(symbol)
if df.empty: context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
await update.message.reply_text(
text="Invalid symbol please see `/help` for usage details.", buf = io.BytesIO()
parse_mode=telegram.constants.ParseMode.MARKDOWN, mpf.plot(
disable_notification=True, df,
) type="renko",
return title=f"\n{symbol.name}",
volume="Volume" in df.keys(),
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO) style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
buf = io.BytesIO() )
mpf.plot( buf.seek(0)
df,
type="renko", update.message.reply_photo(
title=f"\n{symbol.name}", photo=buf,
volume="Volume" in df.keys(), caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
style="yahoo", + f" {df.last_valid_index().strftime('%d %b at %H:%M')}"
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"), + f"\n\n{s.price_reply([symbol])[0]}",
) parse_mode=telegram.ParseMode.MARKDOWN,
buf.seek(0) disable_notification=True,
)
await update.message.reply_photo(
photo=buf,
caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to" def chart(update: Update, context: CallbackContext):
+ f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}" """returns a chart of the past month of data for a symbol"""
+ f"\n\n{s.price_reply([symbol])[0]}", log.info(f"Chart command ran by {update.message.chat.username}")
parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, message = update.message.text
) chat_id = update.message.chat_id
if message.strip().split("@")[0] == "/chart":
async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE): update.message.reply_text(
"""returns a chart of the past month of data for a symbol""" "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
log.info(f"Chart command ran by {update.message.chat.username}") )
return
message = update.message.text
chat_id = update.message.chat_id symbols = s.find_symbols(message, trending_weight=10)
if message.strip().split("@")[0] == "/chart": if len(symbols):
await update.message.reply_text( symbol = symbols[0]
"This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla" else:
) update.message.reply_text("No symbols or coins found.")
return return
symbols = s.find_symbols(message, trending_weight=10) df = s.chart_reply(symbol)
if df.empty:
if len(symbols): update.message.reply_text(
symbol = symbols[0] text="Invalid symbol please see `/help` for usage details.",
else: parse_mode=telegram.ParseMode.MARKDOWN,
await update.message.reply_text("No symbols or coins found.") disable_notification=True,
return )
return
df = s.chart_reply(symbol) context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO)
if df.empty:
await update.message.reply_text( buf = io.BytesIO()
text="Invalid symbol please see `/help` for usage details.", mpf.plot(
parse_mode=telegram.constants.ParseMode.MARKDOWN, df,
disable_notification=True, type="candle",
) title=f"\n{symbol.name}",
return volume="Volume" in df.keys(),
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO) style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
buf = io.BytesIO() )
mpf.plot( buf.seek(0)
df,
type="candle", update.message.reply_photo(
title=f"\n{symbol.name}", photo=buf,
volume="Volume" in df.keys(), caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
style="yahoo", + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"), parse_mode=telegram.ParseMode.MARKDOWN,
) disable_notification=True,
buf.seek(0) )
await update.message.reply_photo(
photo=buf, def trending(update: Update, context: CallbackContext):
caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}" """returns currently trending symbols and how much they've moved in the past trading day."""
+ f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}", log.info(f"Trending command ran by {update.message.chat.username}")
parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, chat_id = update.message.chat_id
)
context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE): trending_list = s.trending()
"""returns currently trending symbols and how much they've moved in the past trading day.""" log.info(trending_list)
log.info(f"Trending command ran by {update.message.chat.username}")
update.message.reply_text(
chat_id = update.message.chat_id text=trending_list,
parse_mode=telegram.ParseMode.MARKDOWN,
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING) disable_notification=True,
)
trending_list = s.trending()
await update.message.reply_text( def inline_query(update: Update, context: CallbackContext):
text=trending_list, """
parse_mode=telegram.constants.ParseMode.MARKDOWN, Handles inline query. Searches by looking if query is contained
disable_notification=True, 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}")
async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
""" ignored_queries = {"$", "$$", " ", ""}
Handles inline query. Searches by looking if query is contained
in the symbol and returns matches in alphabetical order. if update.inline_query.query.strip() in ignored_queries:
""" default_message = """
You can type:\n@SimpleStockBot `[search]`
if not update.inline_query.query: in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
return """
print(f"Query: {update.inline_query.query}") update.inline_query.answer(
[
ignored_queries = {"$", "$$", " ", ""} InlineQueryResultArticle(
str(uuid4()),
if update.inline_query.query.strip() in ignored_queries: title="Please enter a query. It can be a ticker or a name of a company.",
default_message = """ input_message_content=InputTextMessageContent(default_message, parse_mode=telegram.ParseMode.MARKDOWN),
You can type:\n@SimpleStockBot `[search]` )
in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price. ]
""" )
await update.inline_query.answer( matches = s.inline_search(update.inline_query.query)
[
InlineQueryResultArticle( results = []
str(uuid4()), for _, row in matches.iterrows():
title="Please enter a query. It can be a ticker or a name of a company.", results.append(
input_message_content=InputTextMessageContent( InlineQueryResultArticle(
default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN str(uuid4()),
), title=row["description"],
) input_message_content=InputTextMessageContent(row["price_reply"], parse_mode=telegram.ParseMode.MARKDOWN),
] )
) )
matches = s.inline_search(update.inline_query.query) if len(results) == 5:
update.inline_query.answer(results, cache_time=60 * 60)
results = [] log.info("Inline Command was successful")
for _, row in matches.iterrows(): return
results.append( update.inline_query.answer(results)
InlineQueryResultArticle(
str(uuid4()),
title=row["description"], def rand_pick(update: Update, context: CallbackContext):
input_message_content=InputTextMessageContent( """For the gamblers. Returns a random symbol to buy and a sell date"""
row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}")
),
) update.message.reply_text(
) text=s.random_pick(),
parse_mode=telegram.ParseMode.MARKDOWN,
if len(results) == 5: disable_notification=True,
await update.inline_query.answer(results, cache_time=60 * 60) )
log.info("Inline Command was successful")
return
await update.inline_query.answer(results) def error(update: Update, context: CallbackContext):
"""Log Errors caused by Updates."""
log.warning('Update "%s" caused error "%s"', update, error)
async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""For the gamblers. Returns a random symbol to buy and a sell date""" tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}") tb_string = "".join(tb_list)
await update.message.reply_text( err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
text=s.random_pick(), log.warning(f"Logging error: {err_code}")
parse_mode=telegram.constants.ParseMode.MARKDOWN,
disable_notification=True, if update:
) message = (
f"An exception was raised while handling an update\n"
f"<pre>update = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}"
async def error(update: Update, context: ContextTypes.DEFAULT_TYPE): "</pre>\n\n"
"""Log Errors caused by Updates.""" f"<pre>context.chat_data = {html.escape(str(context.chat_data))}</pre>\n\n"
log.warning('Update "%s" caused error "%s"', update, error) f"<pre>context.user_data = {html.escape(str(context.user_data))}</pre>\n\n"
f"<pre>{html.escape(tb_string)}</pre>"
tb_list = traceback.format_exception(None, context.error, context.error.__traceback__) )
tb_string = "".join(tb_list) log.warning(message)
else:
err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)]) log.warning(tb_string)
log.warning(f"Logging error: {err_code}")
update.message.reply_text(
if update: text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
log.warning( parse_mode=telegram.ParseMode.MARKDOWN,
f"An exception was raised while handling an update\n" )
f"\tupdate = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}\n"
f"\tcontext.chat_data = {str(context.chat_data)}\n"
f"\tcontext.user_data = {str(context.user_data)}\n" def main():
f"\t{html.escape(tb_string)}" """Start the context.bot."""
) # Create the EventHandler and pass it your bot's token.
updater = Updater(TELEGRAM_TOKEN)
await update.message.reply_text(
text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`", # Get the dispatcher to register handlers
parse_mode=telegram.constants.ParseMode.MARKDOWN, dp = updater.dispatcher
)
else: # on different commands - answer in Telegram
log.warning("No message to send to user.") dp.add_handler(CommandHandler("start", start))
log.warning(tb_string) dp.add_handler(CommandHandler("help", help))
dp.add_handler(CommandHandler("license", license))
dp.add_handler(CommandHandler("trending", trending))
def main(): dp.add_handler(CommandHandler("random", rand_pick))
"""Start the context.bot.""" dp.add_handler(CommandHandler("donate", donate))
# Create the EventHandler and pass it your bot's token. dp.add_handler(CommandHandler("status", status))
application = Application.builder().token(TELEGRAM_TOKEN).build() dp.add_handler(CommandHandler("inline", inline_query))
# on different commands - answer in Telegram # Charting can be slow so they run async.
application.add_handler(CommandHandler("start", start)) dp.add_handler(CommandHandler("intra", intra, run_async=True))
application.add_handler(CommandHandler("help", help)) dp.add_handler(CommandHandler("intraday", intra, run_async=True))
application.add_handler(CommandHandler("license", license)) dp.add_handler(CommandHandler("day", intra, run_async=True))
application.add_handler(CommandHandler("trending", trending)) dp.add_handler(CommandHandler("chart", chart, run_async=True))
application.add_handler(CommandHandler("random", rand_pick)) dp.add_handler(CommandHandler("month", chart, run_async=True))
application.add_handler(CommandHandler("donate", donate))
application.add_handler(CommandHandler("status", status)) # on noncommand i.e message - echo the message on Telegram
application.add_handler(CommandHandler("inline", inline_query)) dp.add_handler(MessageHandler(Filters.text, symbol_detect))
dp.add_handler(MessageHandler(Filters.photo, symbol_detect_image))
# Charting can be slow so they run async.
application.add_handler(CommandHandler("intra", intra, block=False)) # Inline Bot commands
application.add_handler(CommandHandler("intraday", intra, block=False)) dp.add_handler(InlineQueryHandler(inline_query))
application.add_handler(CommandHandler("day", intra, block=False))
application.add_handler(CommandHandler("chart", chart, block=False)) # Pre-checkout handler to final check
application.add_handler(CommandHandler("month", chart, block=False)) dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
# on noncommand i.e message - echo the message on Telegram # Payment success
application.add_handler(MessageHandler(filters.TEXT, symbol_detect)) dp.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
# log all errors
# Inline Bot commands dp.add_error_handler(error)
application.add_handler(InlineQueryHandler(inline_query))
# Start the Bot
# Pre-checkout handler to final check updater.start_polling()
application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
updater.idle()
# Payment success
application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
if __name__ == "__main__":
# log all errors main()
application.add_error_handler(error)
# Start the Bot
application.run_polling(allowed_updates=Update.ALL_TYPES)
if __name__ == "__main__":
main()
+14 -6
View File
@@ -1,4 +1,7 @@
import logging """Class with functions for running the bot with IEX Cloud.
"""
import logging as log
from typing import List from typing import List
import pandas as pd import pandas as pd
@@ -6,9 +9,7 @@ import requests as r
import schedule import schedule
from markdownify import markdownify from markdownify import markdownify
from common.Symbol import Coin from Symbol import Coin
log = logging.getLogger(__name__)
class cg_Crypto: class cg_Crypto:
@@ -21,6 +22,13 @@ class cg_Crypto:
trending_cache: List[str] = [] trending_cache: List[str] = []
def __init__(self) -> None: def __init__(self) -> None:
"""Creates a Symbol Object
Parameters
----------
IEX_TOKEN : str
IEX Token
"""
self.get_symbol_list() self.get_symbol_list()
schedule.every().day.do(self.get_symbol_list) schedule.every().day.do(self.get_symbol_list)
@@ -77,10 +85,10 @@ class cg_Crypto:
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.
-6
View File
@@ -1,6 +0,0 @@
requests==2.31.0
pandas==2.1.1
schedule==1.2.1
mplfinance==0.12.10b0
markdownify==0.11.6
cachetools==5.3.1
+6 -10
View File
@@ -1,10 +1,6 @@
-r common/requirements.txt -r requirements.txt
-r docs/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.6
types-pytz==2023.3.0.1
ruff==0.0.292
-59
View File
@@ -1,59 +0,0 @@
"""Functions and Info specific to the discord Bot
"""
import re
import requests as r
class D_info:
license = re.sub(
r"\b\n",
" ",
r.get("https://gitlab.com/simple-stock-bots/simple-discord-stock-bot/-/raw/master/LICENSE").text,
)
help_text = """
Thanks for using this bot. If you like it, [support me with a beer](https://www.buymeacoffee.com/Anson). 🍻
For stock data or hosting your own bot, use my link. This helps keep the bot free:
[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
**Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
**Documentation**: All details about the bot are at [docs](https://docs.simplestockbot.com).
The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
- `/chart $$eth` gives Ethereum's monthly chart.
- `/dividend $psec` shows Prospect Capital's dividend.
Type any symbol, and the bot shows its price. Like: `Is $$btc rising since $tsla accepts it?` will give Bitcoin and Tesla prices.
**Commands**
- `/donate [USD amount]`: Support the bot. 🎗️
- `/intra $[symbol]`: See stock's latest movement. 📈
- `/chart $[symbol]`: View a month's stock activity. 📊
- `/trending`: Check trending stocks and cryptos. 💬
- `/help`: Need help? Ask here. 🆘
**Inline Features**
Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. Note: Prices might be delayed up to an hour.
Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
Issues with the bot? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
"""
donate_text = """
Simple Stock Bot runs purely on [donations.](https://www.buymeacoffee.com/Anson)
Every donation supports server costs and
[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord) provides our data.
**How to Donate?**
1. Use `/donate [amount in USD]` command.
- E.g., `/donate 2` donates 2 USD.
2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
- It's quick, doesn't need an account, and accepts Paypal or Credit card.
Questions? Visit our [website](https://docs.simplestockbot.com).
"""
-202
View File
@@ -1,202 +0,0 @@
import datetime
import io
import logging
import os
import mplfinance as mpf
import nextcord
from nextcord.ext import commands
from D_info import D_info
from common.symbol_router import Router
DISCORD_TOKEN = os.environ["DISCORD"]
s = Router()
d = D_info()
intents = nextcord.Intents.default()
client = nextcord.Client(intents=intents)
bot = commands.Bot(command_prefix="/", description=d.help_text, intents=intents)
logger = logging.getLogger("nextcord")
logger.setLevel(logging.INFO)
handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
logger.addHandler(handler)
@bot.event
async def on_ready():
logging.info("Starting Simple Stock Bot")
logging.info(f"Logged in as {bot.user.name} {bot.user.id}")
@bot.command()
async def status(ctx: commands):
"""Debug command for diagnosing if the bot is experiencing any issues."""
logging.warning(f"Status command ran by {ctx.message.author}")
message = ""
try:
message = "Contact MisterBiggs#0465 if you need help.\n"
message += s.status(f"Bot recieved your message in: {bot.latency*10:.4f} seconds") + "\n"
except Exception as ex:
logging.critical(ex)
message += (
f"*\n\nERROR ENCOUNTERED:*\n{ex}\n\n"
+ "*The bot encountered an error while attempting to find errors. Please contact the bot admin.*"
)
await ctx.send(message)
@bot.command()
async def license(ctx: commands):
"""Returns the bots license agreement."""
await ctx.send(d.license)
@bot.command()
async def donate(ctx: commands):
"""Details on how to support the development and hosting of the bot."""
await ctx.send(d.donate_text)
@bot.command()
async def search(ctx: commands, *, query: str):
"""Search for a stock symbol using either symbol of company name."""
results = s.search_symbols(query)
if results:
reply = "*Search Results:*\n`$ticker: Company Name`\n"
for query in results:
reply += "`" + query[1] + "`\n"
await ctx.send(reply)
@bot.command()
async def crypto(ctx: commands, _: str):
"""Get the price of a cryptocurrency using in USD."""
await ctx.send("Crypto now has native support. Any crypto can be called using two dollar signs: `$$eth` `$$btc` `$$doge`")
@bot.command()
async def intra(ctx: commands, sym: str):
"""Get a chart for the stocks movement since market open."""
symbols = s.find_symbols(sym)
if len(symbols):
symbol = symbols[0]
else:
await ctx.send("No symbols or coins found.")
return
df = s.intra_reply(symbol)
if df.empty:
await ctx.send("Invalid symbol please see `/help` for usage details.")
return
with ctx.channel.typing():
buf = io.BytesIO()
mpf.plot(
df,
type="renko",
title=f"\n{symbol.name}",
volume="volume" in df.keys(),
style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
)
buf.seek(0)
# Get price so theres no request lag after the image is sent
price_reply = s.price_reply([symbol])[0]
await ctx.send(
file=nextcord.File(
buf,
filename=f"{symbol.name}:intra{datetime.date.today().strftime('%S%M%d%b%Y')}.png",
),
content=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+ f" {df.last_valid_index().strftime('%d %b at %H:%M')}",
)
await ctx.send(price_reply)
@bot.command()
async def chart(ctx: commands, sym: str):
"""returns a chart of the past month of data for a symbol"""
symbols = s.find_symbols(sym)
if len(symbols):
symbol = symbols[0]
else:
await ctx.send("No symbols or coins found.")
return
df = s.chart_reply(symbol)
if df.empty:
await ctx.send("Invalid symbol please see `/help` for usage details.")
return
with ctx.channel.typing():
buf = io.BytesIO()
mpf.plot(
df,
type="candle",
title=f"\n{symbol.name}",
volume="volume" in df.keys(),
style="yahoo",
savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
)
buf.seek(0)
# Get price so theres no request lag after the image is sent
price_reply = s.price_reply([symbol])[0]
await ctx.send(
file=nextcord.File(
buf,
filename=f"{symbol.name}:1M{datetime.date.today().strftime('%d%b%Y')}.png",
),
content=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+ f" to {df.last_valid_index().strftime('%d, %b %Y')}",
)
await ctx.send(price_reply)
@bot.command()
async def cap(ctx: commands, sym: str):
"""Get the market cap of a symbol"""
symbols = s.find_symbols(sym)
if symbols:
with ctx.channel.typing():
for reply in s.cap_reply(symbols):
await ctx.send(reply)
@bot.command()
async def trending(ctx: commands):
"""Get a list of Trending Stocks and Coins"""
with ctx.channel.typing():
await ctx.send(s.trending())
@bot.event
async def on_message(message):
if message.author.id == bot.user.id:
return
if message.content:
if message.content[0] == "/":
await bot.process_commands(message)
return
if "$" in message.content:
symbols = s.find_symbols(message.content)
if symbols:
for reply in s.price_reply(symbols):
await message.channel.send(reply)
return
bot.run(DISCORD_TOKEN)
-2
View File
@@ -1,2 +0,0 @@
nextcord==2.4.2
-r requirements.txt
-13
View File
@@ -1,13 +0,0 @@
version: '3'
services:
telegram:
build:
context: .
dockerfile: telegram/Dockerfile
image: registry.gitlab.com/simple-stock-bots/simple-telegram-stock-bot
env_file: .env
discord:
build:
context: .
dockerfile: discord/Dockerfile
env_file: .env
-1
View File
@@ -1 +0,0 @@
.cache
-12
View File
@@ -1,12 +0,0 @@
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
View File
@@ -1,12 +0,0 @@
{
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
},
"yaml.customTags": [
"!ENV scalar",
"!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
}
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2019 Anson Biggs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-30
View File
@@ -1,30 +0,0 @@
# 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
View File
@@ -1,23 +0,0 @@
```
MIT License
Copyright (c) 2019 Anson Biggs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
-176
View File
@@ -1,176 +0,0 @@
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
View File
@@ -1,6 +0,0 @@
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
View File
@@ -1,15 +0,0 @@
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
View File
@@ -1,41 +0,0 @@
# 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.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 467 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 433 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 455 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 486 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 490 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 474 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

-29
View File
@@ -1,29 +0,0 @@
# 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
View File
@@ -1,40 +0,0 @@
/* https://codepen.io/RG/pen/bdfDI */
.phone {
background: none repeat scroll 0 0 #fff;
/*border-left: 1px solid #ccc;
border-right: 1px solid #ccc;*/
color: #ffffff;
font-family: sans-serif;
line-height: 20px;
width: 80%;
margin: 0 auto;
overflow-x: hidden;
position: relative;
border-radius: 10px;
margin: 50px;
}
.messages-wrapper {
position: relative;
}
.message {
margin: 10px;
padding: 15px 20px;
position: relative;
overflow-x: auto;
}
.message.to {
border-radius: 20px 0px 20px 20px;
background-color: #2095fe;
color: #fff;
margin-left: 20%;
}
.message.from {
border-radius: 20px 20px 20px 0px;
background-color: #e5e4e9;
color: #363636;
margin-right: 20%;
}
.message.to + .message.to,
.message.from + .message.from {
margin-top: -7px;
}
-74
View File
@@ -1,74 +0,0 @@
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
View File
@@ -1,5 +0,0 @@
mkdocs-material==9.4.4
# Required for Social Cards
Pillow==10.0.1
CairoSVG==2.7.1
+8 -11
View File
@@ -1,11 +1,8 @@
[tool.black] [tool.black]
line-length = 130 line-length = 130
[tool.flake8] [tool.flake8]
max-line-length = 130 max-line-length = 130
[tool.pycodestyle] [tool.pycodestyle]
max_line_length = 130 max_line_length = 130
[tool.ruff]
line-length = 130
+7
View File
@@ -0,0 +1,7 @@
python-telegram-bot==13.5
requests==2.25.1
pandas==2.0.0
schedule==1.0.0
mplfinance==0.12.7a5
markdownify==0.6.5
cachetools==4.2.2
+399 -395
View File
@@ -1,395 +1,399 @@
"""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 logging as log
import pandas as pd
import schedule import pandas as pd
from cachetools import TTLCache, cached import schedule
from cachetools import TTLCache, cached
from common.cg_Crypto import cg_Crypto
from common.MarketData import MarketData from cg_Crypto import cg_Crypto
from common.Symbol import Coin, Stock, Symbol from MarketData import MarketData
from Symbol import Coin, Stock, Symbol
from typing import Dict
from typing import Dict
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: log.info(symbols)
for symbol in symbols: for symbol in symbols:
self.trending_count[symbol.tag] = self.trending_count.get(symbol.tag, 0) + trending_weight self.trending_count[symbol.tag] = self.trending_count.get(symbol.tag, 0) + trending_weight
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 = df[df["description"].str.contains(search, regex=False, case=False)].sort_values(
by="type_id", key=lambda x: x.str.len()
df = df[df["description"].str.contains(search, regex=False, case=False)].sort_values( )
by="type_id", key=lambda x: x.str.len()
) symbols = df.head(matches)
symbols["price_reply"] = symbols["type_id"].apply(
symbols = df.head(matches) lambda sym: self.price_reply(self.find_symbols(sym, trending_weight=0))[0]
symbols["price_reply"] = symbols["type_id"].apply( )
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]:
"""Returns current market price or after hours if its available for a given stock symbol.
def price_reply(self, symbols: list[Symbol]) -> list[str]:
"""Returns current market price or after hours if its available for a given stock symbol. Parameters
----------
Parameters symbols : list
---------- List of stock symbols.
symbols : list
List of stock symbols. Returns
-------
Returns Dict[str, str]
------- Each symbol passed in is a key with its value being a human readable
Dict[str, str] markdown formatted string of the symbols price and movement.
Each symbol passed in is a key with its value being a human readable """
markdown formatted string of the symbols price and movement. replies = []
"""
replies = [] for symbol in symbols:
log.info(symbol)
for symbol in symbols: if isinstance(symbol, Stock):
log.info(symbol) replies.append(self.stock.price_reply(symbol))
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
replies.append(self.stock.price_reply(symbol)) replies.append(self.crypto.price_reply(symbol))
elif isinstance(symbol, Coin): else:
replies.append(self.crypto.price_reply(symbol)) log.info(f"{symbol} is not a Stock or Coin")
else:
log.info(f"{symbol} is not a Stock or Coin") return replies
return replies def info_reply(self, symbols: list) -> list[str]:
"""Gets information on stock symbols.
def info_reply(self, symbols: list) -> list[str]:
"""Gets information on stock symbols. Parameters
----------
Parameters symbols : list[str]
---------- List of stock symbols.
symbols : list[str]
List of stock symbols. Returns
-------
Returns Dict[str, str]
------- Each symbol passed in is a key with its value being a human readable formatted
Dict[str, str] string of the symbols information.
Each symbol passed in is a key with its value being a human readable formatted """
string of the symbols information. replies = []
"""
replies = [] for symbol in symbols:
if isinstance(symbol, Stock):
for symbol in symbols: replies.append(self.stock.info_reply(symbol))
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
replies.append(self.stock.info_reply(symbol)) replies.append(self.crypto.info_reply(symbol))
elif isinstance(symbol, Coin): else:
replies.append(self.crypto.info_reply(symbol)) log.debug(f"{symbol} is not a Stock or Coin")
else:
log.debug(f"{symbol} is not a Stock or Coin") return replies
return replies def intra_reply(self, symbol: Symbol) -> pd.DataFrame:
"""Returns price data for a symbol since the last market open.
def intra_reply(self, symbol: Symbol) -> pd.DataFrame:
"""Returns price data for a symbol since the last market open. Parameters
----------
Parameters symbol : str
---------- Stock symbol.
symbol : str
Stock symbol. Returns
-------
Returns pd.DataFrame
------- Returns a timeseries dataframe with high, low, and volume data if its available.
pd.DataFrame Otherwise returns empty pd.DataFrame.
Returns a timeseries dataframe with high, low, and volume data if its available. """
Otherwise returns empty pd.DataFrame.
""" if isinstance(symbol, Stock):
return self.stock.intra_reply(symbol)
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
return self.stock.intra_reply(symbol) return self.crypto.intra_reply(symbol)
elif isinstance(symbol, Coin): else:
return self.crypto.intra_reply(symbol) log.debug(f"{symbol} is not a Stock or Coin")
else: return pd.DataFrame()
log.debug(f"{symbol} is not a Stock or Coin")
return 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.
def chart_reply(self, symbol: Symbol) -> pd.DataFrame: Also caches multiple requests made in the same day.
"""Returns price data for a symbol of the past month up until the previous trading days close.
Also caches multiple requests made in the same day. Parameters
----------
Parameters symbol : str
---------- Stock symbol.
symbol : str
Stock symbol. Returns
-------
Returns pd.DataFrame
------- Returns a timeseries dataframe with high, low, and volume data if its available.
pd.DataFrame Otherwise returns empty pd.DataFrame.
Returns a timeseries dataframe with high, low, and volume data if its available. """
Otherwise returns empty pd.DataFrame. if isinstance(symbol, Stock):
""" return self.stock.chart_reply(symbol)
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
return self.stock.chart_reply(symbol) return self.crypto.chart_reply(symbol)
elif isinstance(symbol, Coin): else:
return self.crypto.chart_reply(symbol) log.debug(f"{symbol} is not a Stock or Coin")
else: return pd.DataFrame()
log.debug(f"{symbol} is not a Stock or Coin")
return pd.DataFrame() def stat_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets key statistics for each symbol in the list
def stat_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets key statistics for each symbol in the list Parameters
----------
Parameters symbols : list[str]
---------- List of stock symbols
symbols : list[str]
List of stock symbols Returns
-------
Returns Dict[str, str]
------- Each symbol passed in is a key with its value being a human readable
Dict[str, str] formatted string of the symbols statistics.
Each symbol passed in is a key with its value being a human readable """
formatted string of the symbols statistics. replies = []
"""
replies = [] for symbol in symbols:
if isinstance(symbol, Stock):
for symbol in symbols: replies.append(self.stock.stat_reply(symbol))
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
replies.append(self.stock.stat_reply(symbol)) replies.append(self.crypto.stat_reply(symbol))
elif isinstance(symbol, Coin): else:
replies.append(self.crypto.stat_reply(symbol)) log.debug(f"{symbol} is not a Stock or Coin")
else:
log.debug(f"{symbol} is not a Stock or Coin") return replies
return replies def cap_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets market cap for each symbol in the list
def cap_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets market cap for each symbol in the list Parameters
----------
Parameters symbols : list[str]
---------- List of stock symbols
symbols : list[str]
List of stock symbols Returns
-------
Returns Dict[str, str]
------- Each symbol passed in is a key with its value being a human readable
Dict[str, str] formatted string of the symbols market cap.
Each symbol passed in is a key with its value being a human readable """
formatted string of the symbols market cap. replies = []
"""
replies = [] for symbol in symbols:
if isinstance(symbol, Stock):
for symbol in symbols: replies.append(self.stock.cap_reply(symbol))
if isinstance(symbol, Stock): elif isinstance(symbol, Coin):
replies.append(self.stock.cap_reply(symbol)) replies.append(self.crypto.cap_reply(symbol))
elif isinstance(symbol, Coin): else:
replies.append(self.crypto.cap_reply(symbol)) log.debug(f"{symbol} is not a Stock or Coin")
else:
log.debug(f"{symbol} is not a Stock or Coin") return replies
return replies def spark_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets change for each symbol and returns it in a compact format
def spark_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets change for each symbol and returns it in a compact format Parameters
----------
Parameters symbols : list[str]
---------- List of stock symbols
symbols : list[str]
List of stock symbols Returns
-------
Returns list[str]
------- List of human readable strings.
list[str] """
List of human readable strings. replies = []
"""
replies = [] for symbol in symbols:
if isinstance(symbol, Stock):
for symbol in symbols: replies.append("Command not supported for stocks.")
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 = ""
if self.trending_count:
log.warning(self.trending_count) reply += "🔥Trending on the Stock Bot:\n`"
if self.trending_count: reply += "" * len("Trending on the Stock Bot:") + "`\n"
reply += "🔥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] for t in sorted_trending:
log.warning(sorted_trending) reply += self.spark_reply(self.find_symbols(t))[0] + "\n"
for t in sorted_trending:
reply += self.spark_reply(self.find_symbols(t))[0] + "\n" if stocks:
reply += "\n\n💵Trending Stocks:\n`"
if coins: reply += "" * len("Trending Stocks:") + "`\n"
reply += "\n\n🦎Trending on CoinGecko:\n`" for stock in stocks:
reply += "" * len("Trending on CoinGecko:") + "`\n" reply += stock + "\n"
for coin in coins:
reply += coin + "\n" if coins:
reply += "\n\n🦎Trending Crypto:\n`"
if "`$GME" in reply: reply += "" * len("Trending Crypto:") + "`\n"
reply = reply.replace("🔥", "🦍") for coin in coins:
reply += coin + "\n"
if reply:
return reply if "`$GME" in reply:
else: reply = reply.replace("🔥", "🦍")
log.warning("Failed to collect trending data.")
return "Trending data is not currently available." if reply:
return reply
def random_pick(self) -> str: else:
# choice = random.choice(list(self.stock.symbol_list["description"]) + list(self.crypto.symbol_list["description"])) log.warning("Failed to collect trending data.")
choice = random.choice(list(self.crypto.symbol_list["description"])) return "Trending data is not currently available."
hold = (datetime.date.today() + datetime.timedelta(random.randint(1, 365))).strftime("%b %d, %Y")
def random_pick(self) -> str:
return f"{choice}\nBuy and hold until: {hold}" choice = random.choice(list(self.stock.symbol_list["description"]) + list(self.crypto.symbol_list["description"]))
hold = (datetime.date.today() + datetime.timedelta(random.randint(1, 365))).strftime("%b %d, %Y")
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. return f"{choice}\nBuy and hold until: {hold}"
Parameters 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.
symbols : list
List of stock symbols. Parameters
----------
Returns symbols : list
------- List of stock symbols.
Dict[str, str]
Each symbol passed in is a key with its value being a human readable Returns
markdown formatted string of the symbols price and movement. -------
""" Dict[str, str]
replies = [] Each symbol passed in is a key with its value being a human readable
stocks = [] markdown formatted string of the symbols price and movement.
coins = [] """
replies = []
for symbol in symbols: stocks = []
if isinstance(symbol, Stock): coins = []
stocks.append(symbol)
elif isinstance(symbol, Coin): for symbol in symbols:
coins.append(symbol) if isinstance(symbol, Stock):
else: stocks.append(symbol)
log.debug(f"{symbol} is not a Stock or Coin") elif isinstance(symbol, Coin):
coins.append(symbol)
if stocks: else:
for stock in stocks: log.debug(f"{symbol} is not a Stock or Coin")
replies.append(self.stock.price_reply(stock))
if coins: if stocks:
replies = replies + self.crypto.batch_price(coins) # IEX batch endpoint doesnt seem to be working right now
for stock in stocks:
return replies replies.append(self.stock.price_reply(stock))
if coins:
replies = replies + self.crypto.batch_price(coins)
return replies
-22
View File
@@ -1,22 +0,0 @@
FROM python:3.11-buster AS builder
COPY telegram/telegram-reqs.txt .
COPY common/requirements.txt .
RUN pip install --user -r telegram-reqs.txt
FROM python:3.11-slim
ENV MPLBACKEND=Agg
COPY --from=builder /root/.local /root/.local
COPY common common
COPY telegram .
CMD [ "python", "./bot.py" ]
-70
View File
@@ -1,70 +0,0 @@
"""Functions and Info specific to the Telegram Bot
"""
import re
import requests as r
class T_info:
license = re.sub(
r"\b\n",
" ",
r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
)
help_text = """
Appreciate this bot? Show support by [buying me a beer](https://www.buymeacoffee.com/Anson) 🍻.
Want stock data or to host your own bot? Help keep this bot free by using my
[affiliate link](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews.
**Guide**: All about using and setting up the bot is in the [docs](https://docs.simplestockbot.com).
The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
- `/chart $$eth` gets a month's Ethereum chart.
- `/dividend $psec` shows Prospect Capital's dividend info.
Mention a symbol, and the bot reveals its price.
E.g., `What's $$btc's price since $tsla accepts it?` gives Bitcoin and Tesla prices.
**Commands**
- `/donate [USD]`: Support the bot. 🎗️
- `/intra $[symbol]`: Today's stock activity. 📈
- `/chart $[symbol]`: Past month's stock chart. 📊
- `/trending`: What's hot in stocks and cryptos. 💬
- `/help`: Bot assistance. 🆘
**Inline Features**
Search with @SimpleStockBot `[query]` anywhere.
Pick a ticker, and the bot shares the current price in chat. Note: Prices can lag by an hour.
Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
Bot issues? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
"""
donate_text = """
Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
All funds help maintain servers, with data from
[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
**How to Donate?**
1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
For questions, visit our [website](https://docs.simplestockbot.com).
"""
# Not used by the bot but for updating commands with BotFather
commands = """
donate - Donate to the bot 🎗️
help - Get some help using the bot. 🆘
trending - Trending Stocks and Cryptos. 💬
intra - $[symbol] Plot since the last market open. 📈
chart - $[chart] Plot of the past month. 📊
"""
-2
View File
@@ -1,2 +0,0 @@
python-telegram-bot==20.5
-r requirements.txt
+33 -33
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")