Anson/Simple-Stock-Bot
1
0
Fork 0
mirror of https://gitlab.com/simple-stock-bots/simple-stock-bot.git synced 2025-06-16 07:16:40 +00:00
Code Releases Activity

trending only returns if data was retrieved. #75

Browse Source
This commit is contained in:
Anson Biggs 2021-08-30 13:46:12 -07:00
parent 0649789bf8
commit 0877949a89
3 changed files with 467 additions and 459 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
IEX_Symbol.py
View File

@ -25,7 +25,7 @@ class IEX_Symbol:
searched_symbols = {} searched_symbols = {}
otc_list = [] otc_list = []
charts = {} charts = {}
trending_cache = ["Trending Stocks Currently Unavailable."] trending_cache = None
def __init__(self) -> None: def __init__(self) -> None:
"""Creates a Symbol Object """Creates a Symbol Object

2
cg_Crypto.py
View File

@ -22,7 +22,7 @@ class cg_Crypto:
vs_currency = "usd" # simple/supported_vs_currencies for list of options vs_currency = "usd" # simple/supported_vs_currencies for list of options
searched_symbols = {} searched_symbols = {}
trending_cache = ["Trending Coins Currently Unavailable."] trending_cache = None
def __init__(self) -> None: def __init__(self) -> None:
"""Creates a Symbol Object """Creates a Symbol Object

922
symbol_router.py
View File

@ -1,458 +1,466 @@
"""Function that routes symbols to the correct API provider. """Function that routes symbols to the correct API provider.
""" """
import datetime import datetime
import random import random
import re import re
from logging import critical, debug, error, info, warning from logging import critical, debug, error, info, warning
import pandas as pd import pandas as pd
import schedule import schedule
from fuzzywuzzy import fuzz from fuzzywuzzy import fuzz
from cg_Crypto import cg_Crypto from cg_Crypto import cg_Crypto
from IEX_Symbol import IEX_Symbol from IEX_Symbol import IEX_Symbol
from Symbol import Coin, Stock, Symbol from Symbol import Coin, Stock, Symbol
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})"
searched_symbols = {} searched_symbols = {}
trending_count = {} trending_count = {}
def __init__(self): def __init__(self):
self.stock = IEX_Symbol() self.stock = IEX_Symbol()
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"""
info("Decaying trending symbols.") info("Decaying trending symbols.")
if self.trending_count: if self.trending_count:
for key in self.trending_count.keys(): for key in self.trending_count.keys():
if self.trending_count[key] < 0.01: if self.trending_count[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.
self.trending_count.pop(key, None) self.trending_count.pop(key, None)
else: else:
self.trending_count[key] = self.trending_count[key] * decay self.trending_count[key] = self.trending_count[key] * decay
def find_symbols(self, text: str) -> list[Symbol]: def find_symbols(self, text: str) -> list[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 = [] symbols = []
stocks = set(re.findall(self.STOCK_REGEX, text)) stocks = set(re.findall(self.STOCK_REGEX, text))
for stock in stocks: for stock in stocks:
if stock.upper() in self.stock.symbol_list["symbol"].values: if stock.upper() in self.stock.symbol_list["symbol"].values:
symbols.append(Stock(stock)) symbols.append(Stock(stock))
else: else:
info(f"{stock} is not in list of stocks") info(f"{stock} is not in list of stocks")
coins = set(re.findall(self.CRYPTO_REGEX, text)) coins = set(re.findall(self.CRYPTO_REGEX, text))
for coin in coins: for coin in coins:
if coin.lower() in self.crypto.symbol_list["symbol"].values: if coin.lower() in self.crypto.symbol_list["symbol"].values:
symbols.append(Coin(coin.lower())) symbols.append(Coin(coin.lower()))
else: else:
info(f"{coin} is not in list of coins") info(f"{coin} is not in list of coins")
if symbols: if symbols:
info(symbols) info(symbols)
for symbol in symbols: for symbol in symbols:
self.trending_count[symbol.tag] = ( self.trending_count[symbol.tag] = (
self.trending_count.get(symbol.tag, 0) + 1 self.trending_count.get(symbol.tag, 0) + 1
) )
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()}
""" """
warning(stats) warning(stats)
return stats return stats
def search_symbols(self, search: str) -> list[tuple[str, str]]: def search_symbols(self, search: str) -> list[tuple[str, str]]:
"""Performs a fuzzy search to find stock symbols closest to a search term. """Performs a fuzzy search to find stock symbols closest to a search term.
Parameters Parameters
---------- ----------
search : str search : str
String used to search, could be a company name or something close to the companies stock ticker. String used to search, could be a company name or something close to the companies stock ticker.
Returns Returns
------- -------
list[tuple[str, str]] list[tuple[str, str]]
A list tuples of every stock sorted in order of how well they match. A list tuples of every stock sorted in order of how well they match.
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])
search = search.lower() search = search.lower()
df["Match"] = df.apply( df["Match"] = df.apply(
lambda x: fuzz.ratio(search, f"{x['symbol']}".lower()), lambda x: fuzz.ratio(search, f"{x['symbol']}".lower()),
axis=1, axis=1,
) )
df.sort_values(by="Match", ascending=False, inplace=True) df.sort_values(by="Match", ascending=False, inplace=True)
# if df["Match"].head().sum() < 300: # if df["Match"].head().sum() < 300:
# df["Match"] = df.apply( # df["Match"] = df.apply(
# lambda x: fuzz.partial_ratio(search, x["name"].lower()), # lambda x: fuzz.partial_ratio(search, x["name"].lower()),
# axis=1, # axis=1,
# ) # )
# df.sort_values(by="Match", ascending=False, inplace=True) # df.sort_values(by="Match", ascending=False, inplace=True)
symbols = df.head(20) symbols = df.head(20)
symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"]))) symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"])))
self.searched_symbols[search] = symbol_list self.searched_symbols[search] = symbol_list
return symbol_list return symbol_list
def inline_search(self, search: str) -> list[tuple[str, str]]: def inline_search(self, search: str) -> list[tuple[str, str]]:
"""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])
search = search.lower() search = search.lower()
df = df[df["type_id"].str.contains(search, regex=False)].sort_values( df = df[df["type_id"].str.contains(search, regex=False)].sort_values(
by="type_id", key=lambda x: x.str.len() by="type_id", key=lambda x: x.str.len()
) )
symbols = df.head(20) symbols = df.head(20)
symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"]))) symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"])))
self.searched_symbols[search] = symbol_list self.searched_symbols[search] = symbol_list
return symbol_list return symbol_list
def price_reply(self, symbols: list[Symbol]) -> list[str]: def price_reply(self, symbols: list[Symbol]) -> list[str]:
"""Returns current market price or after hours if its available for a given stock symbol. """Returns current market price or after hours if its available for a given stock symbol.
Parameters Parameters
---------- ----------
symbols : list symbols : list
List of stock symbols. List of stock symbols.
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human readable Each symbol passed in is a key with its value being a human readable
markdown formatted string of the symbols price and movement. markdown formatted string of the symbols price and movement.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
info(symbol) info(symbol)
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.price_reply(symbol)) replies.append(self.stock.price_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
replies.append(self.crypto.price_reply(symbol)) replies.append(self.crypto.price_reply(symbol))
else: else:
info(f"{symbol} is not a Stock or Coin") info(f"{symbol} is not a Stock or Coin")
return replies return replies
def dividend_reply(self, symbols: list) -> list[str]: def dividend_reply(self, symbols: list) -> list[str]:
"""Returns the most recent, or next dividend date for a stock symbol. """Returns the most recent, or next dividend date for a stock symbol.
Parameters Parameters
---------- ----------
symbols : list symbols : list
List of stock symbols. List of stock symbols.
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human readable Each symbol passed in is a key with its value being a human readable
formatted string of the symbols div dates. formatted string of the symbols div dates.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.dividend_reply(symbol)) replies.append(self.stock.dividend_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
replies.append("Cryptocurrencies do no have Dividends.") replies.append("Cryptocurrencies do no have Dividends.")
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return replies return replies
def news_reply(self, symbols: list) -> list[str]: def news_reply(self, symbols: list) -> list[str]:
"""Gets recent english news on stock symbols. """Gets recent english news on stock symbols.
Parameters Parameters
---------- ----------
symbols : list symbols : list
List of stock symbols. List of stock symbols.
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human Each symbol passed in is a key with its value being a human
readable markdown formatted string of the symbols news. readable markdown formatted string of the symbols news.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.news_reply(symbol)) replies.append(self.stock.news_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
# replies.append(self.crypto.news_reply(symbol)) # replies.append(self.crypto.news_reply(symbol))
replies.append( replies.append(
"News is not yet supported for cryptocurrencies. If you have any suggestions for news sources please contatct @MisterBiggs" "News is not yet supported for cryptocurrencies. If you have any suggestions for news sources please contatct @MisterBiggs"
) )
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return replies return replies
def info_reply(self, symbols: list) -> list[str]: def info_reply(self, symbols: list) -> list[str]:
"""Gets information on stock symbols. """Gets information on stock symbols.
Parameters Parameters
---------- ----------
symbols : list[str] symbols : list[str]
List of stock symbols. List of stock symbols.
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human readable formatted Each symbol passed in is a key with its value being a human readable formatted
string of the symbols information. string of the symbols information.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.info_reply(symbol)) replies.append(self.stock.info_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
replies.append(self.crypto.info_reply(symbol)) replies.append(self.crypto.info_reply(symbol))
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return replies return replies
def intra_reply(self, symbol: Symbol) -> pd.DataFrame: def intra_reply(self, symbol: Symbol) -> pd.DataFrame:
"""Returns price data for a symbol since the last market open. """Returns price data for a symbol since the last market open.
Parameters Parameters
---------- ----------
symbol : str symbol : str
Stock symbol. Stock symbol.
Returns Returns
------- -------
pd.DataFrame pd.DataFrame
Returns a timeseries dataframe with high, low, and volume data if its available. Returns a timeseries dataframe with high, low, and volume data if its available.
Otherwise returns empty pd.DataFrame. Otherwise returns empty pd.DataFrame.
""" """
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
return self.stock.intra_reply(symbol) return self.stock.intra_reply(symbol)
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
return self.crypto.intra_reply(symbol) return self.crypto.intra_reply(symbol)
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return pd.DataFrame() return pd.DataFrame()
def chart_reply(self, symbol: Symbol) -> pd.DataFrame: def chart_reply(self, symbol: Symbol) -> pd.DataFrame:
"""Returns price data for a symbol of the past month up until the previous trading days close. """Returns price data for a symbol of the past month up until the previous trading days close.
Also caches multiple requests made in the same day. Also caches multiple requests made in the same day.
Parameters Parameters
---------- ----------
symbol : str symbol : str
Stock symbol. Stock symbol.
Returns Returns
------- -------
pd.DataFrame pd.DataFrame
Returns a timeseries dataframe with high, low, and volume data if its available. Returns a timeseries dataframe with high, low, and volume data if its available.
Otherwise returns empty pd.DataFrame. Otherwise returns empty pd.DataFrame.
""" """
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
return self.stock.chart_reply(symbol) return self.stock.chart_reply(symbol)
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
return self.crypto.chart_reply(symbol) return self.crypto.chart_reply(symbol)
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return pd.DataFrame() return pd.DataFrame()
def stat_reply(self, symbols: list[Symbol]) -> list[str]: def stat_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets key statistics for each symbol in the list """Gets key statistics for each symbol in the list
Parameters Parameters
---------- ----------
symbols : list[str] symbols : list[str]
List of stock symbols List of stock symbols
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human readable Each symbol passed in is a key with its value being a human readable
formatted string of the symbols statistics. formatted string of the symbols statistics.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.stat_reply(symbol)) replies.append(self.stock.stat_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
replies.append(self.crypto.stat_reply(symbol)) replies.append(self.crypto.stat_reply(symbol))
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return replies return replies
def cap_reply(self, symbols: list[Symbol]) -> list[str]: def cap_reply(self, symbols: list[Symbol]) -> list[str]:
"""Gets market cap for each symbol in the list """Gets market cap for each symbol in the list
Parameters Parameters
---------- ----------
symbols : list[str] symbols : list[str]
List of stock symbols List of stock symbols
Returns Returns
------- -------
Dict[str, str] Dict[str, str]
Each symbol passed in is a key with its value being a human readable Each symbol passed in is a key with its value being a human readable
formatted string of the symbols market cap. formatted string of the symbols market cap.
""" """
replies = [] replies = []
for symbol in symbols: for symbol in symbols:
if isinstance(symbol, Stock): if isinstance(symbol, Stock):
replies.append(self.stock.cap_reply(symbol)) replies.append(self.stock.cap_reply(symbol))
elif isinstance(symbol, Coin): elif isinstance(symbol, Coin):
replies.append(self.crypto.cap_reply(symbol)) replies.append(self.crypto.cap_reply(symbol))
else: else:
debug(f"{symbol} is not a Stock or Coin") debug(f"{symbol} is not a Stock or Coin")
return replies return replies
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 = ""
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]) sorted_trending = [
][::-1][0:5] s[0]
for s in sorted(self.trending_count.items(), key=lambda item: item[1])
for t in sorted_trending: ][::-1][0:5]
reply += self.price_reply(self.find_symbols(t))[0] + "\n"
for t in sorted_trending:
reply += "\n\nTrending Stocks:\n" reply += self.price_reply(self.find_symbols(t))[0] + "\n"
reply += "-" * len("Trending Stocks:") + "\n"
for stock in stocks: if stocks:
reply += stock + "\n" reply += "\n\n💵Trending Stocks:\n`"
reply += "━" * len("Trending Stocks:") + "`\n"
reply += "\n\nTrending Crypto:\n" for stock in stocks:
reply += "-" * len("Trending Crypto:") + "\n" reply += stock + "\n"
for coin in coins:
reply += coin + "\n" if coins:
reply += "\n\n🦎Trending Crypto:\n`"
return reply reply += "━" * len("Trending Crypto:") + "`\n"
for coin in coins:
def random_pick(self) -> str: reply += coin + "\n"
choice = random.choice( if reply:
list(self.stock.symbol_list["description"]) return reply
+ list(self.crypto.symbol_list["description"]) else:
) warning("Failed to collect trending data.")
hold = ( return "Trending data is not currently available."
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"])
def batch_price_reply(self, symbols: list[Symbol]) -> list[str]: + list(self.crypto.symbol_list["description"])
"""Returns current market price or after hours if its available for a given stock symbol. )
hold = (
Parameters datetime.date.today() + datetime.timedelta(random.randint(1, 365))
---------- ).strftime("%b %d, %Y")
symbols : list
List of stock symbols. return f"{choice}\nBuy and hold until: {hold}"
Returns 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.
Dict[str, str]
Each symbol passed in is a key with its value being a human readable Parameters
markdown formatted string of the symbols price and movement. ----------
""" symbols : list
replies = [] List of stock symbols.
stocks = []
coins = [] Returns
-------
for symbol in symbols: Dict[str, str]
if isinstance(symbol, Stock): Each symbol passed in is a key with its value being a human readable
stocks.append(symbol) markdown formatted string of the symbols price and movement.
elif isinstance(symbol, Coin): """
coins.append(symbol) replies = []
else: stocks = []
debug(f"{symbol} is not a Stock or Coin") coins = []
if stocks: for symbol in symbols:
# IEX batch endpoint doesnt seem to be working right now if isinstance(symbol, Stock):
for stock in stocks: stocks.append(symbol)
replies.append(self.stock.price_reply(stock)) elif isinstance(symbol, Coin):
if coins: coins.append(symbol)
replies = replies + self.crypto.batch_price(coins) else:
debug(f"{symbol} is not a Stock or Coin")
return replies
if stocks:
# IEX batch endpoint doesnt seem to be working right now
for stock in stocks:
replies.append(self.stock.price_reply(stock))
if coins:
replies = replies + self.crypto.batch_price(coins)
return replies