Merge branch '110-add-options' into 'master'

Resolve "Add Options from MarketData.app"

Closes #110

See merge request simple-stock-bots/simple-telegram-stock-bot!56

.devcontainer/Dockerfile

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

.devcontainer/devcontainer.json

@@ -17,11 +17,11 @@
     "vscode": {
       "extensions": [
 		"ms-python.python",
-		"ms-python.black-formatter",
+    "ms-python.black-formatter",
-		"ms-python.flake8",
 		"ms-python.vscode-pylance",
 		"ms-python.isort",
-		"charliermarsh.ruff"
+    "charliermarsh.ruff",
+    "ms-toolsai.jupyter"
 	]
     }
   },

.gitlab-ci.yml

@@ -1,6 +1,9 @@
 stages:
   - lint
+  - build
+  - build_site
   - deploy
+  - deploy_site
 
 black:
   stage: lint
@@ -18,4 +21,4 @@ ruff:
 
 
 include:
-  - local: /docs/.gitlab-ci.yml
+  - local: /site/.gitlab-ci.yml

.vscode/settings.json

@@ -4,5 +4,7 @@
     "editor.formatOnSaveMode": "modificationsIfAvailable",
     "[python]": {
         "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true,
+        "editor.formatOnSaveMode": "file"
     }
 }

README.md

@@ -1,32 +1,44 @@
-# Simple Telegram Stock Bot
+# Simple Stock Bots
 
-
+[![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-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)
-[![Author](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
+[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
 
-## Docs
+Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed.
 
-https://docs.simplestockbot.com/
+## Documentation
 
-## Usage
+Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
+- [Official Documentation](https://simplestockbot.com/)
+- [Command Reference](https://simplestockbot.com/commands/)
 
-https://docs.simplestockbot.com/commands/
+## Support the Project
 
-## Donate
+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 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).
+You can contribute by:
+- 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.
+- [Getting in touch](contact.md) for any inquiries or suggestions.
 
-The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
+### Additional Support:
 
-Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
+- Follow on [Twitter](https://twitter.com/AnsonBiggs)
-
+- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
-If you have any questions get in [touch.](contact.md)
+- Utilize referral links for self-hosting:
-
-## 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
   - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
+  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
+
+## Hosting
+
+Self-hosting instructions are provided for those interested in running the bot on their own servers:
+- [Hosting Guide](https://simplestockbot.com/hosting/)
+
+## Contact
+
+Reach out for bug reports, feature requests, or other inquiries:
+- [Contact Page](https://simplestockbot.com/contact/)
+
+---
+
+Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.

common/MarketData.py

@@ -2,7 +2,9 @@ import datetime as dt
 import logging
 import os
 from typing import Dict
+from collections import OrderedDict
 
+import humanize
 import pandas as pd
 import pytz
 import requests as r
@@ -20,6 +22,7 @@ class MarketData:
 
     SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
 
+    symbol_list: Dict[str, Dict] = {}
     charts: Dict[Stock, pd.DataFrame] = {}
 
     openTime = dt.time(hour=9, minute=30, second=0)
@@ -48,6 +51,9 @@ class MarketData:
         if self.MARKETDATA_TOKEN != "":
             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:
         url = "https://api.marketdata.app/v1/" + endpoint
 
@@ -85,6 +91,21 @@ class MarketData:
 
         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:
         """
         Clears cache of chart data.
@@ -129,13 +150,13 @@ class MarketData:
             Formatted markdown
         """
 
-        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
+        if quoteResp := self.get(f"stocks/quotes/{symbol.symbol}/"):
             price = round(quoteResp["last"][0], 2)
 
             try:
                 changePercent = round(quoteResp["changepct"][0], 2)
             except TypeError:
-                return f"The price of {symbol} is {price}"
+                return f"The price of {symbol.name} is ${price}"
 
             message = f"The current price of {symbol.name} is ${price} and "
 
@@ -267,3 +288,58 @@ class MarketData:
             return df
 
         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

common/Symbol.py

@@ -1,6 +1,7 @@
-import pandas as pd
 import logging
 
+import pandas as pd
+
 
 class Symbol:
     """
@@ -29,11 +30,12 @@ class Symbol:
 class Stock(Symbol):
     """Stock Market Object. Gets data from MarketData"""
 
-    def __init__(self, symbol: str) -> None:
+    def __init__(self, symbol_info: dict) -> None:
-        self.symbol = symbol
+        self.symbol = symbol_info["ticker"]
-        self.id = symbol
+        self.id = symbol_info["ticker"]
-        self.name = "$" + symbol.upper()
+        self.name = symbol_info["title"]
-        self.tag = "$" + symbol.lower()
+        self.tag = "$" + symbol_info["ticker"]
+        self.market_cap_rank = symbol_info["mkt_cap_rank"]
 
 
 class Coin(Symbol):

common/requirements.txt

@@ -1,6 +1,7 @@
-requests==2.31.0
-pandas==2.1.1
-schedule==1.2.1
-mplfinance==0.12.10b0
-markdownify==0.11.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
+schedule==1.2.1

common/symbol_router.py

@@ -5,6 +5,7 @@ import datetime
 import logging
 import random
 import re
+from typing import Dict
 
 import pandas as pd
 import schedule
@@ -14,8 +15,6 @@ from common.cg_Crypto import cg_Crypto
 from common.MarketData import MarketData
 from common.Symbol import Coin, Stock, Symbol
 
-from typing import Dict
-
 log = logging.getLogger(__name__)
 
 
@@ -38,7 +37,7 @@ class Router:
             t_copy = self.trending_count.copy()
             for key in t_copy.keys():
                 if t_copy[key] < 0.01:
-                    # This just makes sure were not keeping around keys that havent been called in a very long time.
+                    # Prune Keys
                     dead_keys.append(key)
                 else:
                     t_copy[key] = t_copy[key] * decay
@@ -48,7 +47,7 @@ class Router:
         self.trending_count = t_copy.copy()
         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 | Coin]:
         """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.
 
@@ -65,16 +64,20 @@ class Router:
         schedule.run_pending()
 
         symbols: list[Symbol] = []
-        stocks = set(re.findall(self.STOCK_REGEX, text))
+        stock_matches = set(re.findall(self.STOCK_REGEX, text))
-        for stock in stocks:
+        coin_matches = set(re.findall(self.CRYPTO_REGEX, text))
-            # Market data lacks tools to check if a symbol is valid.
-            symbols.append(Stock(stock))
 
-        coins = set(re.findall(self.CRYPTO_REGEX, text))
+        for stock_match in stock_matches:
-        for coin in coins:
+            # Market data lacks tools to check if a symbol is valid.
-            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin.lower(), case=False)]
+            if stock_info := self.stock.symbol_id(stock_match):
+                symbols.append(Stock(stock_info))
+            else:
+                log.info(f"{stock_match} is not in list of stocks")
+
+        for coin_match in coin_matches:
+            sym = self.crypto.symbol_list[self.crypto.symbol_list["symbol"].str.fullmatch(coin_match.lower(), case=False)]
             if sym.empty:
-                log.info(f"{coin} is not in list of coins")
+                log.info(f"{coin_match} is not in list of coins")
             else:
                 symbols.append(Coin(sym))
         if symbols:
@@ -393,3 +396,12 @@ class Router:
             replies = replies + self.crypto.batch_price(coins)
 
         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)

dev-reqs.txt

@@ -1,10 +1,12 @@
 -r common/requirements.txt
--r docs/requirements.txt
+-r site/requirements.txt
-black==23.7.0
+black==23.9.1
-flake8==6.1.0
+ipython==8.16.1
-Flake8-pyproject==1.2.3
+jupyter_client==8.4.0
+jupyter_core==5.4.0
 pylama==8.4.1
 mypy==1.5.1
 types-cachetools==5.3.0.6
-types-pytz==2023.3.0.1
+types-pytz==2023.3.1.1
 ruff==0.0.292
+isort==5.12.0

discord/D_info.py

@@ -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.
 
-**Documentation**: All details about the bot are at [docs](https://docs.simplestockbot.com).
+**Documentation**: All details about the bot are at [docs](https://simplestockbot.com).
 
 The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
 - `/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).
 
-Issues with the bot? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
+Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact).
     """
 
     donate_text = """
@@ -55,5 +55,5 @@ Every donation supports server costs and
 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).
+Questions? Visit our [website](https://simplestockbot.com).
 """

discord/bot.py

@@ -5,9 +5,9 @@ import os
 
 import mplfinance as mpf
 import nextcord
+from D_info import D_info
 from nextcord.ext import commands
 
-from D_info import D_info
 from common.symbol_router import Router
 
 DISCORD_TOKEN = os.environ["DISCORD"]
@@ -38,7 +38,7 @@ async def on_ready():
 @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}")
+    logging.info(f"Status command ran by {ctx.message.author}")
     message = ""
     try:
         message = "Contact MisterBiggs#0465 if you need help.\n"
@@ -183,20 +183,74 @@ async def trending(ctx: commands):
 
 @bot.event
 async def on_message(message):
+    # Ignore messages from the bot itself
     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:
+    content_lower = message.content.lower()
-            symbols = s.find_symbols(message.content)
 
-            if symbols:
+    # Process commands starting with "/"
-                for reply in s.price_reply(symbols):
+    if message.content.startswith("/"):
-                    await message.channel.send(reply)
+        await bot.process_commands(message)
-                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)

discord/discord-reqs.txt

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

docs/.gitlab-ci.yml

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

docs/README.md

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

docs/docs/contact.md

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

docs/docs/donate.md

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

docs/docs/host.md

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

docs/docs/index.md

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

site/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+image: python:3.11
+
+build_site:
+  stage: build
+  script:
+    - cd ./site
+    - pip install -r requirements.txt
+    - mkdocs build --site-dir ../public --verbose
+  artifacts:
+    paths:
+      - public
+
+deploy_site:
+  stage: deploy
+  script:
+    - echo "Publishing site..."
+  dependencies:
+    - build_site
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

site/docs/blog/.authors.yml

@@ -0,0 +1,5 @@
+authors:
+  Anson:
+    name: Anson Biggs
+    description: Creator
+    avatar: https://gitlab.com/uploads/-/system/user/avatar/1377308/avatar.png

site/docs/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

site/docs/blog/posts/intro.md

@@ -0,0 +1,64 @@
+---
+title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz"
+date: 2023-10-10
+tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
+authors: [Anson]
+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!
+---
+
+## What is Simple Stock Bot?
+
+Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging.
+
+<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>
+
+With Simple Stock Bot, you can:
+- **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.
+- **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres.
+
+## Add the Bot to your Group
+
+[: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 }
+
+
+
+## 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!
+
+Here are some simple commands to get you started:
+- `/intra` to view intraday charts.
+- `/chart` for a glimpse of the last month's trading data.
+- `/trending` to catch up on the latest trending stocks and cryptocurrencies.
+
+## Keeping It Free
+
+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-bot).
+
+## Dive Deeper
+
+Craving more insights and features? Explore the [official documentation](https://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.
+
+---
+
+Stay tuned for more updates, tips, and financial insights brought to you by Simple Stock Bot. Here’s to making every financial discussion enriched and informed!

site/docs/commands.md

@@ -1,13 +1,16 @@
 Symbols are used in headings to denote what platforms and symbol types a command supports.
 
-- Telegram Only :fontawesome-brands-telegram-plane:
+- Telegram Only :fontawesome-brands-telegram:
 - 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:
+## 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 }
+
+## Symbol Detection :material-currency-btc: :bank:  
 
 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.
 
@@ -25,6 +28,13 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
     </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: 
 
 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.
@@ -167,7 +177,7 @@ Bot Status:
 
 </div>
 
-## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
+## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank:  
 
 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

site/docs/contact.md

@@ -0,0 +1,8 @@
+# I Would Love to Hear From You!
+
+Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
+
+- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
+- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
+- **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-telegram-stock-bot).

site/docs/donate.md

@@ -0,0 +1,21 @@
+# Support Simple Stock Bot
+
+Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
+
+Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
+
+For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
+
+Should you have any inquiries, feel free to get in [touch](contact.md).
+
+## Additional Support:
+
+Your engagement also counts as support! Here are other ways to contribute:
+
+- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
+- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
+- If you plan to host your own bot, consider using my referral links:
+  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
+  - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
+
+Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.

site/docs/host.md

@@ -0,0 +1,51 @@
+# Self-Hosting Guide
+
+This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
+
+## 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 }
+
+## Pre-requisites
+
+Ensure the following are installed or obtained before proceeding:
+
+- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
+- **API Keys**:
+  - **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
+  - **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
+  - **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
+
+!!! tip
+    The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
+
+!!! note
+    To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
+
+## Setup Instructions
+
+1. **Download/Clone the Repository**:
+    - Download or clone this repository to your local machine.
+
+2. **Configure Environment Variables**:
+    - Navigate to the project directory and locate the `.env` file.
+    - Fill in the `.env` file with your obtained API keys:
+
+    ```plaintext
+    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:**
+    - Open a terminal in the project directory.
+    - Build and run both bots using Docker Compose:
+
+    ```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.

site/docs/index.md

@@ -0,0 +1,35 @@
+# Elevate Your Groupchats with Real-time Stock Insights
+
+Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
+
+## 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 }
+
+## [Commands](commands.md)
+
+### Real-Time Stock and Cryptocurrency Updates
+- 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.
+
+### Intraday and Historical Data Visualization
+- `/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.
+
+### Trending Assets Awareness
+- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
+
+### In-App Assistance and Support
+- `/help`: Provides a quick summary of available commands for easy reference.
+- `/donate`: Support the maintenance of the bot to ensure continued free access.
+
+### User-Friendly Interaction
+- Easy symbol and command usage for a smooth user experience.
+- Engage with a community of financial enthusiasts and share insights effortlessly.
+
+## [Contact](contact.md)
+Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
+
+## Powered by MarketData.app
+
+Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.

site/mkdocs.yml

@@ -1,7 +1,7 @@
-site_name: Simple Stock Bot Docs
+site_name: Simple Stock Bot
-site_url: https://docs.simplestockbot.com
+site_url: https://simplestockbot.com
-edit_uri: /simple-stock-bots/site/tree/master/docs
+edit_uri: /simple-stock-bots/site/tree/master/site
-repo_url: https://gitlab.com/simple-stock-bots
+repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
 repo_name: Simple Stock Bots
 
 site_description: Simple Discord and Telegram chat bots for Stock Market Data.
@@ -12,9 +12,10 @@ copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available
 nav:
   - Home: index.md
   - Commands: commands.md
-  - Hosting: host.md
+  - Self-Host: host.md
   - Donate: donate.md
   - Contact: contact.md
+  - Blog: blog/index.md
 
 theme:
   name: material
@@ -24,7 +25,7 @@ theme:
     - navigation.tracking
     - navigation.tabs
     - navigation.tabs.sticky
-    - navigation.footer
+    - content.code.copy
   icon:
     logo: material/robot-love
   palette:
@@ -52,7 +53,7 @@ extra:
       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
+      link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
       name: MarketData.app for stock data
 
 
@@ -65,10 +66,14 @@ extra_css:
 plugins:
   - search
   - social
+  - blog
 
 
 markdown_extensions:
-- attr_list
+  - attr_list
-- pymdownx.emoji:
+  - pymdownx.emoji:
-    emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_index: !!python/name:materialx.emoji.twemoji
-    emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences

telegram/T_info.py

@@ -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.
 
-**Guide**: All about using and setting up the bot is in the [docs](https://docs.simplestockbot.com).
+**Guide**: All about using and setting up the bot is in the [docs](https://simplestockbot.com).
 
 The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
 - `/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).
 
-Bot issues? Use `/status` or [contact us](https://docs.simplestockbot.com/contact).
+Bot issues? Use `/status` or [contact us](https://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.
 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).
+For questions, visit our [website](https://simplestockbot.com).
 """
 
 

telegram/bot.py

@@ -178,17 +178,33 @@ async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
         message = update.message.text
         chat_id = update.message.chat_id
         if "$" in message:
-            symbols = s.find_symbols(message)
             log.info("Looking for Symbols")
+            symbols = s.find_symbols(message)
         else:
             return
     except AttributeError as ex:
         log.info(ex)
         return
-    if symbols:
+
-        # Let user know bot is working
+    # 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:
         log.info(f"Symbols found: {symbols}")
+        await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
 
         for reply in s.price_reply(symbols):
             await update.message.reply_text(
@@ -198,6 +214,47 @@ 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):
     """returns a chart of intraday data for a symbol"""
     log.info(f"Intra command ran by {update.message.chat.username}")

telegram/telegram-reqs.txt

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

tests.py

@@ -1,19 +1,9 @@
-import keyboard
 import time
 
+import keyboard
 
 tests = """$$xno
-/info $tsla
+$tsla
-/info $$btc
-/news $tsla
-/news $$btc
-/stat $tsla
-/stat $$btc
-/cap $tsla
-/cap $$btc
-/dividend $tsla
-/dividend $msft
-/dividend $$btc
 /intra $tsla
 /intra $$btc
 /chart $tsla