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

..

10 Commits

Author SHA1 Message Date
Anson 5593346373 add buttons 2023-10-10 04:18:39 +00:00
Anson 40db63066b edits 2023-10-09 22:01:52 -06:00
Anson f772083521 complete renaming 2023-10-09 01:46:17 -06:00
Anson 81e433b08a rename docs to site 2023-10-09 01:45:53 -06:00
Anson b7fc32d865 enable the blog 2023-10-09 01:43:17 -06:00
Anson 1fb153cc14 idk what is happening to my life anymore 2023-10-09 01:36:52 -06:00
Anson 3c9bd16a04 one more try 2023-10-09 01:36:05 -06:00
Anson 16ce877d5c lets get my ass kicked by the CI at 130am on a work night 2023-10-09 01:34:26 -06:00
Anson b6fc82b491 always build but don't always publish 2023-10-09 01:32:22 -06:00
Anson a1bf4652f6 blogspam??? 2023-10-09 07:29:48 +00:00
35 changed files with 678 additions and 924 deletions
+2
View File
@@ -1,3 +1,5 @@
FROM python:3.11 FROM python:3.11
COPY . . COPY . .
# RUN pip install -r requirements.txt
+9 -11
View File
@@ -5,8 +5,7 @@
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm", // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
"build": { "build": {
"dockerfile": "Dockerfile", "dockerfile": "Dockerfile"
"context": ".."
}, },
"features": { "features": {
"ghcr.io/devcontainers-contrib/features/black:2": {}, "ghcr.io/devcontainers-contrib/features/black:2": {},
@@ -17,17 +16,16 @@
"customizations": { "customizations": {
"vscode": { "vscode": {
"extensions": [ "extensions": [
"ms-python.python", "ms-python.python",
"ms-python.black-formatter", "ms-python.black-formatter",
"ms-python.vscode-pylance", "ms-python.flake8",
"ms-python.isort", "ms-python.vscode-pylance",
"charliermarsh.ruff", "ms-python.isort",
"ms-toolsai.jupyter", "charliermarsh.ruff"
"esbenp.prettier-vscode" ]
]
} }
}, },
"postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm && npm install" "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
// Features to add to the dev container. More info: https://containers.dev/features. // Features to add to the dev container. More info: https://containers.dev/features.
// "features": {}, // "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally. // Use 'forwardPorts' to make a list of ports inside the container available locally.
-1
View File
@@ -1,3 +1,2 @@
__pycache__ __pycache__
.env .env
node_modules
+1 -6
View File
@@ -13,17 +13,12 @@ black:
ruff: ruff:
stage: lint stage: lint
# image: registry.gitlab.com/pipeline-components/ruff:latest
image: python:3.11-slim image: python:3.11-slim
script: script:
- pip3 install ruff - pip3 install ruff
- ruff --output-format gitlab . - ruff --output-format gitlab .
prettier:
stage: lint
image: node:16-slim # Use Node.js image since prettier is a Node.js tool
script:
- npm install prettier
- npx prettier --check . # Adjust the path as needed
include: include:
- local: /site/.gitlab-ci.yml - local: /site/.gitlab-ci.yml
+5 -7
View File
@@ -1,10 +1,8 @@
{ {
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.formatOnSaveMode": "modificationsIfAvailable",
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.formatOnSaveMode": "file" "editor.formatOnPaste": true,
} "editor.formatOnSaveMode": "modificationsIfAvailable",
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
}
} }
+5 -9
View File
@@ -9,16 +9,14 @@ Enhance your group chats on Telegram and Discord with real-time stock and crypto
## Documentation ## Documentation
Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots: Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
- [Official Documentation](https://docs.simplestockbot.com/)
- [Official Documentation](https://simplestockbot.com/) - [Command Reference](https://docs.simplestockbot.com/commands/)
- [Command Reference](https://simplestockbot.com/commands/)
## Support the Project ## Support the Project
Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
You can contribute by: You can contribute by:
- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted). - Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram. - Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
- [Getting in touch](contact.md) for any inquiries or suggestions. - [Getting in touch](contact.md) for any inquiries or suggestions.
@@ -26,7 +24,7 @@ You can contribute by:
### Additional Support: ### Additional Support:
- Follow on [Twitter](https://twitter.com/AnsonBiggs) - Follow on [Twitter](https://twitter.com/AnsonBiggs)
- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot) - Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
- Utilize referral links for self-hosting: - Utilize referral links for self-hosting:
- [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=web) - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
@@ -34,14 +32,12 @@ You can contribute by:
## Hosting ## Hosting
Self-hosting instructions are provided for those interested in running the bot on their own servers: Self-hosting instructions are provided for those interested in running the bot on their own servers:
- [Hosting Guide](https://docs.simplestockbot.com/hosting/)
- [Hosting Guide](https://simplestockbot.com/hosting/)
## Contact ## Contact
Reach out for bug reports, feature requests, or other inquiries: Reach out for bug reports, feature requests, or other inquiries:
- [Contact Page](https://docs.simplestockbot.com/contact/)
- [Contact Page](https://simplestockbot.com/contact/)
--- ---
+2 -78
View File
@@ -2,9 +2,7 @@ import datetime as dt
import logging import logging
import os import os
from typing import Dict from typing import Dict
from collections import OrderedDict
import humanize
import pandas as pd import pandas as pd
import pytz import pytz
import requests as r import requests as r
@@ -22,7 +20,6 @@ class MarketData:
SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})" SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
symbol_list: Dict[str, Dict] = {}
charts: Dict[Stock, pd.DataFrame] = {} charts: Dict[Stock, pd.DataFrame] = {}
openTime = dt.time(hour=9, minute=30, second=0) openTime = dt.time(hour=9, minute=30, second=0)
@@ -51,9 +48,6 @@ class MarketData:
if self.MARKETDATA_TOKEN != "": if self.MARKETDATA_TOKEN != "":
schedule.every().day.do(self.clear_charts) schedule.every().day.do(self.clear_charts)
self.get_symbol_list()
schedule.every().day.do(self.get_symbol_list)
def get(self, endpoint, params: dict = {}, timeout=10) -> dict: def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
url = "https://api.marketdata.app/v1/" + endpoint url = "https://api.marketdata.app/v1/" + endpoint
@@ -91,21 +85,6 @@ class MarketData:
return {} return {}
def symbol_id(self, symbol: str) -> Dict[str, Dict]:
return self.symbol_list.get(symbol.upper(), None)
def get_symbol_list(self):
sec_resp = r.get("https://www.sec.gov/files/company_tickers.json")
sec_resp.raise_for_status()
sec_data = sec_resp.json()
for rank, ticker_info in sec_data.items():
self.symbol_list[ticker_info["ticker"]] = {
"ticker": ticker_info["ticker"],
"title": ticker_info["title"],
"mkt_cap_rank": rank,
}
def clear_charts(self) -> None: def clear_charts(self) -> None:
""" """
Clears cache of chart data. Clears cache of chart data.
@@ -150,13 +129,13 @@ class MarketData:
Formatted markdown Formatted markdown
""" """
if quoteResp := self.get(f"stocks/quotes/{symbol.symbol}/"): if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
price = round(quoteResp["last"][0], 2) price = round(quoteResp["last"][0], 2)
try: try:
changePercent = round(quoteResp["changepct"][0], 2) changePercent = round(quoteResp["changepct"][0], 2)
except TypeError: except TypeError:
return f"The price of {symbol.name} is ${price}" return f"The price of {symbol} is {price}"
message = f"The current price of {symbol.name} is ${price} and " message = f"The current price of {symbol.name} is ${price} and "
@@ -288,58 +267,3 @@ class MarketData:
return df return df
return pd.DataFrame() return pd.DataFrame()
def options_reply(self, request: str) -> str:
"""Undocumented API Usage!"""
options_data = self.get(f"options/quotes/{request}")
for key in options_data.keys():
options_data[key] = options_data[key][0]
options_data["underlying"] = "$" + options_data["underlying"]
options_data["updated"] = humanize.naturaltime(dt.datetime.now() - dt.datetime.fromtimestamp(options_data["updated"]))
options_data["expiration"] = humanize.naturaltime(
dt.datetime.now() - dt.datetime.fromtimestamp(options_data["expiration"])
)
options_data["firstTraded"] = humanize.naturaltime(
dt.datetime.now() - dt.datetime.fromtimestamp(options_data["firstTraded"])
)
rename = {
"optionSymbol": "Option Symbol",
"underlying": "Underlying",
"expiration": "Expiration",
"side": "side",
"strike": "strike",
"firstTraded": "First Traded",
"updated": "Last Updated",
"bid": "bid",
"bidSize": "bidSize",
"mid": "mid",
"ask": "ask",
"askSize": "askSize",
"last": "last",
"openInterest": "Open Interest",
"volume": "Volume",
"inTheMoney": "inTheMoney",
"intrinsicValue": "Intrinsic Value",
"extrinsicValue": "Extrinsic Value",
"underlyingPrice": "Underlying Price",
"iv": "Implied Volatility",
"delta": "delta",
"gamma": "gamma",
"theta": "theta",
"vega": "vega",
"rho": "rho",
}
options_cleaned = OrderedDict()
for old, new in rename.items():
if old in options_data:
options_cleaned[new] = options_data[old]
return options_cleaned
+6 -8
View File
@@ -1,6 +1,5 @@
import logging
import pandas as pd import pandas as pd
import logging
class Symbol: class Symbol:
@@ -30,12 +29,11 @@ class Symbol:
class Stock(Symbol): class Stock(Symbol):
"""Stock Market Object. Gets data from MarketData""" """Stock Market Object. Gets data from MarketData"""
def __init__(self, symbol_info: dict) -> None: def __init__(self, symbol: str) -> None:
self.symbol = symbol_info["ticker"] self.symbol = symbol
self.id = symbol_info["ticker"] self.id = symbol
self.name = symbol_info["title"] self.name = "$" + symbol.upper()
self.tag = "$" + symbol_info["ticker"] self.tag = "$" + symbol.lower()
self.market_cap_rank = symbol_info["mkt_cap_rank"]
class Coin(Symbol): class Coin(Symbol):
+4 -5
View File
@@ -1,7 +1,6 @@
cachetools==5.3.1
humanize==4.8.0
markdownify==0.11.6
mplfinance==0.12.10b0
pandas==2.1.1
requests==2.31.0 requests==2.31.0
pandas==2.1.1
schedule==1.2.1 schedule==1.2.1
mplfinance==0.12.10b0
markdownify==0.11.6
cachetools==5.3.1
+11 -23
View File
@@ -5,7 +5,6 @@ import datetime
import logging import logging
import random import random
import re import re
from typing import Dict
import pandas as pd import pandas as pd
import schedule import schedule
@@ -15,6 +14,8 @@ from common.cg_Crypto import cg_Crypto
from common.MarketData import MarketData from common.MarketData import MarketData
from common.Symbol import Coin, Stock, Symbol from common.Symbol import Coin, Stock, Symbol
from typing import Dict
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@@ -37,7 +38,7 @@ class Router:
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:
# Prune Keys # 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
@@ -47,7 +48,7 @@ class Router:
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 | Coin]: 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.
@@ -64,20 +65,16 @@ class Router:
schedule.run_pending() schedule.run_pending()
symbols: list[Symbol] = [] symbols: list[Symbol] = []
stock_matches = set(re.findall(self.STOCK_REGEX, text)) stocks = set(re.findall(self.STOCK_REGEX, text))
coin_matches = set(re.findall(self.CRYPTO_REGEX, text)) for stock in stocks:
for stock_match in stock_matches:
# Market data lacks tools to check if a symbol is valid. # Market data lacks tools to check if a symbol is valid.
if stock_info := self.stock.symbol_id(stock_match): symbols.append(Stock(stock))
symbols.append(Stock(stock_info))
else:
log.info(f"{stock_match} is not in list of stocks")
for coin_match in coin_matches: coins = set(re.findall(self.CRYPTO_REGEX, text))
sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin_match.lower(), case=False)] for coin in coins:
sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin.lower(), case=False)]
if sym.empty: if sym.empty:
log.info(f"{coin_match} 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:
@@ -396,12 +393,3 @@ class Router:
replies = replies + self.crypto.batch_price(coins) replies = replies + self.crypto.batch_price(coins)
return replies return replies
def options(self, request: str, symbols: list[Symbol]) -> Dict:
request = request.lower()
if len(symbols) == 1:
symbol = symbols[0]
request = request.replace(symbol.tag.lower(), symbol.symbol.lower())
return self.stock.options_reply(request)
else:
return self.stock.options_reply(request)
+5 -7
View File
@@ -1,12 +1,10 @@
-r common/requirements.txt -r common/requirements.txt
-r site/requirements.txt -r docs/requirements.txt
black==23.9.1 black==23.7.0
ipython==8.16.1 flake8==6.1.0
jupyter_client==8.4.0 Flake8-pyproject==1.2.3
jupyter_core==5.4.0
pylama==8.4.1 pylama==8.4.1
mypy==1.5.1 mypy==1.5.1
types-cachetools==5.3.0.6 types-cachetools==5.3.0.6
types-pytz==2023.3.1.1 types-pytz==2023.3.0.1
ruff==0.0.292 ruff==0.0.292
isort==5.12.0
+4 -4
View File
@@ -10,7 +10,7 @@ class D_info:
license = re.sub( license = re.sub(
r"\b\n", r"\b\n",
" ", " ",
r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text, r.get("https://gitlab.com/simple-stock-bots/simple-discord-stock-bot/-/raw/master/LICENSE").text,
) )
help_text = """ help_text = """
@@ -21,7 +21,7 @@ For stock data or hosting your own bot, use my link. This helps keep the bot fre
**Updates**: Join the bot's discord: https://t.me/simplestockbotnews. **Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
**Documentation**: All details about the bot are at [docs](https://simplestockbot.com). **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: The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
- `/chart $$eth` gives Ethereum's monthly chart. - `/chart $$eth` gives Ethereum's monthly chart.
@@ -41,7 +41,7 @@ Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. No
Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord). Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact). Issues with the bot? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
""" """
donate_text = """ donate_text = """
@@ -55,5 +55,5 @@ Every donation supports server costs and
2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). 2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
- It's quick, doesn't need an account, and accepts Paypal or Credit card. - It's quick, doesn't need an account, and accepts Paypal or Credit card.
Questions? Visit our [website](https://simplestockbot.com). Questions? Visit our [website](https://docs.simplestockbot.com).
""" """
+12 -66
View File
@@ -5,9 +5,9 @@ import os
import mplfinance as mpf import mplfinance as mpf
import nextcord import nextcord
from D_info import D_info
from nextcord.ext import commands from nextcord.ext import commands
from D_info import D_info
from common.symbol_router import Router from common.symbol_router import Router
DISCORD_TOKEN = os.environ["DISCORD"] DISCORD_TOKEN = os.environ["DISCORD"]
@@ -38,7 +38,7 @@ async def on_ready():
@bot.command() @bot.command()
async def status(ctx: commands): async def status(ctx: commands):
"""Debug command for diagnosing if the bot is experiencing any issues.""" """Debug command for diagnosing if the bot is experiencing any issues."""
logging.info(f"Status command ran by {ctx.message.author}") logging.warning(f"Status command ran by {ctx.message.author}")
message = "" message = ""
try: try:
message = "Contact MisterBiggs#0465 if you need help.\n" message = "Contact MisterBiggs#0465 if you need help.\n"
@@ -183,74 +183,20 @@ async def trending(ctx: commands):
@bot.event @bot.event
async def on_message(message): async def on_message(message):
# Ignore messages from the bot itself
if message.author.id == bot.user.id: if message.author.id == bot.user.id:
return return
if message.content:
if message.content[0] == "/":
await bot.process_commands(message)
return
content_lower = message.content.lower() if "$" in message.content:
symbols = s.find_symbols(message.content)
# Process commands starting with "/" if symbols:
if message.content.startswith("/"): for reply in s.price_reply(symbols):
await bot.process_commands(message) await message.channel.send(reply)
return return
symbols = None
if "$" in message.content:
symbols = s.find_symbols(message.content)
if "call" in content_lower or "put" in content_lower:
await handle_options(message, symbols)
return
if symbols:
for reply in s.price_reply(symbols):
await message.channel.send(reply)
return
async def handle_options(message, symbols):
logging.info("Options detected")
try:
options_data = s.options(message.content.lower(), symbols)
# Create the embed directly within the function
embed = nextcord.Embed(title=options_data["Option Symbol"], description=options_data["Underlying"], color=0x3498DB)
# Key details
details = (
f"Expiration: {options_data['Expiration']}\n" f"Side: {options_data['side']}\n" f"Strike: {options_data['strike']}"
)
embed.add_field(name="Details", value=details, inline=False)
# Pricing info
pricing_info = (
f"Bid: {options_data['bid']} (Size: {options_data['bidSize']})\n"
f"Mid: {options_data['mid']}\n"
f"Ask: {options_data['ask']} (Size: {options_data['askSize']})\n"
f"Last: {options_data['last']}"
)
embed.add_field(name="Pricing", value=pricing_info, inline=False)
# Volume and open interest
volume_info = f"Open Interest: {options_data['Open Interest']}\n" f"Volume: {options_data['Volume']}"
embed.add_field(name="Activity", value=volume_info, inline=False)
# Greeks
greeks_info = (
f"IV: {options_data['Implied Volatility']}\n"
f"Delta: {options_data['delta']}\n"
f"Gamma: {options_data['gamma']}\n"
f"Theta: {options_data['theta']}\n"
f"Vega: {options_data['vega']}\n"
f"Rho: {options_data['rho']}"
)
embed.add_field(name="Greeks", value=greeks_info, inline=False)
# Send the created embed
await message.channel.send(embed=embed)
except KeyError as ex:
logging.warning(f"KeyError processing options for message {message.content}: {ex}")
bot.run(DISCORD_TOKEN) bot.run(DISCORD_TOKEN)
+1 -1
View File
@@ -1,2 +1,2 @@
nextcord==2.6.0 nextcord==2.4.2
-r requirements.txt -r requirements.txt
+2 -1
View File
@@ -1,9 +1,10 @@
version: "3" version: '3'
services: services:
telegram: telegram:
build: build:
context: . context: .
dockerfile: telegram/Dockerfile dockerfile: telegram/Dockerfile
image: registry.gitlab.com/simple-stock-bots/simple-telegram-stock-bot
env_file: .env env_file: .env
discord: discord:
build: build:
-27
View File
@@ -1,27 +0,0 @@
{
"name": "simple-stock-bot",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"devDependencies": {
"prettier": "3.0.3"
}
},
"node_modules/prettier": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz",
"integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==",
"dev": true,
"bin": {
"prettier": "bin/prettier.cjs"
},
"engines": {
"node": ">=14"
},
"funding": {
"url": "https://github.com/prettier/prettier?sponsor=1"
}
}
}
}
-5
View File
@@ -1,5 +0,0 @@
{
"devDependencies": {
"prettier": "3.0.3"
}
}
+1 -1
View File
@@ -20,4 +20,4 @@ deploy_site:
paths: paths:
- public - public
rules: rules:
- if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH" - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+10 -10
View File
@@ -1,12 +1,12 @@
{ {
"yaml.schemas": { "yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
}, },
"yaml.customTags": [ "yaml.customTags": [
"!ENV scalar", "!ENV scalar",
"!ENV sequence", "!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg", "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:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
] ]
} }
+1
View File
@@ -1 +1,2 @@
# Blog # Blog
+5 -5
View File
@@ -4,7 +4,7 @@ date: 2023-10-10
tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights] tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
authors: [Anson] authors: [Anson]
description: > description: >
Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord! Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord!
--- ---
## What is Simple Stock Bot? ## What is Simple Stock Bot?
@@ -26,7 +26,6 @@ Simple Stock Bot is a chatbot designed to enrich your financial discussions on T
</div> </div>
With Simple Stock Bot, you can: With Simple Stock Bot, you can:
- **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat. - **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat.
- **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat. - **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat.
- **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres. - **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres.
@@ -37,12 +36,13 @@ With Simple Stock Bot, you can:
[:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## Using the Bot ## Using the Bot
Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat! Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat!
Here are some simple commands to get you started: Here are some simple commands to get you started:
- `/intra` to view intraday charts. - `/intra` to view intraday charts.
- `/chart` for a glimpse of the last month's trading data. - `/chart` for a glimpse of the last month's trading data.
- `/trending` to catch up on the latest trending stocks and cryptocurrencies. - `/trending` to catch up on the latest trending stocks and cryptocurrencies.
@@ -51,11 +51,11 @@ Here are some simple commands to get you started:
Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone. Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone.
Feeling generous? You can support the project by [donating](https://simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot). Feeling generous? You can support the project by [donating](https://docs.simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bot).
## Dive Deeper ## Dive Deeper
Craving more insights and features? Explore the [official documentation](https://simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot. Craving more insights and features? Explore the [official documentation](https://docs.simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot.
Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again. Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again.
+4 -12
View File
@@ -5,12 +5,13 @@ Symbols are used in headings to denote what platforms and symbol types a command
- Bot Commands :robot: - Bot Commands :robot:
- Cryptocurrency Support :material-currency-btc: - Cryptocurrency Support :material-currency-btc:
- Stock Market Support :bank: - Stock Market Support :bank:
- OTC Support :dollar:
## Get the Bots ## Get the Bots
[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## Symbol Detection :material-currency-btc: :bank: ## 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. 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.
@@ -28,12 +29,6 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
</div> </div>
</div> </div>
## Options Detection :bank:
This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
![Image of the telegram bot providing options info.](img/telegram_options.png)
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane: ## `/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. 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.
@@ -103,9 +98,7 @@ Gets the latest trending stocks and their change in price
━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━━━━━━━━
$GME: Gamestop Corporation - Class A, 5.06% $GME: Gamestop Corporation - Class A, 5.06%
$MMAT: Meta Materials Inc, 4.77% $MMAT: Meta Materials Inc, 4.77%
$$BTC: Bitcoin, -0.83%
$$
BTC: Bitcoin, -0.83%
$$ETH: Ethereum, 6.06% $$ETH: Ethereum, 6.06%
$$DOGE: Binance-Peg Dogecoin, 0.14% $$DOGE: Binance-Peg Dogecoin, 0.14%
@@ -178,11 +171,10 @@ Bot Status:
</div> </div>
## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: ## 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 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 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. 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 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. `$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
$$
+1 -1
View File
@@ -5,4 +5,4 @@ Your feedback and experience with Simple Stock Bot is invaluable. Whether you've
- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs). - **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`. - **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs). - **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-stock-bot). - **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).
+15 -18
View File
@@ -25,30 +25,27 @@ To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` ke
## Setup Instructions ## Setup Instructions
1. **Download/Clone the Repository**: 1. **Download/Clone the Repository**:
- Download or clone this repository to your local machine.
- Download or clone this repository to your local machine.
2. **Configure Environment Variables**: 2. **Configure Environment Variables**:
- Navigate to the project directory and locate the `.env` file.
- Fill in the `.env` file with your obtained API keys:
- Navigate to the project directory and locate the `.env` file. ```plaintext
- Fill in the `.env` file with your obtained API keys: MARKETDATA=your_marketdata_api_key
STRIPE=your_stripe_api_key
TELEGRAM=your_telegram_api_key
DISCORD=your_discord_api_key
```
```plaintext Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
MARKETDATA=your_marketdata_api_key
STRIPE=your_stripe_api_key
TELEGRAM=your_telegram_api_key
DISCORD=your_discord_api_key
```
Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
3. **Build and Run the Bot:** 3. **Build and Run the Bot:**
- Open a terminal in the project directory.
- Build and run both bots using Docker Compose:
- Open a terminal in the project directory. ```bash
- Build and run both bots using Docker Compose: docker-compose up
```
```bash
docker-compose up
```
Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better. Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

-6
View File
@@ -9,31 +9,25 @@ Discover a new level of financial discussion with Simple Stock Bot, your go-to s
## [Commands](commands.md) ## [Commands](commands.md)
### Real-Time Stock and Cryptocurrency Updates ### Real-Time Stock and Cryptocurrency Updates
- Get live price updates of stocks and cryptocurrencies. - Get live price updates of stocks and cryptocurrencies.
- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin. - Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
### Intraday and Historical Data Visualization ### Intraday and Historical Data Visualization
- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart. - `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
- `/chart`: Provides a chart of the last month's trading data up till the day before. - `/chart`: Provides a chart of the last month's trading data up till the day before.
### Trending Assets Awareness ### Trending Assets Awareness
- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes. - `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
### In-App Assistance and Support ### In-App Assistance and Support
- `/help`: Provides a quick summary of available commands for easy reference. - `/help`: Provides a quick summary of available commands for easy reference.
- `/donate`: Support the maintenance of the bot to ensure continued free access. - `/donate`: Support the maintenance of the bot to ensure continued free access.
### User-Friendly Interaction ### User-Friendly Interaction
- Easy symbol and command usage for a smooth user experience. - Easy symbol and command usage for a smooth user experience.
- Engage with a community of financial enthusiasts and share insights effortlessly. - Engage with a community of financial enthusiasts and share insights effortlessly.
## [Contact](contact.md) ## [Contact](contact.md)
Need assistance or have inquiries? Feel free to reach out and I'll be happy to help. Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
## Powered by MarketData.app ## Powered by MarketData.app
+9 -2
View File
@@ -1,19 +1,21 @@
site_name: Simple Stock Bot site_name: Simple Stock Bot
site_url: https://simplestockbot.com site_url: https://simplestockbot.com
repo_url: https://gitlab.com/simple-stock-bots/simple-stock-bot edit_uri: /simple-stock-bots/site/tree/master/site
repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
repo_name: Simple Stock Bots repo_name: Simple Stock Bots
site_description: Simple Discord and Telegram chat bots for Stock Market Data. site_description: Simple Discord and Telegram chat bots for Stock Market Data.
site_author: Anson Biggs 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> copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
nav: nav:
- Home: index.md - Home: index.md
- Commands: commands.md - Commands: commands.md
- Self-Host: host.md - Self-Host: host.md
- Donate: donate.md - Donate: donate.md
- Contact: contact.md - Contact: contact.md
- Blog: blog/index.md - Blog: /blog
theme: theme:
name: material name: material
@@ -54,14 +56,19 @@ extra:
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
name: MarketData.app for stock data name: MarketData.app for stock data
extra_css: extra_css:
- stylesheets/phone.css - stylesheets/phone.css
plugins: plugins:
- search - search
- social - social
- blog - blog
markdown_extensions: markdown_extensions:
- attr_list - attr_list
- pymdownx.emoji: - pymdownx.emoji:
+4 -4
View File
@@ -10,7 +10,7 @@ class T_info:
license = re.sub( license = re.sub(
r"\b\n", r"\b\n",
" ", " ",
r.get("https://gitlab.com/simple-stock-bots/simple-stock-bot/-/raw/master/LICENSE").text, r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
) )
help_text = """ help_text = """
@@ -21,7 +21,7 @@ Want stock data or to host your own bot? Help keep this bot free by using my
📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews. 📢 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://simplestockbot.com). **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: The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
- `/chart $$eth` gets a month's Ethereum chart. - `/chart $$eth` gets a month's Ethereum chart.
@@ -43,7 +43,7 @@ Pick a ticker, and the bot shares the current price in chat. Note: Prices can la
Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram). Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
Bot issues? Use `/status` or [contact us](https://simplestockbot.com/contact). Bot issues? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
""" """
@@ -56,7 +56,7 @@ All funds help maintain servers, with data from
1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD. 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. 2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
For questions, visit our [website](https://simplestockbot.com). For questions, visit our [website](https://docs.simplestockbot.com).
""" """
+3 -60
View File
@@ -178,33 +178,17 @@ async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
message = update.message.text message = update.message.text
chat_id = update.message.chat_id chat_id = update.message.chat_id
if "$" in message: if "$" in message:
log.info("Looking for Symbols")
symbols = s.find_symbols(message) symbols = s.find_symbols(message)
log.info("Looking for Symbols")
else: else:
return return
except AttributeError as ex: except AttributeError as ex:
log.info(ex) log.info(ex)
return return
# Detect Options
if ("call" in message.lower()) or ("put" in message.lower()):
log.info("Options detected")
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
try:
options_data = s.options(message, symbols)
await update.message.reply_text(
text=generate_options_reply(options_data),
parse_mode=telegram.constants.ParseMode.MARKDOWN,
)
return
except KeyError as ex:
logging.warning(ex)
pass
if symbols: if symbols:
log.info(f"Symbols found: {symbols}") # Let user know bot is working
await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING) await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
log.info(f"Symbols found: {symbols}")
for reply in s.price_reply(symbols): for reply in s.price_reply(symbols):
await update.message.reply_text( await update.message.reply_text(
@@ -214,47 +198,6 @@ async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
) )
def generate_options_reply(options_data: dict):
# Header with Option Symbol and Underlying
message_text = f"*{options_data['Option Symbol']} ({options_data['Underlying']})*\n\n"
# Key details
details = (
f"*Expiration:* `{options_data['Expiration']}`\n"
f"*Side:* `{options_data['side']}`\n"
f"*Strike:* `{options_data['strike']}`\n"
f"*First Traded:* `{options_data['First Traded']}`\n"
f"*Last Updated:* `{options_data['Last Updated']}`\n\n"
)
message_text += details
# Pricing info
pricing_info = (
f"*Bid:* `{options_data['bid']}` (Size: `{options_data['bidSize']}`)\n"
f"*Mid:* `{options_data['mid']}`\n"
f"*Ask:* `{options_data['ask']}` (Size: `{options_data['askSize']}`)\n"
f"*Last:* `{options_data['last']}`\n\n"
)
message_text += pricing_info
# Volume and open interest
volume_info = f"*Open Interest:* `{options_data['Open Interest']}`\n" f"*Volume:* `{options_data['Volume']}`\n\n"
message_text += volume_info
# Greeks
greeks_info = (
f"*IV:* `{options_data['Implied Volatility']}`\n"
f"*Delta:* `{options_data['delta']}`\n"
f"*Gamma:* `{options_data['gamma']}`\n"
f"*Theta:* `{options_data['theta']}`\n"
f"*Vega:* `{options_data['vega']}`\n"
f"*Rho:* `{options_data['rho']}`\n"
)
message_text += greeks_info
return message_text
async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE): async def intra(update: Update, context: ContextTypes.DEFAULT_TYPE):
"""returns a chart of intraday data for a symbol""" """returns a chart of intraday data for a symbol"""
log.info(f"Intra command ran by {update.message.chat.username}") log.info(f"Intra command ran by {update.message.chat.username}")
+1 -1
View File
@@ -1,2 +1,2 @@
python-telegram-bot==20.6 python-telegram-bot==20.5
-r requirements.txt -r requirements.txt
+12 -2
View File
@@ -1,9 +1,19 @@
import keyboard
import time import time
import keyboard
tests = """$$xno tests = """$$xno
$tsla /info $tsla
/info $$btc
/news $tsla
/news $$btc
/stat $tsla
/stat $$btc
/cap $tsla
/cap $$btc
/dividend $tsla
/dividend $msft
/dividend $$btc
/intra $tsla /intra $tsla
/intra $$btc /intra $$btc
/chart $tsla /chart $tsla