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

@@ -0,0 +1,3 @@
+FROM python:3.11
+
+COPY . .

.devcontainer/devcontainer.json

@@ -0,0 +1,39 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+  "name": "Python 3",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/black:2": {},
+    "ghcr.io/devcontainers-contrib/features/mypy:2": {},
+    "ghcr.io/devcontainers-contrib/features/pylint:2": {},
+    "ghcr.io/devcontainers/features/docker-in-docker": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+		"ms-python.python",
+    "ms-python.black-formatter",
+		"ms-python.vscode-pylance",
+		"ms-python.isort",
+    "charliermarsh.ruff",
+    "ms-toolsai.jupyter"
+	]
+    }
+  },
+  "postCreateCommand": "pip3 install --user -r dev-reqs.txt"
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "pip3 install --user -r requirements.txt",
+  // Configure tool-specific properties.
+  // "customizations": {},
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

.gitignore

@@ -1,2 +1,2 @@
-__pycache__/
+__pycache__
-.vscode
+.env

.gitlab-ci.yml

@@ -0,0 +1,24 @@
+stages:
+  - lint
+  - build
+  - build_site
+  - deploy
+  - deploy_site
+
+black:
+  stage: lint
+  image: registry.gitlab.com/pipeline-components/black:latest
+  script:
+    - black --check --verbose -- .
+
+ruff:
+  stage: lint
+  # image: registry.gitlab.com/pipeline-components/ruff:latest
+  image: python:3.11-slim
+  script:
+    - pip3 install ruff
+    - ruff --output-format gitlab .
+
+
+include:
+  - local: /site/.gitlab-ci.yml

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.formatOnSaveMode": "modificationsIfAvailable",
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true,
+        "editor.formatOnSaveMode": "file"
+    }
+}

Dockerfile

@@ -1,10 +0,0 @@
-FROM python:3.8-buster
-
-
-
-COPY requirements.txt ./
-RUN pip install --no-cache-dir -U -r requirements.txt
-
-COPY . .
-
-CMD [ "python", "./bot.py" ]

LICENSE

@@ -1,21 +1,21 @@
-MIT License
+MIT License
-
+
-Copyright (c) 2019 Anson Biggs
+Copyright (c) 2019 Anson Biggs
-
+
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
+of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
+in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+furnished to do so, subject to the following conditions:
-
+
-The above copyright notice and this permission notice shall be included in all
+The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+copies or substantial portions of the Software.
-
+
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,173 +1,44 @@
-<div align="center">
+# Simple Stock Bots
-<p align="center">
+
-  <a href="" rel="noopener">
+[![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-blue.svg)](https://t.me/SimpleStockBot)
- <img width=200px height=200px src="https://assets.gitlab-static.net/uploads/-/system/project/avatar/10295651/TelegramLogo.jpg?width=64" alt="Simple Telegram Stock Bot"></a>
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
-</p>
+[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
-
+
-<h3 align="center">Simple Telegram Stock Bot</h3>
+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.
-
+
-<a href="https://www.buymeacoffee.com/Anson" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Beer" style="height: 51px !important;width: 217px !important;" ></a>
+## Documentation
-
+
-[![Status](https://img.shields.io/badge/status-active-success.svg)]()
+Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
-[![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)]()
+- [Official Documentation](https://simplestockbot.com/)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
+- [Command Reference](https://simplestockbot.com/commands/)
-
+
-</div>
+## 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).
-
+
-<p align="center"> Telegram Bot 🤖 that provides Stock Market information.
+You can contribute by:
-    <br> 
+- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
-</p>
+- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
-
+- [Getting in touch](contact.md) for any inquiries or suggestions.
-Message the bot on Telegram [@SimpleStockBot](https://t.me/SimpleStockBot)
+
-## 📝 Table of Contents
+### Additional Support:
-
+
-- [About](#about)
+- Follow on [Twitter](https://twitter.com/AnsonBiggs)
-- [How it works](#working)
+- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
-- [Usage](#usage)
+- Utilize referral links for self-hosting:
-- [Getting Started](#getting_started)
+  - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
-- [Deploying your own bot](#deployment)
+  - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
-- [Built Using](#built_using)
+
-- [Contributing](../CONTRIBUTING.md)
+## Hosting
-- [author](#author)
+
-- [Acknowledgments](#acknowledgement)
+Self-hosting instructions are provided for those interested in running the bot on their own servers:
-
+- [Hosting Guide](https://simplestockbot.com/hosting/)
-## 🧐 About <a name = "about"></a>
+
-
+## Contact
-This bot aims to be as simple as possible while providing all the information you need on the stock market. The motivation of this bot is to provide similar stock market functionality that the Google Assistant provided in [Google Allo](https://gcemetery.co/google-allo/) before the project was sunset.
+
-
+Reach out for bug reports, feature requests, or other inquiries:
-## 💭 How it works <a name = "working"></a>
+- [Contact Page](https://simplestockbot.com/contact/)
-
+
-This bot works by using the [IEX API 2.0](https://iexcloud.io/docs/api/). Using various endpoints provided by the API, the bot can take either take commands from users or check any messages for stock symbols as detailed in [Usage](#usage).
+---
-
+
-## 🎈 Usage <a name = "usage"></a>
+Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.
-
-### Basic Usage
-
-The simplest way to use the bot is just by sending a message either as a direct message or in a group chat with the bot active. The bot will search every message for text with a dollar sign followed by a stock symbol, and it will return the full name of the company and the current trading price.
-
-```
-$tsla
-```
-
-The symbols can be anywhere in the message, and you can post as many as you like so commands such as:
-
-```
-I wonder if $aapl is down as much as $msft is today.
-```
-
-would return the stock price of both Apple and Microsoft like so:
-
-```
-The current stock price of Microsoft Corp. is $131.4, the stock is currently up 2.8%
-
-The current stock price of Apple, Inc. is $190.15, the stock is currently up 2.66%
-```
-
-### /dividend
-
-To get information about the dividend of a stock type `/dividend` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
-
-```
-/dividend $psec
-```
-
-Would return information about Prospect Capitals dividend:
-
-```
-Prospect Capital Corp. Declares June 2019 Dividend of $0.06 Per Share
-The dividend is in: 38 Days 3 Hours 53 Minutes 22 Seconds.
-```
-
-💡 you can also call the dividend command using /div
-
-### /news
-
-To get the latest news about a stock symbol use `/news` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
-
-```
-/news $psec
-```
-
-Would return news for Prospect Capital:
-
-News for PSEC:
-
-[Yield-Starved Investors Still Accumulating BDCs Paying More Than 10% Annually](https://cloud.iexapis.com/v1/news/article/d994b8b5-9fbf-4ceb-afbe-e6defcfc6352)
-
-[Assessing Main Street Capital's Results For Q1 2019 (Includes Updated Price Target And Investment Ratings Analysis)](https://cloud.iexapis.com/v1/news/article/e60899bc-5230-4388-a609-fc2b8736a7d4)
-
-[Fully Assessing Prospect Capital's Fiscal Q3 2019 (Includes Current Recommendation And Price Target)](https://cloud.iexapis.com/v1/news/article/08881160-72c5-4f5d-885b-1751187d24eb)
-
-### /info
-
-To get information about a stock type `/info` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
-
-```
-/info $psec
-```
-
-Would return information about Prospect Capitals:
-
-Company Name: [Prospect Capital Corp.](http://www.prospectstreet.com/)  
-Industry: Investment Managers  
-Sector: Finance  
-CEO: John Francis Barry  
-Description: Prospect Capital Corp. is a business development company, which engages in lending to and investing in private businesses. It also involves in generating current income and long-term capital appreciation through debt and equity investments. The company was founded on April 13, 2004 and is headquartered in New York, NY.
-
-## 🏁 Getting Started <a name = "getting_started"></a>
-
-You can either choose to use the hosted version of the bot by [clicking here](https://t.me/SimpleStockBot) or you can host your own bot with the instructions below.
-
-### 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. See [deployment](#deployment) for notes on how to deploy the project on a live system.
-
-### 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.
-
-You will also need a 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)
-
-Finally, you will need and IEX Cloud API key. They offer a free tier that should be enough for any private groups, more details [here.](https://iexcloud.io/)
-
-### Installing
-
-Once Docker is installed and you have your API keys for Telegram and IEX Cloud 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 \
-     -e IEX=IEX_API \
-      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.
-
-## 🚀 Deploying your own bot <a name = "deployment"></a>
-
-I recommend Digital Ocean for small projects like this because it is straightforward to use and affordable. [Sign up with my referral code, and we both get some free hosting.](https://m.do.co/c/6b5df7ef55b6)
-
-## ⛏️ Built Using <a name = "built_using"></a>
-
-- [python-telegram-bot](https://python-telegram-bot.org/) - Python Telegram API Wrapper
-- [Digital Ocean](https://www.digitalocean.com/) - IaaS hosting platform
-
-## ✍️ author <a name = "author"></a>
-
-- [Anson Biggs](https://blog.ansonbiggs.com/author/anson/) - The one and only
-
-## 🎉 Acknowledgements <a name = "acknowledgement"></a>
-
-- Telegram for having a great bot API
-- IEX Cloud for offering a free tier
-- Viewers like you ♥

bot.py

@@ -1,520 +0,0 @@
-# Works with Python 3.8
-import datetime
-import io
-import logging
-import os
-import random
-import html
-import json
-import traceback
-
-import mplfinance as mpf
-import telegram
-from telegram import (
-    InlineQueryResultArticle,
-    InputTextMessageContent,
-    LabeledPrice,
-    Update,
-)
-from telegram.ext import (
-    CommandHandler,
-    Filters,
-    InlineQueryHandler,
-    MessageHandler,
-    PreCheckoutQueryHandler,
-    Updater,
-    CallbackContext,
-)
-
-from functions import Symbol
-
-TELEGRAM_TOKEN = os.environ["TELEGRAM"]
-
-try:
-    IEX_TOKEN = os.environ["IEX"]
-except KeyError:
-    IEX_TOKEN = ""
-    print("Starting without an IEX Token will not allow you to get market data!")
-try:
-    STRIPE_TOKEN = os.environ["STRIPE"]
-except KeyError:
-    STRIPE_TOKEN = ""
-    print("Starting without a STRIPE Token will not allow you to accept Donations!")
-
-s = Symbol(IEX_TOKEN)
-# Enable logging
-logging.basicConfig(
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
-)
-
-logger = logging.getLogger(__name__)
-print("Bot Online")
-
-
-def start(update: Update, context: CallbackContext):
-    """Send a message when the command /start is issued."""
-    update.message.reply_text(text=s.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
-
-
-def help(update: Update, context: CallbackContext):
-    """Send link to docs when the command /help is issued."""
-
-    update.message.reply_text(text=s.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
-
-
-def license(update: Update, context: CallbackContext):
-    """Return bots license agreement"""
-
-    update.message.reply_text(text=s.license, parse_mode=telegram.ParseMode.MARKDOWN)
-
-
-def status(update: Update, context: CallbackContext):
-    message = ""
-    try:
-        # Bot Status
-        bot_resp = (
-            datetime.datetime.now(update.message.date.tzinfo) - update.message.date
-        )
-        message += f"It took {bot_resp.total_seconds()} seconds for the bot to get your message.\n"
-
-        # IEX Status
-        message += s.iex_status() + "\n"
-
-        # Message Status
-        message += s.message_status()
-    except Exception as ex:
-        message += (
-            f"*\n\nERROR ENCOUNTERED:*\n{ex}\n\n"
-            + "*The bot encountered an error while attempting to find errors. Please contact the bot admin.*"
-        )
-
-    update.message.reply_text(text=message, parse_mode=telegram.ParseMode.MARKDOWN)
-
-
-def donate(update: Update, context: CallbackContext):
-    chat_id = update.message.chat_id
-
-    if update.message.text.strip() == "/donate":
-        update.message.reply_text(
-            text=s.donate_text, parse_mode=telegram.ParseMode.MARKDOWN
-        )
-        return
-    else:
-        amount = update.message.text.replace("/donate", "").replace("$", "").strip()
-    title = "Simple Stock Bot Donation"
-    description = f"Simple Stock Bot Donation of ${amount}"
-    payload = "simple-stock-bot"
-    provider_token = STRIPE_TOKEN
-    start_parameter = str(chat_id)
-
-    print(start_parameter)
-    currency = "USD"
-
-    try:
-        price = int(float(amount) * 100)
-    except ValueError:
-        update.message.reply_text(f"{amount} is not a valid donation amount or number.")
-        return
-    print(price)
-
-    prices = [LabeledPrice("Donation:", price)]
-
-    context.bot.send_invoice(
-        chat_id,
-        title,
-        description,
-        payload,
-        provider_token,
-        start_parameter,
-        currency,
-        prices,
-    )
-
-
-def precheckout_callback(update: Update, context: CallbackContext):
-    query = update.pre_checkout_query
-
-    if query.invoice_payload == "simple-stock-bot":
-        # answer False pre_checkout_query
-        query.answer(ok=True)
-    else:
-        query.answer(ok=False, error_message="Something went wrong...")
-
-
-def successful_payment_callback(update: Update, context: CallbackContext):
-    update.message.reply_text("Thank you for your donation!")
-
-
-def symbol_detect(update: Update, context: CallbackContext):
-    """
-    Runs on any message that doesn't have a command and searches for symbols,
-        then returns the prices of any symbols found.
-    """
-    message = update.message.text
-    chat_id = update.message.chat_id
-    symbols = s.find_symbols(message)
-
-    if symbols:
-        # Let user know bot is working
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-
-        for reply in s.price_reply(symbols).items():
-
-            update.message.reply_text(
-                text=reply[1], parse_mode=telegram.ParseMode.MARKDOWN
-            )
-
-
-def dividend(update: Update, context: CallbackContext):
-    """
-    waits for /dividend or /div command and then finds dividend info on that symbol.
-    """
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/dividend":
-        update.message.reply_text(
-            "This command gives info on the next dividend date for a symbol.\nExample: /dividend $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message)
-
-    if symbols:
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-        for symbol in symbols:
-            update.message.reply_text(
-                text=s.dividend_reply(symbol), parse_mode=telegram.ParseMode.MARKDOWN
-            )
-
-
-def news(update: Update, context: CallbackContext):
-    """
-    waits for /news command and then finds news info on that symbol.
-    """
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/news":
-        update.message.reply_text(
-            "This command gives the most recent english news for a symbol.\nExample: /news $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message)
-
-    if symbols:
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-
-        for reply in s.news_reply(symbols).items():
-            update.message.reply_text(
-                text=reply[1], parse_mode=telegram.ParseMode.MARKDOWN
-            )
-
-
-def info(update: Update, context: CallbackContext):
-    """
-    waits for /info command and then finds info on that symbol.
-    """
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/info":
-        update.message.reply_text(
-            "This command gives information on a symbol.\nExample: /info $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message)
-
-    if symbols:
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-
-        for reply in s.info_reply(symbols).items():
-            update.message.reply_text(
-                text=reply[1], parse_mode=telegram.ParseMode.MARKDOWN
-            )
-
-
-def search(update: Update, context: CallbackContext):
-    message = update.message.text.replace("/search ", "")
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/search":
-        update.message.reply_text(
-            "This command searches for symbols supported by the bot.\nExample: /search Tesla Motors or /search $tsla"
-        )
-        return
-
-    context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-    queries = s.search_symbols(message)[:6]
-    if queries:
-        reply = "*Search Results:*\n`$ticker: Company Name`\n"
-        for query in queries:
-            reply += "`" + query[1] + "`\n"
-        update.message.reply_text(text=reply, parse_mode=telegram.ParseMode.MARKDOWN)
-
-
-def intra(update: Update, context: CallbackContext):
-    # TODO: Document usage of this command. https://iexcloud.io/docs/api/#historical-prices
-
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/intra":
-        update.message.reply_text(
-            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
-        )
-        return
-
-    symbol = s.find_symbols(message)[0]
-
-    df = s.intra_reply(symbol)
-    if df.empty:
-        update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.ParseMode.MARKDOWN,
-        )
-        return
-
-    context.bot.send_chat_action(
-        chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO
-    )
-
-    buf = io.BytesIO()
-    mpf.plot(
-        df,
-        type="renko",
-        title=f"\n${symbol.upper()}",
-        volume=True,
-        style="yahoo",
-        mav=20,
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-    )
-    buf.seek(0)
-
-    update.message.reply_photo(
-        photo=buf,
-        caption=f"\nIntraday chart for ${symbol.upper()} from {df.first_valid_index().strftime('%I:%M')} to"
-        + f" {df.last_valid_index().strftime('%I:%M')} ET on"
-        + f" {datetime.date.today().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[symbol]}",
-        parse_mode=telegram.ParseMode.MARKDOWN,
-    )
-
-
-def chart(update: Update, context: CallbackContext):
-    # TODO: Document usage of this command. https://iexcloud.io/docs/api/#historical-prices
-
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/chart":
-        update.message.reply_text(
-            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
-        )
-        return
-
-    symbol = s.find_symbols(message)[0]
-
-    df = s.chart_reply(symbol)
-    if df.empty:
-        update.message.reply_text(
-            text="Invalid symbol please see `/help` for usage details.",
-            parse_mode=telegram.ParseMode.MARKDOWN,
-        )
-        return
-
-    context.bot.send_chat_action(
-        chat_id=chat_id, action=telegram.ChatAction.UPLOAD_PHOTO
-    )
-
-    buf = io.BytesIO()
-    mpf.plot(
-        df,
-        type="candle",
-        title=f"\n${symbol.upper()}",
-        volume=True,
-        style="yahoo",
-        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
-    )
-    buf.seek(0)
-
-    update.message.reply_photo(
-        photo=buf,
-        caption=f"\n1 Month chart for ${symbol.upper()} from {df.first_valid_index().strftime('%d, %b %Y')}"
-        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[symbol]}",
-        parse_mode=telegram.ParseMode.MARKDOWN,
-    )
-
-
-def stat(update: Update, context: CallbackContext):
-    """
-    https://iexcloud.io/docs/api/#key-stats
-    """
-    message = update.message.text
-    chat_id = update.message.chat_id
-
-    if message.strip() == "/stat":
-        update.message.reply_text(
-            "This command returns key statistics for a symbol.\nExample: /stat $tsla"
-        )
-        return
-
-    symbols = s.find_symbols(message)
-
-    if symbols:
-        context.bot.send_chat_action(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-
-        for reply in s.stat_reply(symbols).items():
-            update.message.reply_text(
-                text=reply[1], parse_mode=telegram.ParseMode.MARKDOWN
-            )
-
-
-def crypto(update: Update, context: CallbackContext):
-    """
-    https://iexcloud.io/docs/api/#cryptocurrency-quote
-    """
-    context.bot.send_chat_action(
-        chat_id=update.message.chat_id, action=telegram.ChatAction.TYPING
-    )
-    message = update.message.text
-
-    if message.strip() == "/crypto":
-        update.message.reply_text(
-            "This command returns the current price in USD for a cryptocurrency.\nExample: /crypto eth"
-        )
-        return
-
-    reply = s.crypto_reply(message)
-
-    if reply:
-        update.message.reply_text(text=reply, parse_mode=telegram.ParseMode.MARKDOWN)
-    else:
-        update.message.reply_text(
-            text=f"Pair: {message} returned an error.",
-            parse_mode=telegram.ParseMode.MARKDOWN,
-        )
-
-
-def inline_query(update: Update, context: CallbackContext):
-    """
-    Handles inline query.
-    Does a fuzzy search on input and returns stocks that are close.
-    """
-
-    matches = s.search_symbols(update.inline_query.query)
-
-    results = []
-    for match in matches:
-        try:
-            price = s.price_reply([match[0]])[match[0]]
-            results.append(
-                InlineQueryResultArticle(
-                    match[0],
-                    title=match[1],
-                    input_message_content=InputTextMessageContent(
-                        price, parse_mode=telegram.ParseMode.MARKDOWN
-                    ),
-                )
-            )
-        except TypeError:
-            logging.warning(str(match))
-            pass
-
-        if len(results) == 5:
-            update.inline_query.answer(results)
-            return
-
-
-def rand_pick(update: Update, context: CallbackContext):
-
-    choice = random.choice(list(s.symbol_list["description"]))
-    hold = (
-        datetime.date.today() + datetime.timedelta(random.randint(1, 365))
-    ).strftime("%b %d, %Y")
-
-    update.message.reply_text(
-        text=f"{choice}\nBuy and hold until: {hold}",
-        parse_mode=telegram.ParseMode.MARKDOWN,
-    )
-
-
-def error(update: Update, context: CallbackContext):
-    """Log Errors caused by Updates."""
-    logger.warning('Update "%s" caused error "%s"', update, error)
-
-    tb_list = traceback.format_exception(
-        None, context.error, context.error.__traceback__
-    )
-    tb_string = "".join(tb_list)
-
-    message = (
-        f"An exception was raised while handling an update\n"
-        f"<pre>update = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}"
-        "</pre>\n\n"
-        f"<pre>context.chat_data = {html.escape(str(context.chat_data))}</pre>\n\n"
-        f"<pre>context.user_data = {html.escape(str(context.user_data))}</pre>\n\n"
-        f"<pre>{html.escape(tb_string)}</pre>"
-    )
-
-    # Finally, send the message
-    update.message.reply_text(text=message, parse_mode=telegram.ParseMode.HTML)
-    update.message.reply_text(text="Please inform the bot admin of this issue.")
-
-
-def main():
-    """Start the context.bot."""
-    # Create the EventHandler and pass it your bot's token.
-    updater = Updater(TELEGRAM_TOKEN)
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
-
-    # on different commands - answer in Telegram
-    dp.add_handler(CommandHandler("start", start))
-    dp.add_handler(CommandHandler("help", help))
-    dp.add_handler(CommandHandler("license", license))
-    dp.add_handler(CommandHandler("dividend", dividend))
-    dp.add_handler(CommandHandler("div", dividend))
-    dp.add_handler(CommandHandler("news", news))
-    dp.add_handler(CommandHandler("info", info))
-    dp.add_handler(CommandHandler("stat", stat))
-    dp.add_handler(CommandHandler("stats", stat))
-    dp.add_handler(CommandHandler("search", search))
-    dp.add_handler(CommandHandler("intraday", intra))
-    dp.add_handler(CommandHandler("intra", intra, run_async=True))
-    dp.add_handler(CommandHandler("chart", chart))
-    dp.add_handler(CommandHandler("crypto", crypto))
-    dp.add_handler(CommandHandler("random", rand_pick))
-    dp.add_handler(CommandHandler("donate", donate))
-    dp.add_handler(CommandHandler("status", status))
-
-    # on noncommand i.e message - echo the message on Telegram
-    dp.add_handler(MessageHandler(Filters.text, symbol_detect))
-
-    # Inline Bot commands
-    dp.add_handler(InlineQueryHandler(inline_query))
-
-    # Pre-checkout handler to final check
-    dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
-
-    # Payment success
-    dp.add_handler(
-        MessageHandler(Filters.successful_payment, successful_payment_callback)
-    )
-
-    # log all errors
-    dp.add_error_handler(error)
-
-    # Start the Bot
-    updater.start_polling()
-
-    # Run the bot until you press Ctrl-C or the process receives SIGINT,
-    # SIGTERM or SIGABRT. This should be used most of the time, since
-    # start_polling() is non-blocking and will stop the bot gracefully.
-    updater.idle()
-
-
-if __name__ == "__main__":
-    main()

commands

@@ -1,8 +0,0 @@
-donate - Donate to the bot 🎗️
-help - Get some help using the bot. 🆘
-info - $[symbol] General information about the symbol. ℹ️
-news - $[symbol] News about the symbol. 📰
-stat - $[symbol] Key statistics about the symbol. 🔢
-dividend - $[symbol] Dividend info 📅
-intra - $[symbol] Plot since the last market open.  📈
-chart - $[chart] Plot of the past month. 📊

common/MarketData.py

@@ -0,0 +1,345 @@
+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
+import schedule
+
+from common.Symbol import Stock
+
+log = logging.getLogger(__name__)
+
+
+class MarketData:
+    """
+    Functions for finding stock market information about symbols from MarkData.app
+    """
+
+    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)
+    marketTimeZone = pytz.timezone("US/Eastern")
+
+    def __init__(self) -> None:
+        """Creates a Symbol Object
+
+        Parameters
+        ----------
+        MARKETDATA_TOKEN : str
+            MarketData.app API Token
+        """
+
+        try:
+            self.MARKETDATA_TOKEN = os.environ["MARKETDATA"]
+
+            if self.MARKETDATA_TOKEN == "TOKEN":
+                self.MARKETDATA_TOKEN = ""
+        except KeyError:
+            self.MARKETDATA_TOKEN = ""
+            log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
+            log.warning("Use this affiliate link so that the bot can stay free:")
+            log.warning("https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo")
+
+        if self.MARKETDATA_TOKEN != "":
+            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
+
+        # set token param if it wasn't passed.
+        params["token"] = self.MARKETDATA_TOKEN
+
+        # Undocumented query variable that ensures bot usage can be
+        # monitored even if someone doesn't make it through an affiliate link.
+        params["application"] = "simplestockbot"
+
+        resp = r.get(url, params=params, timeout=timeout)
+
+        # Make sure API returned a proper status code
+        try:
+            resp.raise_for_status()
+        except r.exceptions.HTTPError as e:
+            logging.error(e)
+            return {}
+
+        # Make sure API returned valid JSON
+        try:
+            resp_json = resp.json()
+
+            match resp_json["s"]:
+                case "ok":
+                    return resp_json
+                case "no_data":
+                    return resp_json
+                case "error":
+                    logging.error("MarketData Error:\n" + resp_json["errmsg"])
+                    return {}
+
+        except r.exceptions.JSONDecodeError as e:
+            logging.error(e)
+
+        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.
+        Charts are cached so that only 1 API call per 24 hours is needed since the
+            chart data is expensive and a large download.
+        """
+        self.charts = {}
+
+    def status(self) -> str:
+        # TODO: At the moment this API is poorly documented, this function likely needs to be revisited later.
+
+        try:
+            status = r.get(
+                "https://stats.uptimerobot.com/api/getMonitorList/6Kv3zIow0A",
+                timeout=5,
+            )
+            status.raise_for_status()
+        except r.HTTPError:
+            return f"API returned an HTTP error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
+        except r.Timeout:
+            return "API timed out before it was able to give status. This is likely due to a surge in usage or a complete outage."
+
+        statusJSON = status.json()
+
+        if statusJSON["status"] == "ok":
+            return (
+                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
+            )
+        else:
+            return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
+
+    def price_reply(self, symbol: Stock) -> str:
+        """Returns price movement of Stock for the last market day, or after hours.
+
+        Parameters
+        ----------
+        symbol : Stock
+
+        Returns
+        -------
+        str
+            Formatted markdown
+        """
+
+        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.name} is ${price}"
+
+            message = f"The current price of {symbol.name} is ${price} and "
+
+            if changePercent > 0.0:
+                message += f"is currently up {changePercent}% for the day."
+            elif changePercent < 0.0:
+                message += f"is currently down {changePercent}% for the day."
+            else:
+                message += "hasn't shown any movement for the day."
+
+            return message
+        else:
+            return f"Getting a quote for {symbol} encountered an error."
+
+    def spark_reply(self, symbol: Stock) -> str:
+        if quoteResp := self.get(f"stocks/quotes/{symbol}/"):
+            try:
+                changePercent = round(quoteResp["changepct"][0], 2)
+                return f"`{symbol.tag}`: {changePercent}%"
+            except TypeError:
+                pass
+
+        return f"`{symbol.tag}`"
+
+    def intra_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+        schedule.run_pending()
+
+        try:
+            return self.charts[symbol.id.upper()]
+        except KeyError:
+            pass
+
+        resolution = "15"  # minutes
+        now = dt.datetime.now(self.marketTimeZone)
+
+        if self.openTime < now.time():
+            startTime = now.replace(hour=9, minute=30)
+        else:
+            startTime = now - dt.timedelta(days=1)
+
+        if data := self.get(
+            f"stocks/candles/{resolution}/{symbol}",
+            params={"from": startTime.timestamp(), "to": now.timestamp(), "extended": True},
+        ):
+            data.pop("s")
+            df = pd.DataFrame(data)
+            df["t"] = pd.to_datetime(df["t"], unit="s", utc=True)
+            df.set_index("t", inplace=True)
+
+            df.rename(
+                columns={
+                    "o": "Open",
+                    "h": "High",
+                    "l": "Low",
+                    "c": "Close",
+                    "v": "Volume",
+                },
+                inplace=True,
+            )
+
+            self.charts[symbol.id.upper()] = df
+            return df
+
+        return pd.DataFrame()
+
+    def chart_reply(self, symbol: Stock) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+        schedule.run_pending()
+
+        try:
+            return self.charts[symbol.id.upper()]
+        except KeyError:
+            pass
+
+        to_date = dt.datetime.today().strftime("%Y-%m-%d")
+        from_date = (dt.datetime.today() - dt.timedelta(days=30)).strftime("%Y-%m-%d")
+        resultion = "daily"
+
+        if data := self.get(
+            f"stocks/candles/{resultion}/{symbol}",
+            params={
+                "from": from_date,
+                "to": to_date,
+            },
+        ):
+            data.pop("s")
+
+            df = pd.DataFrame(data)
+            df["t"] = pd.to_datetime(df["t"], unit="s")
+            df.set_index("t", inplace=True)
+
+            df.rename(
+                columns={
+                    "o": "Open",
+                    "h": "High",
+                    "l": "Low",
+                    "c": "Close",
+                    "v": "Volume",
+                },
+                inplace=True,
+            )
+
+            self.charts[symbol.id.upper()] = df
+            return df
+
+        return pd.DataFrame()
+
+    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

@@ -0,0 +1,52 @@
+import logging
+
+import pandas as pd
+
+
+class Symbol:
+    """
+    symbol: What the user calls it. ie tsla or btc
+    id: What the api expects. ie tsla or bitcoin
+    name: Human readable. ie Tesla or Bitcoin
+    tag: Uppercase tag to call the symbol. ie $TSLA or $$BTC
+    """
+
+    currency = "usd"
+    pass
+
+    def __init__(self, symbol) -> None:
+        self.symbol = symbol
+        self.id = symbol
+        self.name = symbol
+        self.tag = "$" + symbol
+
+    def __repr__(self) -> str:
+        return f"<{self.__class__.__name__} instance of {self.id} at {id(self)}>"
+
+    def __str__(self) -> str:
+        return self.id
+
+
+class Stock(Symbol):
+    """Stock Market Object. Gets data from MarketData"""
+
+    def __init__(self, symbol_info: dict) -> None:
+        self.symbol = symbol_info["ticker"]
+        self.id = symbol_info["ticker"]
+        self.name = symbol_info["title"]
+        self.tag = "$" + symbol_info["ticker"]
+        self.market_cap_rank = symbol_info["mkt_cap_rank"]
+
+
+class Coin(Symbol):
+    """Cryptocurrency Object. Gets data from CoinGecko."""
+
+    def __init__(self, symbol: pd.DataFrame) -> None:
+        if len(symbol) > 1:
+            logging.info(f"Crypto with shared id:\n\t{symbol.id}")
+            symbol = symbol.head(1)
+
+        self.symbol = symbol.symbol.values[0]
+        self.id = symbol.id.values[0]
+        self.name = symbol.name.values[0]
+        self.tag = symbol.type_id.values[0].upper()

common/cg_Crypto.py

@@ -0,0 +1,367 @@
+import logging
+from typing import List
+
+import pandas as pd
+import requests as r
+import schedule
+from markdownify import markdownify
+
+from common.Symbol import Coin
+
+log = logging.getLogger(__name__)
+
+
+class cg_Crypto:
+    """
+    Functions for finding crypto info
+    """
+
+    vs_currency = "usd"  # simple/supported_vs_currencies for list of options
+
+    trending_cache: List[str] = []
+
+    def __init__(self) -> None:
+        self.get_symbol_list()
+        schedule.every().day.do(self.get_symbol_list)
+
+    def get(self, endpoint, params: dict = {}, timeout=10) -> dict:
+        url = "https://api.coingecko.com/api/v3" + endpoint
+        resp = r.get(url, params=params, timeout=timeout)
+        # Make sure API returned a proper status code
+        try:
+            resp.raise_for_status()
+        except r.exceptions.HTTPError as e:
+            log.error(e)
+            return {}
+
+        # Make sure API returned valid JSON
+        try:
+            resp_json = resp.json()
+            return resp_json
+        except r.exceptions.JSONDecodeError as e:
+            log.error(e)
+            return {}
+
+    def symbol_id(self, symbol) -> str:
+        try:
+            return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[0]
+        except KeyError:
+            return ""
+
+    def get_symbol_list(self):
+        raw_symbols = self.get("/coins/list")
+        symbols = pd.DataFrame(data=raw_symbols)
+
+        # Removes all binance-peg symbols
+        symbols = symbols[~symbols["id"].str.contains("binance-peg")]
+
+        symbols["description"] = "$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
+        symbols = symbols[["id", "symbol", "name", "description"]]
+        symbols["type_id"] = "$$" + symbols["symbol"]
+
+        self.symbol_list = symbols
+
+    def status(self) -> str:
+        """Checks CoinGecko /ping endpoint for API issues.
+
+        Returns
+        -------
+        str
+            Human readable text on status of CoinGecko API
+        """
+        status = r.get(
+            "https://api.coingecko.com/api/v3/ping",
+            timeout=5,
+        )
+
+        try:
+            status.raise_for_status()
+            return (
+                f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
+            )
+        except r.HTTPError:
+            return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
+
+    def price_reply(self, coin: Coin) -> str:
+        """Returns current market price or after hours if its available for a given coin symbol.
+
+        Parameters
+        ----------
+        symbols : list
+            List of coin symbols.
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable
+            markdown formatted string of the symbols price and movement.
+        """
+
+        if resp := self.get(
+            "/simple/price",
+            params={
+                "ids": coin.id,
+                "vs_currencies": self.vs_currency,
+                "include_24hr_change": "true",
+            },
+        ):
+            try:
+                data = resp[coin.id]
+
+                price = data[self.vs_currency]
+                change = data[self.vs_currency + "_24h_change"]
+                if change is None:
+                    change = 0
+            except KeyError:
+                return f"{coin.id} returned an error."
+
+            message = f"The current price of {coin.name} is $**{price:,}**"
+
+            # Determine wording of change text
+            if change > 0:
+                message += f", the coin is currently **up {change:.3f}%** for today"
+            elif change < 0:
+                message += f", the coin is currently **down {change:.3f}%** for today"
+            else:
+                message += ", the coin hasn't shown any movement today."
+
+        else:
+            message = f"The price for {coin.name} is not available. If you suspect this is an error run `/status`"
+
+        return message
+
+    def intra_reply(self, symbol: Coin) -> pd.DataFrame:
+        """Returns price data for a symbol since the last market open.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+
+        if resp := self.get(
+            f"/coins/{symbol.id}/ohlc",
+            params={"vs_currency": self.vs_currency, "days": 1},
+        ):
+            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
+            df["Date"] = pd.to_datetime(df["Date"], unit="ms")
+            df = df.set_index("Date")
+            return df
+
+        return pd.DataFrame()
+
+    def chart_reply(self, symbol: Coin) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
+        """
+
+        if resp := self.get(
+            f"/coins/{symbol.id}/ohlc",
+            params={"vs_currency": self.vs_currency, "days": 30},
+        ):
+            df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
+            df["Date"] = pd.to_datetime(df["Date"], unit="ms")
+            df = df.set_index("Date")
+            return df
+
+        return pd.DataFrame()
+
+    def stat_reply(self, symbol: Coin) -> str:
+        """Gathers key statistics on coin. Mostly just CoinGecko scores.
+
+        Parameters
+        ----------
+        symbol : Coin
+
+        Returns
+        -------
+        str
+            Preformatted markdown.
+        """
+
+        if data := self.get(
+            f"/coins/{symbol.id}",
+            params={
+                "localization": "false",
+            },
+        ):
+            return f"""
+                [{data['name']}]({data['links']['homepage'][0]}) Statistics:
+                Market Cap: ${data['market_data']['market_cap'][self.vs_currency]:,}
+                Market Cap Ranking: {data.get('market_cap_rank',"Not Available")}
+                CoinGecko Scores:
+                    Overall: {data.get('coingecko_score','Not Available')}
+                    Development: {data.get('developer_score','Not Available')}
+                    Community: {data.get('community_score','Not Available')}
+                    Public Interest: {data.get('public_interest_score','Not Available')}
+                    """
+        else:
+            return f"{symbol.symbol} returned an error."
+
+    def cap_reply(self, coin: Coin) -> str:
+        """Gets market cap for Coin
+
+        Parameters
+        ----------
+        coin : Coin
+
+        Returns
+        -------
+        str
+            Preformatted markdown.
+        """
+
+        if resp := self.get(
+            "/simple/price",
+            params={
+                "ids": coin.id,
+                "vs_currencies": self.vs_currency,
+                "include_market_cap": "true",
+            },
+        ):
+            log.debug(resp)
+            try:
+                data = resp[coin.id]
+
+                price = data[self.vs_currency]
+                cap = data[self.vs_currency + "_market_cap"]
+            except KeyError:
+                return f"{coin.id} returned an error."
+
+            if cap == 0:
+                return f"The market cap for {coin.name} is not available for unknown reasons."
+
+            message = (
+                f"The current price of {coin.name} is $**{price:,}** and"
+                + " its market cap is $**{cap:,.2f}** {self.vs_currency.upper()}"
+            )
+
+        else:
+            message = f"The Coin: {coin.name} was not found or returned and error."
+
+        return message
+
+    def info_reply(self, symbol: Coin) -> str:
+        """Gets coin description
+
+        Parameters
+        ----------
+        symbol : Coin
+
+        Returns
+        -------
+        str
+            Preformatted markdown.
+        """
+
+        if data := self.get(
+            f"/coins/{symbol.id}",
+            params={"localization": "false"},
+        ):
+            try:
+                return markdownify(data["description"]["en"])
+            except KeyError:
+                return f"{symbol} does not have a description available."
+
+        return f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
+
+    def spark_reply(self, symbol: Coin) -> str:
+        change = self.get(
+            "/simple/price",
+            params={
+                "ids": symbol.id,
+                "vs_currencies": self.vs_currency,
+                "include_24hr_change": "true",
+            },
+        )[symbol.id]["usd_24h_change"]
+
+        return f"`{symbol.tag}`: {symbol.name}, {change:.2f}%"
+
+    def trending(self) -> list[str]:
+        """Gets current coins trending on coingecko
+
+        Returns
+        -------
+        list[str]
+            list of $$ID: NAME, CHANGE%
+        """
+
+        coins = self.get("/search/trending")
+        try:
+            trending = []
+            for coin in coins["coins"]:
+                c = coin["item"]
+
+                sym = c["symbol"].upper()
+                name = c["name"]
+                change = self.get(
+                    "/simple/price",
+                    params={
+                        "ids": c["id"],
+                        "vs_currencies": self.vs_currency,
+                        "include_24hr_change": "true",
+                    },
+                )[c["id"]]["usd_24h_change"]
+
+                msg = f"`$${sym}`: {name}, {change:.2f}%"
+
+                trending.append(msg)
+
+        except Exception as e:
+            log.warning(e)
+            return self.trending_cache
+
+        self.trending_cache = trending
+        return trending
+
+    def batch_price(self, coins: list[Coin]) -> list[str]:
+        """Gets price of a list of coins all in one API call
+
+        Parameters
+        ----------
+        coins : list[Coin]
+
+        Returns
+        -------
+        list[str]
+            returns preformatted list of strings detailing price movement of each coin passed in.
+        """
+        query = ",".join([c.id for c in coins])
+
+        prices = self.get(
+            "/simple/price",
+            params={
+                "ids": query,
+                "vs_currencies": self.vs_currency,
+                "include_24hr_change": "true",
+            },
+        )
+
+        replies = []
+        for coin in coins:
+            if coin.id in prices:
+                p = prices[coin.id]
+
+                if p.get("usd_24h_change") is None:
+                    p["usd_24h_change"] = 0
+
+                replies.append(
+                    f"{coin.name}: ${p.get('usd',0):,} and has moved {p.get('usd_24h_change',0.0):.2f}% in the past 24 hours."
+                )
+
+        return replies

common/requirements.txt

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,407 @@
+"""Function that routes symbols to the correct API provider.
+"""
+
+import datetime
+import logging
+import random
+import re
+from typing import Dict
+
+import pandas as pd
+import schedule
+from cachetools import TTLCache, cached
+
+from common.cg_Crypto import cg_Crypto
+from common.MarketData import MarketData
+from common.Symbol import Coin, Stock, Symbol
+
+log = logging.getLogger(__name__)
+
+
+class Router:
+    STOCK_REGEX = "(?:^|[^\\$])\\$([a-zA-Z.]{1,6})"
+    CRYPTO_REGEX = "[$]{2}([a-zA-Z]{1,20})"
+    trending_count: Dict[str, float] = {}
+
+    def __init__(self):
+        self.stock = MarketData()
+        self.crypto = cg_Crypto()
+
+        schedule.every().hour.do(self.trending_decay)
+
+    def trending_decay(self, decay=0.5):
+        """Decays the value of each trending stock by a multiplier"""
+        t_copy = {}
+        dead_keys = []
+        if self.trending_count:
+            t_copy = self.trending_count.copy()
+            for key in t_copy.keys():
+                if t_copy[key] < 0.01:
+                    # Prune Keys
+                    dead_keys.append(key)
+                else:
+                    t_copy[key] = t_copy[key] * decay
+        for dead in dead_keys:
+            t_copy.pop(dead)
+
+        self.trending_count = t_copy.copy()
+        log.info("Decayed trending symbols.")
+
+    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.
+
+        Parameters
+        ----------
+        text : str
+            Blob of text.
+
+        Returns
+        -------
+        list[Symbol]
+            List of stock symbols as Symbol objects
+        """
+        schedule.run_pending()
+
+        symbols: list[Symbol] = []
+        stock_matches = set(re.findall(self.STOCK_REGEX, text))
+        coin_matches = set(re.findall(self.CRYPTO_REGEX, text))
+
+        for stock_match in stock_matches:
+            # Market data lacks tools to check if a symbol is valid.
+            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_match} is not in list of coins")
+            else:
+                symbols.append(Coin(sym))
+        if symbols:
+            for symbol in symbols:
+                self.trending_count[symbol.tag] = self.trending_count.get(symbol.tag, 0) + trending_weight
+                log.debug(self.trending_count)
+
+        return symbols
+
+    def status(self, bot_resp) -> str:
+        """Checks for any issues with APIs.
+
+        Returns
+        -------
+        str
+            Human readable text on status of the bot and relevant APIs
+        """
+
+        stats = f"""
+        Bot Status:
+        {bot_resp}
+
+        Stock Market Data:
+        {self.stock.status()}
+
+        Cryptocurrency Data:
+        {self.crypto.status()}
+        """
+
+        log.warning(stats)
+
+        return stats
+
+    def inline_search(self, search: str, matches: int = 5) -> pd.DataFrame:
+        """Searches based on the shortest symbol that contains the same string as the search.
+        Should be very fast compared to a fuzzy search.
+
+        Parameters
+        ----------
+        search : str
+            String used to match against symbols.
+
+        Returns
+        -------
+        list[tuple[str, str]]
+            Each tuple contains: (Symbol, Issue Name).
+        """
+
+        # df = pd.concat([self.stock.symbol_list, self.crypto.symbol_list])
+        df = self.crypto.symbol_list
+
+        df = df[df["description"].str.contains(search, regex=False, case=False)].sort_values(
+            by="type_id", key=lambda x: x.str.len()
+        )
+
+        symbols = df.head(matches)
+        symbols["price_reply"] = symbols["type_id"].apply(
+            lambda sym: self.price_reply(self.find_symbols(sym, trending_weight=0))[0]
+        )
+
+        return symbols
+
+    def price_reply(self, symbols: list[Symbol]) -> list[str]:
+        """Returns current market price or after hours if its available for a given stock symbol.
+
+        Parameters
+        ----------
+        symbols : list
+            List of stock symbols.
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable
+            markdown formatted string of the symbols price and movement.
+        """
+        replies = []
+
+        for symbol in symbols:
+            log.info(symbol)
+            if isinstance(symbol, Stock):
+                replies.append(self.stock.price_reply(symbol))
+            elif isinstance(symbol, Coin):
+                replies.append(self.crypto.price_reply(symbol))
+            else:
+                log.info(f"{symbol} is not a Stock or Coin")
+
+        return replies
+
+    def info_reply(self, symbols: list) -> list[str]:
+        """Gets information on stock symbols.
+
+        Parameters
+        ----------
+        symbols : list[str]
+            List of stock symbols.
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable formatted
+                string of the symbols information.
+        """
+        replies = []
+
+        for symbol in symbols:
+            if isinstance(symbol, Stock):
+                replies.append(self.stock.info_reply(symbol))
+            elif isinstance(symbol, Coin):
+                replies.append(self.crypto.info_reply(symbol))
+            else:
+                log.debug(f"{symbol} is not a Stock or Coin")
+
+        return replies
+
+    def intra_reply(self, symbol: Symbol) -> pd.DataFrame:
+        """Returns price data for a symbol since the last market open.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available.
+                Otherwise returns empty pd.DataFrame.
+        """
+
+        if isinstance(symbol, Stock):
+            return self.stock.intra_reply(symbol)
+        elif isinstance(symbol, Coin):
+            return self.crypto.intra_reply(symbol)
+        else:
+            log.debug(f"{symbol} is not a Stock or Coin")
+            return pd.DataFrame()
+
+    def chart_reply(self, symbol: Symbol) -> pd.DataFrame:
+        """Returns price data for a symbol of the past month up until the previous trading days close.
+        Also caches multiple requests made in the same day.
+
+        Parameters
+        ----------
+        symbol : str
+            Stock symbol.
+
+        Returns
+        -------
+        pd.DataFrame
+            Returns a timeseries dataframe with high, low, and volume data if its available.
+                Otherwise returns empty pd.DataFrame.
+        """
+        if isinstance(symbol, Stock):
+            return self.stock.chart_reply(symbol)
+        elif isinstance(symbol, Coin):
+            return self.crypto.chart_reply(symbol)
+        else:
+            log.debug(f"{symbol} is not a Stock or Coin")
+            return pd.DataFrame()
+
+    def stat_reply(self, symbols: list[Symbol]) -> list[str]:
+        """Gets key statistics for each symbol in the list
+
+        Parameters
+        ----------
+        symbols : list[str]
+            List of stock symbols
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable
+                formatted string of the symbols statistics.
+        """
+        replies = []
+
+        for symbol in symbols:
+            if isinstance(symbol, Stock):
+                replies.append(self.stock.stat_reply(symbol))
+            elif isinstance(symbol, Coin):
+                replies.append(self.crypto.stat_reply(symbol))
+            else:
+                log.debug(f"{symbol} is not a Stock or Coin")
+
+        return replies
+
+    def cap_reply(self, symbols: list[Symbol]) -> list[str]:
+        """Gets market cap for each symbol in the list
+
+        Parameters
+        ----------
+        symbols : list[str]
+            List of stock symbols
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable
+                formatted string of the symbols market cap.
+        """
+        replies = []
+
+        for symbol in symbols:
+            if isinstance(symbol, Stock):
+                replies.append(self.stock.cap_reply(symbol))
+            elif isinstance(symbol, Coin):
+                replies.append(self.crypto.cap_reply(symbol))
+            else:
+                log.debug(f"{symbol} is not a Stock or Coin")
+
+        return replies
+
+    def spark_reply(self, symbols: list[Symbol]) -> list[str]:
+        """Gets change for each symbol and returns it in a compact format
+
+        Parameters
+        ----------
+        symbols : list[str]
+            List of stock symbols
+
+        Returns
+        -------
+        list[str]
+            List of human readable strings.
+        """
+        replies = []
+
+        for symbol in symbols:
+            if isinstance(symbol, Stock):
+                replies.append(self.stock.spark_reply(symbol))
+            elif isinstance(symbol, Coin):
+                replies.append(self.crypto.spark_reply(symbol))
+            else:
+                log.debug(f"{symbol} is not a Stock or Coin")
+
+        return replies
+
+    @cached(cache=TTLCache(maxsize=1024, ttl=600))
+    def trending(self) -> str:
+        """Checks APIs for trending symbols.
+
+        Returns
+        -------
+        list[str]
+            List of preformatted strings to be sent to user.
+        """
+
+        # stocks = self.stock.trending()
+        coins = self.crypto.trending()
+
+        reply = ""
+
+        log.warning(self.trending_count)
+        if self.trending_count:
+            reply += "🔥Trending on the Stock Bot:\n`"
+            reply += "━" * len("Trending on the Stock Bot:") + "`\n"
+
+            sorted_trending = [s[0] for s in sorted(self.trending_count.items(), key=lambda item: item[1])][::-1][0:5]
+            log.warning(sorted_trending)
+            for t in sorted_trending:
+                reply += self.spark_reply(self.find_symbols(t))[0] + "\n"
+
+        if coins:
+            reply += "\n\n🦎Trending on CoinGecko:\n`"
+            reply += "━" * len("Trending on CoinGecko:") + "`\n"
+            for coin in coins:
+                reply += coin + "\n"
+
+        if "`$GME" in reply:
+            reply = reply.replace("🔥", "🦍")
+
+        if reply:
+            return reply
+        else:
+            log.warning("Failed to collect trending data.")
+            return "Trending data is not currently available."
+
+    def random_pick(self) -> str:
+        # choice = random.choice(list(self.stock.symbol_list["description"]) + list(self.crypto.symbol_list["description"]))
+        choice = random.choice(list(self.crypto.symbol_list["description"]))
+        hold = (datetime.date.today() + datetime.timedelta(random.randint(1, 365))).strftime("%b %d, %Y")
+
+        return f"{choice}\nBuy and hold until: {hold}"
+
+    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.
+
+        Parameters
+        ----------
+        symbols : list
+            List of stock symbols.
+
+        Returns
+        -------
+        Dict[str, str]
+            Each symbol passed in is a key with its value being a human readable
+            markdown formatted string of the symbols price and movement.
+        """
+        replies = []
+        stocks = []
+        coins = []
+
+        for symbol in symbols:
+            if isinstance(symbol, Stock):
+                stocks.append(symbol)
+            elif isinstance(symbol, Coin):
+                coins.append(symbol)
+            else:
+                log.debug(f"{symbol} is not a Stock or Coin")
+
+        if stocks:
+            for stock in stocks:
+                replies.append(self.stock.price_reply(stock))
+        if coins:
+            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

@@ -0,0 +1,12 @@
+-r common/requirements.txt
+-r site/requirements.txt
+black==23.9.1
+ipython==8.16.1
+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.1.1
+ruff==0.0.292
+isort==5.12.0

discord/D_info.py

@@ -0,0 +1,59 @@
+"""Functions and Info specific to the discord Bot
+"""
+
+import re
+
+import requests as r
+
+
+class D_info:
+    license = re.sub(
+        r"\b\n",
+        " ",
+        r.get("https://gitlab.com/simple-stock-bots/simple-discord-stock-bot/-/raw/master/LICENSE").text,
+    )
+
+    help_text = """
+Thanks for using this bot. If you like it, [support me with a beer](https://www.buymeacoffee.com/Anson). 🍻
+
+For stock data or hosting your own bot, use my link. This helps keep the bot free:
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
+
+**Updates**: Join the bot's discord: https://t.me/simplestockbotnews.
+
+**Documentation**: All details about the bot are at [docs](https://simplestockbot.com).
+
+The bot reads _"Symbols"_. Use `$` for stock tickers and `$$` for cryptocurrencies. For example:
+- `/chart $$eth` gives Ethereum's monthly chart.
+- `/dividend $psec` shows Prospect Capital's dividend.
+
+Type any symbol, and the bot shows its price. Like: `Is $$btc rising since $tsla accepts it?` will give Bitcoin and Tesla prices.
+
+**Commands**
+- `/donate [USD amount]`: Support the bot. 🎗️
+- `/intra $[symbol]`: See stock's latest movement. 📈
+- `/chart $[symbol]`: View a month's stock activity. 📊
+- `/trending`: Check trending stocks and cryptos. 💬
+- `/help`: Need help? Ask here. 🆘
+
+**Inline Features**
+Type @SimpleStockBot `[search]` anywhere to find and get stock/crypto prices. Note: Prices might be delayed up to an hour.
+
+Data from: [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord).
+
+Issues with the bot? Use `/status` or [contact us](https://simplestockbot.com/contact).
+    """
+
+    donate_text = """
+Simple Stock Bot runs purely on [donations.](https://www.buymeacoffee.com/Anson)
+Every donation supports server costs and
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=discord) provides our data.
+
+**How to Donate?**
+1. Use `/donate [amount in USD]` command.
+   - E.g., `/donate 2` donates 2 USD.
+2. Or, donate at [buymeacoffee](https://www.buymeacoffee.com/Anson).
+    - It's quick, doesn't need an account, and accepts Paypal or Credit card.
+
+Questions? Visit our [website](https://simplestockbot.com).
+"""

discord/Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.11-buster AS builder
+
+
+COPY discord/discord-reqs.txt .
+COPY common/requirements.txt .
+
+RUN pip install --user -r discord-reqs.txt
+
+
+FROM python:3.11-slim
+
+ENV MPLBACKEND=Agg
+
+COPY --from=builder /root/.local /root/.local
+
+COPY common common
+COPY discord .
+
+CMD [ "python", "./bot.py" ]

discord/bot.py

@@ -0,0 +1,256 @@
+import datetime
+import io
+import logging
+import os
+
+import mplfinance as mpf
+import nextcord
+from D_info import D_info
+from nextcord.ext import commands
+
+from common.symbol_router import Router
+
+DISCORD_TOKEN = os.environ["DISCORD"]
+
+s = Router()
+d = D_info()
+
+
+intents = nextcord.Intents.default()
+
+
+client = nextcord.Client(intents=intents)
+bot = commands.Bot(command_prefix="/", description=d.help_text, intents=intents)
+
+logger = logging.getLogger("nextcord")
+logger.setLevel(logging.INFO)
+handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
+handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
+logger.addHandler(handler)
+
+
+@bot.event
+async def on_ready():
+    logging.info("Starting Simple Stock Bot")
+    logging.info(f"Logged in as {bot.user.name} {bot.user.id}")
+
+
+@bot.command()
+async def status(ctx: commands):
+    """Debug command for diagnosing if the bot is experiencing any issues."""
+    logging.info(f"Status command ran by {ctx.message.author}")
+    message = ""
+    try:
+        message = "Contact MisterBiggs#0465 if you need help.\n"
+        message += s.status(f"Bot recieved your message in: {bot.latency*10:.4f} seconds") + "\n"
+
+    except Exception as ex:
+        logging.critical(ex)
+        message += (
+            f"*\n\nERROR ENCOUNTERED:*\n{ex}\n\n"
+            + "*The bot encountered an error while attempting to find errors. Please contact the bot admin.*"
+        )
+    await ctx.send(message)
+
+
+@bot.command()
+async def license(ctx: commands):
+    """Returns the bots license agreement."""
+    await ctx.send(d.license)
+
+
+@bot.command()
+async def donate(ctx: commands):
+    """Details on how to support the development and hosting of the bot."""
+    await ctx.send(d.donate_text)
+
+
+@bot.command()
+async def search(ctx: commands, *, query: str):
+    """Search for a stock symbol using either symbol of company name."""
+    results = s.search_symbols(query)
+    if results:
+        reply = "*Search Results:*\n`$ticker: Company Name`\n"
+        for query in results:
+            reply += "`" + query[1] + "`\n"
+        await ctx.send(reply)
+
+
+@bot.command()
+async def crypto(ctx: commands, _: str):
+    """Get the price of a cryptocurrency using in USD."""
+    await ctx.send("Crypto now has native support. Any crypto can be called using two dollar signs: `$$eth` `$$btc` `$$doge`")
+
+
+@bot.command()
+async def intra(ctx: commands, sym: str):
+    """Get a chart for the stocks movement since market open."""
+    symbols = s.find_symbols(sym)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await ctx.send("No symbols or coins found.")
+        return
+
+    df = s.intra_reply(symbol)
+    if df.empty:
+        await ctx.send("Invalid symbol please see `/help` for usage details.")
+        return
+    with ctx.channel.typing():
+        buf = io.BytesIO()
+        mpf.plot(
+            df,
+            type="renko",
+            title=f"\n{symbol.name}",
+            volume="volume" in df.keys(),
+            style="yahoo",
+            savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+        )
+
+        buf.seek(0)
+
+        # Get price so theres no request lag after the image is sent
+        price_reply = s.price_reply([symbol])[0]
+        await ctx.send(
+            file=nextcord.File(
+                buf,
+                filename=f"{symbol.name}:intra{datetime.date.today().strftime('%S%M%d%b%Y')}.png",
+            ),
+            content=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+            + f" {df.last_valid_index().strftime('%d %b at %H:%M')}",
+        )
+        await ctx.send(price_reply)
+
+
+@bot.command()
+async def chart(ctx: commands, sym: str):
+    """returns a chart of the past month of data for a symbol"""
+
+    symbols = s.find_symbols(sym)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await ctx.send("No symbols or coins found.")
+        return
+
+    df = s.chart_reply(symbol)
+    if df.empty:
+        await ctx.send("Invalid symbol please see `/help` for usage details.")
+        return
+    with ctx.channel.typing():
+        buf = io.BytesIO()
+        mpf.plot(
+            df,
+            type="candle",
+            title=f"\n{symbol.name}",
+            volume="volume" in df.keys(),
+            style="yahoo",
+            savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+        )
+        buf.seek(0)
+
+        # Get price so theres no request lag after the image is sent
+        price_reply = s.price_reply([symbol])[0]
+        await ctx.send(
+            file=nextcord.File(
+                buf,
+                filename=f"{symbol.name}:1M{datetime.date.today().strftime('%d%b%Y')}.png",
+            ),
+            content=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+            + f" to {df.last_valid_index().strftime('%d, %b %Y')}",
+        )
+        await ctx.send(price_reply)
+
+
+@bot.command()
+async def cap(ctx: commands, sym: str):
+    """Get the market cap of a symbol"""
+    symbols = s.find_symbols(sym)
+    if symbols:
+        with ctx.channel.typing():
+            for reply in s.cap_reply(symbols):
+                await ctx.send(reply)
+
+
+@bot.command()
+async def trending(ctx: commands):
+    """Get a list of Trending Stocks and Coins"""
+    with ctx.channel.typing():
+        await ctx.send(s.trending())
+
+
+@bot.event
+async def on_message(message):
+    # Ignore messages from the bot itself
+    if message.author.id == bot.user.id:
+        return
+
+    content_lower = message.content.lower()
+
+    # Process commands starting with "/"
+    if message.content.startswith("/"):
+        await bot.process_commands(message)
+        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

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

docker-compose.yaml

@@ -0,0 +1,13 @@
+version: '3'
+services:
+  telegram:
+    build:
+      context: .
+      dockerfile: telegram/Dockerfile
+    image: registry.gitlab.com/simple-stock-bots/simple-telegram-stock-bot
+    env_file: .env
+  discord:
+    build:
+      context: .
+      dockerfile: discord/Dockerfile
+    env_file: .env

functions.py

@@ -1,553 +0,0 @@
-import re
-from datetime import datetime
-from typing import Optional, List, Tuple, Dict
-
-import pandas as pd
-import requests as r
-import schedule
-from fuzzywuzzy import fuzz
-
-
-class Symbol:
-    """
-    Functions for finding stock market information about symbols.
-    """
-
-    SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
-
-    searched_symbols = {}
-    charts = {}
-
-    license = re.sub(
-        r"\b\n",
-        " ",
-        r.get(
-            "https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE"
-        ).text,
-    )
-
-    help_text = """
-Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
-
-Keep up with the latest news for the bot in itsTelegram Channel: https://t.me/simplestockbotnews
-
-Full documentation on using and running your own stock bot can be found [here.](https://simple-stock-bots.gitlab.io/site)
-
-**Commands**
-        - /donate [amount in USD] to donate. 🎗️
-        - /dividend $[symbol] will return dividend information for the symbol. 📅
-        - /intra $[symbol] Plot of the stocks movement since the last market open.  📈
-        - /chart $[symbol] Plot of the stocks movement for the past 1 month. 📊
-        - /news $[symbol] News about the symbol. 📰
-        - /info $[symbol] General information about the symbol. ℹ️
-        - /stat $[symbol] Key statistics about the symbol. 🔢
-        - /help Get some help using the bot. 🆘
-
-**Inline Features**
-    You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
-    full list of stock symbols and return the price of the ticker. Then once you select the ticker
-    want the bot will send a message as you in that chat with the latest stock price.
-    The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
-    `$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
-    Market data is provided by [IEX Cloud](https://iexcloud.io)
-
-    If you believe the bot is not behaving properly run `/status`.
-    """
-
-    donate_text = """
-Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
-All donations go directly towards paying for servers, and market data is provided by
-[IEX Cloud](https://iexcloud.io/).
-
-The easiest way to donate is to run the `/donate [amount in USD]` command with USdollars you would like to donate.
-
-Example: `/donate 2` would donate 2 USD.
-An alternative way to donate is through https://www.buymeacoffee.com/Anson,which accepts Paypal or Credit card.
-If you have any questions get in touch: @MisterBiggs or[anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/)
-
-_Donations can only be made in a chat directly with @simplestockbot_
-    """
-
-    def __init__(self, IEX_TOKEN: str) -> None:
-        """Creates a Symbol Object
-
-        Parameters
-        ----------
-        IEX_TOKEN : str
-            IEX Token
-        """
-        self.IEX_TOKEN = IEX_TOKEN
-        if IEX_TOKEN != "":
-            self.get_symbol_list()
-
-            schedule.every().day.do(self.get_symbol_list)
-            schedule.every().day.do(self.clear_charts)
-
-    def clear_charts(self) -> None:
-        """Clears cache of chart data."""
-        self.charts = {}
-
-    def get_symbol_list(self, return_df=False) -> Optional[pd.DataFrame]:
-
-        raw_symbols = r.get(
-            f"https://cloud.iexapis.com/stable/ref-data/symbols?token={self.IEX_TOKEN}"
-        ).json()
-        symbols = pd.DataFrame(data=raw_symbols)
-
-        symbols["description"] = symbols["symbol"] + ": " + symbols["name"]
-        self.symbol_list = symbols
-        if return_df:
-            return symbols, datetime.now()
-
-    def iex_status(self) -> str:
-        """Checks IEX Status dashboard for any current API issues.
-
-        Returns
-        -------
-        str
-            Human readable text on status of IEX API
-        """
-        status = r.get("https://pjmps0c34hp7.statuspage.io/api/v2/status.json").json()[
-            "status"
-        ]
-
-        if status["indicator"] == "none":
-            return "IEX Cloud is currently not reporting any issues with its API."
-        else:
-            return (
-                f"{status['indicator']}: {status['description']}."
-                + " Please check the status page for more information. https://status.iexapis.com"
-            )
-
-    def message_status(self) -> str:
-        """Checks to see if the bot has available IEX Credits
-
-        Returns
-        -------
-        str
-            Human readable text on status of IEX Credits.
-        """
-        usage = r.get(
-            f"https://cloud.iexapis.com/stable/account/metadata?token={self.IEX_TOKEN}"
-        ).json()
-        try:
-            if (
-                usage["messagesUsed"] >= usage["messageLimit"] - 10000
-                and not usage["payAsYouGoEnabled"]
-            ):
-                return "Bot may be out of IEX Credits."
-            else:
-                return "Bot has available IEX Credits."
-        except KeyError:
-            return "**IEX API could not be reached.**"
-
-    def search_symbols(self, search: str) -> List[Tuple[str, str]]:
-        """Performs a fuzzy search to find stock symbols closest to a search term.
-
-        Parameters
-        ----------
-        search : str
-            String used to search, could be a company name or something close to the companies stock ticker.
-
-        Returns
-        -------
-        List[tuple[str, str]]
-            A list tuples of every stock sorted in order of how well they match. Each tuple contains: (Symbol, Issue Name).
-        """
-
-        schedule.run_pending()
-        search = search.lower()
-        try:  # https://stackoverflow.com/a/3845776/8774114
-            return self.searched_symbols[search]
-        except KeyError:
-            pass
-
-        symbols = self.symbol_list
-        symbols["Match"] = symbols.apply(
-            lambda x: fuzz.ratio(search, f"{x['symbol']}".lower()),
-            axis=1,
-        )
-
-        symbols.sort_values(by="Match", ascending=False, inplace=True)
-        if symbols["Match"].head().sum() < 300:
-            symbols["Match"] = symbols.apply(
-                lambda x: fuzz.partial_ratio(search, x["name"].lower()),
-                axis=1,
-            )
-
-            symbols.sort_values(by="Match", ascending=False, inplace=True)
-        symbols = symbols.head(10)
-        symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"])))
-        self.searched_symbols[search] = symbol_list
-        return symbol_list
-
-    def find_symbols(self, text: str) -> List[str]:
-        """Finds stock tickers starting with a dollar sign in a blob of text and returns them in a list.
-        Only returns each match once. Example: Whats the price of $tsla?
-
-        Parameters
-        ----------
-        text : str
-            Blob of text.
-
-        Returns
-        -------
-        List[str]
-            List of stock symbols as strings without dollar sign.
-        """
-
-        return list(set(re.findall(self.SYMBOL_REGEX, text)))
-
-    def price_reply(self, symbols: list) -> Dict[str, str]:
-        """Returns current market price or after hours if its available for a given stock symbol.
-
-        Parameters
-        ----------
-        symbols : list
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable
-            markdown formatted string of the symbols price and movement.
-        """
-        dataMessages = {}
-        for symbol in symbols:
-            IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/quote?token={self.IEX_TOKEN}"
-
-            response = r.get(IEXurl)
-            if response.status_code == 200:
-                IEXData = response.json()
-                keys = (
-                    "isUSMarketOpen",
-                    "extendedChangePercent",
-                    "extendedPrice",
-                    "companyName",
-                    "latestPrice",
-                    "changePercent",
-                )
-                if set(keys).issubset(IEXData):
-
-                    try:  # Some symbols dont return if the market is open
-                        IEXData["isUSMarketOpen"]
-                    except KeyError:
-                        IEXData["isUSMarketOpen"] = True
-
-                    if (
-                        IEXData["isUSMarketOpen"]
-                        or (IEXData["extendedChangePercent"] is None)
-                        or (IEXData["extendedPrice"] is None)
-                    ):  # Check if market is open.
-
-                        message = f"The current stock price of {IEXData['companyName']} is $**{IEXData['latestPrice']}**"
-                        try:
-                            change = round(IEXData["changePercent"] * 100, 2)
-                        except (KeyError, TypeError):
-                            change = 0
-                    else:
-                        message = (
-                            f"{IEXData['companyName']} closed at $**{IEXData['latestPrice']}**,"
-                            + f" after hours _(15 minutes delayed)_ the stock price is $**{IEXData['extendedPrice']}**"
-                        )
-                        change = round(IEXData["extendedChangePercent"] * 100, 2)
-
-                    # Determine wording of change text
-                    if change > 0:
-                        message += f", the stock is currently **up {change}%**"
-                    elif change < 0:
-                        message += f", the stock is currently **down {change}%**"
-                    else:
-                        message += ", the stock hasn't shown any movement today."
-                else:
-                    message = f"The symbol: {symbol} encountered and error. This could be due to the symbol not being fully supported by IEX Cloud."
-
-            else:
-                message = f"The symbol: {symbol} was not found."
-
-            if symbol.upper() == "GME":
-                message += "\n\n🙌💎Power to the Players💎🙌"
-            if IEXData["latestPrice"] is None:
-                message = f"{symbol} has not reported price info to IEX Cloud."
-
-            dataMessages[symbol] = message
-        return dataMessages
-
-    def dividend_reply(self, symbol: str) -> Dict[str, str]:
-        """Returns the most recent, or next dividend date for a stock symbol.
-
-        Parameters
-        ----------
-        symbols : list
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable formatted string of the symbols div dates.
-        """
-
-        IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/dividends/next?token={self.IEX_TOKEN}"
-        response = r.get(IEXurl)
-        if response.status_code == 200 and response.json():
-            IEXData = response.json()[0]
-            keys = (
-                "amount",
-                "currency",
-                "declaredDate",
-                "exDate",
-                "frequency",
-                "paymentDate",
-                "flag",
-            )
-
-            if set(keys).issubset(IEXData):
-
-                if IEXData["currency"] == "USD":
-                    price = f"${IEXData['amount']}"
-                else:
-                    price = f"{IEXData['amount']} {IEXData['currency']}"
-
-                # Pattern IEX uses for dividend date.
-                pattern = "%Y-%m-%d"
-
-                declared = datetime.strptime(IEXData["declaredDate"], pattern).strftime(
-                    "%A, %B %w"
-                )
-                ex = datetime.strptime(IEXData["exDate"], pattern).strftime("%A, %B %w")
-                payment = datetime.strptime(IEXData["paymentDate"], pattern).strftime(
-                    "%A, %B %w"
-                )
-
-                daysDelta = (
-                    datetime.strptime(IEXData["paymentDate"], pattern) - datetime.now()
-                ).days
-
-                return (
-                    f"The next dividend for ${self.symbol_list[self.symbol_list['symbol']==symbol.upper()]['description'].item()}"
-                    + f" is on {payment} which is in {daysDelta} days."
-                    + f" The dividend is for {price} per share."
-                    + f"\nThe dividend was declared on {declared} and the ex-dividend date is {ex}"
-                )
-
-        return f"{symbol} either doesn't exist or pays no dividend."
-
-    def news_reply(self, symbols: list) -> Dict[str, str]:
-        """Gets recent english news on stock symbols.
-
-        Parameters
-        ----------
-        symbols : list
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable markdown formatted string of the symbols news.
-        """
-        newsMessages = {}
-
-        for symbol in symbols:
-            IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/news/last/5?token={self.IEX_TOKEN}"
-            response = r.get(IEXurl)
-            if response.status_code == 200:
-                data = response.json()
-                if len(data):
-                    newsMessages[symbol] = f"News for **{symbol.upper()}**:\n\n"
-                    for news in data:
-                        if news["lang"] == "en" and not news["hasPaywall"]:
-                            message = f"*{news['source']}*: [{news['headline']}]({news['url']})\n"
-                            newsMessages[symbol] = newsMessages[symbol] + message
-                else:
-                    newsMessages[
-                        symbol
-                    ] = f"No news found for: {symbol}\nEither today is boring or the symbol does not exist."
-            else:
-                newsMessages[
-                    symbol
-                ] = f"No news found for: {symbol}\nEither today is boring or the symbol does not exist."
-
-        return newsMessages
-
-    def info_reply(self, symbols: List[str]) -> Dict[str, str]:
-        """Gets information on stock symbols.
-
-        Parameters
-        ----------
-        symbols : List[str]
-            List of stock symbols.
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable formatted string of the symbols information.
-        """
-        infoMessages = {}
-
-        for symbol in symbols:
-            IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/company?token={self.IEX_TOKEN}"
-            response = r.get(IEXurl)
-
-            if response.status_code == 200:
-                data = response.json()
-                infoMessages[symbol] = (
-                    f"Company Name: [{data['companyName']}]({data['website']})\nIndustry:"
-                    + f" {data['industry']}\nSector: {data['sector']}\nCEO: {data['CEO']}\nDescription: {data['description']}\n"
-                )
-
-            else:
-                infoMessages[
-                    symbol
-                ] = f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
-
-        return infoMessages
-
-    def intra_reply(self, symbol: str) -> pd.DataFrame:
-        """Returns price data for a symbol since the last market open.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        if symbol.upper() not in list(self.symbol_list["symbol"]):
-            return pd.DataFrame()
-
-        IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/intraday-prices?token={self.IEX_TOKEN}"
-        response = r.get(IEXurl)
-        if response.status_code == 200:
-            df = pd.DataFrame(response.json())
-            df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
-            df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
-            df = df.set_index("DT")
-            return df
-
-        return pd.DataFrame()
-
-    def chart_reply(self, symbol: str) -> pd.DataFrame:
-        """Returns price data for a symbol of the past month up until the previous trading days close.
-        Also caches multiple requests made in the same day.
-
-        Parameters
-        ----------
-        symbol : str
-            Stock symbol.
-
-        Returns
-        -------
-        pd.DataFrame
-            Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
-        """
-        schedule.run_pending()
-
-        if symbol.upper() not in list(self.symbol_list["symbol"]):
-            return pd.DataFrame()
-
-        try:  # https://stackoverflow.com/a/3845776/8774114
-            return self.charts[symbol.upper()]
-        except KeyError:
-            pass
-
-        response = r.get(
-            f"https://cloud.iexapis.com/stable/stock/{symbol}/chart/1mm?token={self.IEX_TOKEN}&chartInterval=3&includeToday=false"
-        )
-
-        if response.status_code == 200:
-            df = pd.DataFrame(response.json())
-            df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
-            df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
-            df = df.set_index("DT")
-            self.charts[symbol.upper()] = df
-            return df
-
-        return pd.DataFrame()
-
-    def stat_reply(self, symbols: List[str]) -> Dict[str, str]:
-        """Gets key statistics for each symbol in the list
-
-        Parameters
-        ----------
-        symbols : List[str]
-            List of stock symbols
-
-        Returns
-        -------
-        Dict[str, str]
-            Each symbol passed in is a key with its value being a human readable formatted string of the symbols statistics.
-        """
-        infoMessages = {}
-
-        for symbol in symbols:
-            IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/stats?token={self.IEX_TOKEN}"
-            response = r.get(IEXurl)
-
-            if response.status_code == 200:
-                data = response.json()
-                [data.pop(k) for k in list(data) if data[k] == ""]
-
-                m = ""
-                if "companyName" in data:
-                    m += f"Company Name: {data['companyName']}\n"
-                if "marketcap" in data:
-                    m += f"Market Cap: {data['marketcap']:,}\n"
-                if "week52high" in data:
-                    m += f"52 Week (high-low): {data['week52high']:,} "
-                if "week52low" in data:
-                    m += f"- {data['week52low']:,}\n"
-                if "employees" in data:
-                    m += f"Number of Employees: {data['employees']:,}\n"
-                if "nextEarningsDate" in data:
-                    m += f"Next Earnings Date: {data['nextEarningsDate']}\n"
-                if "peRatio" in data:
-                    m += f"Price to Earnings: {data['peRatio']:.3f}\n"
-                if "beta" in data:
-                    m += f"Beta: {data['beta']:.3f}\n"
-                infoMessages[symbol] = m
-            else:
-                infoMessages[
-                    symbol
-                ] = f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
-
-        return infoMessages
-
-    def crypto_reply(self, pair: str) -> str:
-        """Returns the current price of a cryptocurrency
-
-        Parameters
-        ----------
-        pair : str
-            symbol for the cryptocurrency, sometimes with a price pair like ETHUSD
-
-        Returns
-        -------
-        str
-            Returns a human readable markdown description of the price, or an empty string if no price was found.
-        """
-
-        pair = pair.split(" ")[-1].replace("/", "").upper()
-        pair += "USD" if len(pair) == 3 else pair
-
-        IEXurl = f"https://cloud.iexapis.com/stable/crypto/{pair}/quote?token={self.IEX_TOKEN}"
-
-        response = r.get(IEXurl)
-
-        if response.status_code == 200:
-            data = response.json()
-
-            quote = f"Symbol: {data['symbol']}\n"
-            quote += f"Price: ${data['latestPrice']}\n"
-
-            new, old = data["latestPrice"], data["previousClose"]
-            if old is not None:
-                change = (float(new) - float(old)) / float(old)
-                quote += f"Change: {change}\n"
-
-            return quote
-
-        else:
-            return ""

pyproject.toml

@@ -0,0 +1,11 @@
+[tool.black]
+line-length = 130
+
+[tool.flake8]
+max-line-length = 130
+
+[tool.pycodestyle]
+max_line_length = 130
+
+[tool.ruff]
+line-length = 130

requirements.txt

@@ -1,7 +0,0 @@
-python-telegram-bot==13.2
-requests==2.25.1
-pandas==1.2.1
-fuzzywuzzy==0.18.0
-python-Levenshtein==0.12.1
-schedule==1.0.0
-mplfinance==0.12.7a5

site/.gitignore

@@ -0,0 +1 @@
+.cache

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/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [
+        "!ENV scalar",
+        "!ENV sequence",
+        "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+}

site/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Anson Biggs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

site/docs/LICENSE.md

@@ -0,0 +1,23 @@
+```
+MIT License
+
+Copyright (c) 2019 Anson Biggs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

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

@@ -0,0 +1,186 @@
+Symbols are used in headings to denote what platforms and symbol types a command supports.
+
+- Telegram Only :fontawesome-brands-telegram:
+- Discord Only :fontawesome-brands-discord:
+- Bot Commands :robot:
+- Cryptocurrency Support :material-currency-btc:
+- Stock Market Support :bank:
+
+## 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.
+
+<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>
+
+## 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.
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /donate
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+## `/intra [symbol]` :bank: :material-currency-btc:
+
+This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /intra $astr
+        </div>
+        <div class="message from">
+          <img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
+          <p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
+          <p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
+        </div>
+
+    </div>
+
+</div>
+
+## `/chart [symbol]` :bank: :material-currency-btc:
+
+This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /intra $astr
+        </div>
+        <div class="message from">
+          <img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
+          <p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
+          <p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
+        </div>
+
+    </div>
+
+</div>
+
+## `/trending` 
+
+Gets the latest trending stocks and their change in price
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /trending
+        </div>
+        <pre class="message from">
+
+🦍Trending on the Stock Bot:
+━━━━━━━━━━━━━━━━━━━━━━━━━━
+$GME: Gamestop Corporation - Class A, 5.06%
+$MMAT: Meta Materials Inc, 4.77%
+$$BTC: Bitcoin, -0.83%
+$$ETH: Ethereum, 6.06%
+$$DOGE: Binance-Peg Dogecoin, 0.14%
+
+
+💵Trending Stocks:
+━━━━━━━━━━━━━━━━
+$BBIG: Vinco Ventures Inc, 15.44%
+$GSAT: Globalstar Inc., -15.32%
+$AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
+$ACIU: AC Immune SA, 16.31%
+$PLTR: Palantir Technologies Inc - Class A, 2.25%
+$AAPL: Apple Inc, -0.84%
+$XELA: Exela Technologies Inc, 12.61%
+$WFC: Wells Fargo & Co., -5.60%
+$BAC: Bank Of America Corp., 0.22%
+$AMD: Advanced Micro Devices Inc., -0.54%
+
+
+🦎Trending Crypto:
+━━━━━━━━━━━━━━━━
+$$NFD: Feisty Doge NFT, -34.32%
+$$SLP: Smooth Love Potion, -13.02%
+$$PVU: Plant vs Undead Token, -1.27%
+$$XED: Exeedme, 1.02%
+$$SOL: Solana, -3.95%
+$$BNB: Binance Coin, -0.25%
+$$EWT: Energy Web Token, 17.72%
+
+        </pre>
+    </div>
+
+</div>
+
+## /help :robot:
+
+Just a simple command to get help in app. Returns a more summarized version of this page.
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /help
+        </div>
+        <div class="message from">
+            The current stock price of Tesla Inc is $664.315, the stock is
+            currently down -0.99%
+        </div>
+    </div>
+</div>
+
+## `/status` :robot:
+
+This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
+
+<div class="phone">
+    <div class="messages-wrapper">
+        <div class="message to">
+            /status
+        </div>
+        <pre class="message from">
+Bot Status:
+        It took 0.783369 seconds for the bot to get your message.
+
+        Stock Market Data:
+        marketdata.app is currently not reporting any issues with its API.
+
+        Cryptocurrency Data:
+        CoinGecko API responded that it was OK in 0.160962 Seconds.
+        </pre>
+    </div>
+
+</div>
+
+## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank:  
+
+You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
+full list of stock symbols and return the price of the ticker. Then once you select the ticker
+want the bot will send a message as you in that chat with the latest stock price.
+The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
+`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.

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/docs/stylesheets/phone.css

@@ -0,0 +1,40 @@
+/* https://codepen.io/RG/pen/bdfDI */
+.phone {
+  background: none repeat scroll 0 0 #fff;
+  /*border-left: 1px solid #ccc;
+      border-right: 1px solid #ccc;*/
+  color: #ffffff;
+  font-family: sans-serif;
+  line-height: 20px;
+  width: 80%;
+  margin: 0 auto;
+  overflow-x: hidden;
+  position: relative;
+  border-radius: 10px;
+  margin: 50px;
+}
+.messages-wrapper {
+  position: relative;
+}
+.message {
+  margin: 10px;
+  padding: 15px 20px;
+  position: relative;
+  overflow-x: auto;
+}
+.message.to {
+  border-radius: 20px 0px 20px 20px;
+  background-color: #2095fe;
+  color: #fff;
+  margin-left: 20%;
+}
+.message.from {
+  border-radius: 20px 20px 20px 0px;
+  background-color: #e5e4e9;
+  color: #363636;
+  margin-right: 20%;
+}
+.message.to + .message.to,
+.message.from + .message.from {
+  margin-top: -7px;
+}

site/mkdocs.yml

@@ -0,0 +1,79 @@
+site_name: Simple Stock Bot
+site_url: https://simplestockbot.com
+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
+
+site_description: Simple Discord and Telegram chat bots for Stock Market Data.
+site_author: Anson Biggs
+copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
+
+
+nav:
+  - Home: index.md
+  - Commands: commands.md
+  - Self-Host: host.md
+  - Donate: donate.md
+  - Contact: contact.md
+  - Blog: blog/index.md
+
+theme:
+  name: material
+  language: en
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - content.code.copy
+  icon:
+    logo: material/robot-love
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      primary: green
+      scheme: default
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      primary: green
+      scheme: slate
+      toggle:
+        icon: material/lightbulb
+        name: Switch to light mode
+
+extra:
+  social:
+    - icon: fontawesome/solid/house
+      link: https://simplestockbot.com/
+    - icon: fontawesome/brands/telegram
+      link: https://t.me/SimpleStockBot
+      name: Get the Telegram bot
+    - icon: fontawesome/brands/discord
+      link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
+      name: Get the Discord Bot
+    - icon: material/chart-line-stacked
+      link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
+      name: MarketData.app for stock data
+
+
+
+
+extra_css:
+  - stylesheets/phone.css
+
+
+plugins:
+  - search
+  - social
+  - blog
+
+
+markdown_extensions:
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences

site/requirements.txt

@@ -0,0 +1,5 @@
+mkdocs-material==9.4.4
+
+# Required for Social Cards
+Pillow==10.0.1
+CairoSVG==2.7.1

telegram/Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.11-buster AS builder
+
+
+COPY telegram/telegram-reqs.txt .
+COPY common/requirements.txt .
+
+RUN pip install --user -r telegram-reqs.txt
+
+
+FROM python:3.11-slim
+
+ENV MPLBACKEND=Agg
+
+COPY --from=builder /root/.local /root/.local
+
+
+COPY common common
+COPY telegram .
+
+
+
+CMD [ "python", "./bot.py" ]

telegram/T_info.py

@@ -0,0 +1,70 @@
+"""Functions and Info specific to the Telegram Bot
+"""
+
+import re
+
+import requests as r
+
+
+class T_info:
+    license = re.sub(
+        r"\b\n",
+        " ",
+        r.get("https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE").text,
+    )
+
+    help_text = """
+Appreciate this bot? Show support by [buying me a beer](https://www.buymeacoffee.com/Anson) 🍻.
+
+Want stock data or to host your own bot? Help keep this bot free by using my
+[affiliate link](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
+📢 Stay updated on the bot's Telegram: https://t.me/simplestockbotnews.
+
+**Guide**: All about using and setting up the bot is in the [docs](https://simplestockbot.com).
+
+The bot recognizes _"Symbols"_. `$` for stocks and `$$` for cryptos. Example:
+- `/chart $$eth` gets a month's Ethereum chart.
+- `/dividend $psec` shows Prospect Capital's dividend info.
+
+Mention a symbol, and the bot reveals its price.
+E.g., `What's $$btc's price since $tsla accepts it?` gives Bitcoin and Tesla prices.
+
+**Commands**
+- `/donate [USD]`: Support the bot. 🎗️
+- `/intra $[symbol]`: Today's stock activity. 📈
+- `/chart $[symbol]`: Past month's stock chart. 📊
+- `/trending`: What's hot in stocks and cryptos. 💬
+- `/help`: Bot assistance. 🆘
+
+**Inline Features**
+Search with @SimpleStockBot `[query]` anywhere.
+Pick a ticker, and the bot shares the current price in chat. Note: Prices can lag by an hour.
+
+Data thanks to [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
+Bot issues? Use `/status` or [contact us](https://simplestockbot.com/contact).
+
+    """
+
+    donate_text = """
+Support Simple Stock Bot through [donations](https://www.buymeacoffee.com/Anson).
+All funds help maintain servers, with data from
+[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=telegram).
+
+**How to Donate?**
+1. Use `/donate [amount in USD]`. E.g., `/donate 2` donates 2 USD.
+2. Or, quickly donate at [buymeacoffee](https://www.buymeacoffee.com/Anson). No account needed, accepts Paypal & Credit card.
+
+For questions, visit our [website](https://simplestockbot.com).
+"""
+
+
+# Not used by the bot but for updating commands with BotFather
+commands = """
+donate - Donate to the bot 🎗️
+help - Get some help using the bot. 🆘
+trending - Trending Stocks and Cryptos. 💬
+intra - $[symbol] Plot since the last market open. 📈
+chart - $[chart] Plot of the past month. 📊
+"""

telegram/bot.py

@@ -0,0 +1,514 @@
+# Works with Python 3.8
+import datetime
+import html
+import io
+import json
+import logging
+import os
+import random
+import string
+import traceback
+from uuid import uuid4
+
+import mplfinance as mpf
+import telegram
+from telegram import (
+    InlineQueryResultArticle,
+    InputTextMessageContent,
+    LabeledPrice,
+    Update,
+)
+
+from telegram.ext import (
+    Application,
+    CommandHandler,
+    InlineQueryHandler,
+    PreCheckoutQueryHandler,
+    MessageHandler,
+    filters,
+    ContextTypes,
+)
+
+from common.symbol_router import Router
+from T_info import T_info
+
+# Enable logging
+logging.basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO)
+
+# set higher logging level for httpx to avoid all GET and POST requests being logged
+logging.getLogger("httpx").setLevel(logging.WARNING)
+
+log = logging.getLogger(__name__)
+
+TELEGRAM_TOKEN = os.environ["TELEGRAM"]
+
+try:
+    STRIPE_TOKEN = os.environ["STRIPE"]
+except KeyError:
+    STRIPE_TOKEN = ""
+    log.warning("Starting without a STRIPE Token will not allow you to accept Donations!")
+
+s = Router()
+t = T_info()
+
+
+log.info("Bot script started.")
+
+
+async def start(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Send help text when the command /start is issued."""
+    log.info(f"Start command ran by {update.message.chat.username}")
+    await update.message.reply_text(
+        text=t.help_text,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def help(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Send help text when the command /help is issued."""
+    log.info(f"Help command ran by {update.message.chat.username}")
+    await update.message.reply_text(
+        text=t.help_text,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def license(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Send bots license when the /license command is issued."""
+    log.info(f"License command ran by {update.message.chat.username}")
+    await update.message.reply_text(
+        text=t.license,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def status(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Gather status of bot and dependant services and return important status updates."""
+    log.warning(f"Status command ran by {update.message.chat.username}")
+    bot_resp_time = datetime.datetime.now(update.message.date.tzinfo) - update.message.date
+
+    bot_status = s.status(f"It took {bot_resp_time.total_seconds()} seconds for the bot to get your message.")
+
+    await update.message.reply_text(
+        text=bot_status,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+    )
+
+
+async def donate(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Sets up donation."""
+    log.info(f"Donate command ran by {update.message.chat.username}")
+    chat_id = update.message.chat_id
+
+    if update.message.text.strip() == "/donate" or "/donate@" in update.message.text:
+        await update.message.reply_text(
+            text=t.donate_text,
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        amount = 1.0
+    else:
+        amount = float(update.message.text.replace("/donate", "").replace("$", "").strip())
+
+    try:
+        price = int(amount * 100)
+    except ValueError:
+        await update.message.reply_text(f"{amount} is not a valid donation amount or number.")
+        return
+    log.info(f"Donation amount: {price} by {update.message.chat.username}")
+
+    await context.bot.send_invoice(
+        chat_id=chat_id,
+        title="Simple Stock Bot Donation",
+        description=f"Simple Stock Bot Donation of ${amount} by {update.message.chat.username}",
+        payload=f"simple-stock-bot-{chat_id}",
+        provider_token=STRIPE_TOKEN,
+        currency="USD",
+        prices=[LabeledPrice("Donation:", price)],
+        start_parameter="",
+        # suggested_tip_amounts=[100, 500, 1000, 2000],
+        photo_url="https://simple-stock-bots.gitlab.io/docs/img/Telegram.png",
+        photo_width=500,
+        photo_height=500,
+    )
+
+
+async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Approves donation"""
+    log.info("precheckout_callback queried")
+    query = update.pre_checkout_query
+
+    await query.answer(ok=True)
+    # I dont think I need to check since its only donations.
+    # if query.invoice_payload == "simple-stock-bot":
+    #     # answer False pre_checkout_query
+    #     await query.answer(ok=True)
+    # else:
+    #     await query.answer(ok=False, error_message="Something went wrong...")
+
+
+async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Thanks user for donation"""
+    log.info("Successful payment!")
+    await update.message.reply_text("Thank you for your donation! It goes a long way to keeping the bot free!")
+
+
+async def symbol_detect_image(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """
+    Makes image captions into text then passes the `update` and `context`
+        to symbol detect so that it can reply cashtags in image captions.
+    """
+    try:
+        if update.message.caption:
+            update.message.text = update.message.caption
+            await symbol_detect(update, context)
+    except AttributeError:
+        return
+
+
+async def symbol_detect(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """
+    Runs on any message that doesn't have a command and searches for cashtags,
+        then returns the prices of any symbols found.
+    """
+    try:
+        message = update.message.text
+        chat_id = update.message.chat_id
+        if "$" in message:
+            log.info("Looking for Symbols")
+            symbols = s.find_symbols(message)
+        else:
+            return
+    except AttributeError as ex:
+        log.info(ex)
+        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:
+        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(
+                text=reply,
+                parse_mode=telegram.constants.ParseMode.MARKDOWN,
+                disable_notification=True,
+            )
+
+
+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}")
+
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/intra":
+        await update.message.reply_text(
+            "This command returns a chart of the stocks movement since the most recent market open.\nExample: /intra $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message, trending_weight=5)
+    symbol = symbols[0]
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await update.message.reply_text("No symbols or coins found.")
+        return
+
+    df = s.intra_reply(symbol)
+    if df.empty:
+        await update.message.reply_text(
+            text="Invalid symbol please see `/help` for usage details.",
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        return
+
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
+
+    buf = io.BytesIO()
+    mpf.plot(
+        df,
+        type="renko",
+        title=f"\n{symbol.name}",
+        volume="Volume" in df.keys(),
+        style="yahoo",
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+    )
+    buf.seek(0)
+
+    await update.message.reply_photo(
+        photo=buf,
+        caption=f"\nIntraday chart for {symbol.name} from {df.first_valid_index().strftime('%d %b at %H:%M')} to"
+        + f" {df.last_valid_index().strftime('%d %b at %H:%M %Z')}"
+        + f"\n\n{s.price_reply([symbol])[0]}",
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def chart(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """returns a chart of the past month of data for a symbol"""
+    log.info(f"Chart command ran by {update.message.chat.username}")
+
+    message = update.message.text
+    chat_id = update.message.chat_id
+
+    if message.strip().split("@")[0] == "/chart":
+        await update.message.reply_text(
+            "This command returns a chart of the stocks movement for the past month.\nExample: /chart $tsla"
+        )
+        return
+
+    symbols = s.find_symbols(message, trending_weight=10)
+
+    if len(symbols):
+        symbol = symbols[0]
+    else:
+        await update.message.reply_text("No symbols or coins found.")
+        return
+
+    df = s.chart_reply(symbol)
+    if df.empty:
+        await update.message.reply_text(
+            text="Invalid symbol please see `/help` for usage details.",
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+            disable_notification=True,
+        )
+        return
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.UPLOAD_PHOTO)
+
+    buf = io.BytesIO()
+    mpf.plot(
+        df,
+        type="candle",
+        title=f"\n{symbol.name}",
+        volume="Volume" in df.keys(),
+        style="yahoo",
+        savefig=dict(fname=buf, dpi=400, bbox_inches="tight"),
+    )
+    buf.seek(0)
+
+    await update.message.reply_photo(
+        photo=buf,
+        caption=f"\n1 Month chart for {symbol.name} from {df.first_valid_index().strftime('%d, %b %Y')}"
+        + f" to {df.last_valid_index().strftime('%d, %b %Y')}\n\n{s.price_reply([symbol])[0]}",
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def trending(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """returns currently trending symbols and how much they've moved in the past trading day."""
+    log.info(f"Trending command ran by {update.message.chat.username}")
+
+    chat_id = update.message.chat_id
+
+    await context.bot.send_chat_action(chat_id=chat_id, action=telegram.constants.ChatAction.TYPING)
+
+    trending_list = s.trending()
+
+    await update.message.reply_text(
+        text=trending_list,
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def inline_query(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    """
+    Handles inline query. Searches by looking if query is contained
+        in the symbol and returns matches in alphabetical order.
+    """
+
+    if not update.inline_query.query:
+        return
+
+    print(f"Query: {update.inline_query.query}")
+
+    ignored_queries = {"$", "$$", " ", ""}
+
+    if update.inline_query.query.strip() in ignored_queries:
+        default_message = """
+        You can type:\n@SimpleStockBot `[search]`
+        in any chat or direct message to search for the stock bots full list of stock and crypto symbols and return the price.
+        """
+
+        await update.inline_query.answer(
+            [
+                InlineQueryResultArticle(
+                    str(uuid4()),
+                    title="Please enter a query. It can be a ticker or a name of a company.",
+                    input_message_content=InputTextMessageContent(
+                        default_message, parse_mode=telegram.constants.ParseMode.MARKDOWN
+                    ),
+                )
+            ]
+        )
+
+    matches = s.inline_search(update.inline_query.query)
+
+    results = []
+    for _, row in matches.iterrows():
+        results.append(
+            InlineQueryResultArticle(
+                str(uuid4()),
+                title=row["description"],
+                input_message_content=InputTextMessageContent(
+                    row["price_reply"], parse_mode=telegram.constants.ParseMode.MARKDOWN
+                ),
+            )
+        )
+
+        if len(results) == 5:
+            await update.inline_query.answer(results, cache_time=60 * 60)
+            log.info("Inline Command was successful")
+            return
+    await update.inline_query.answer(results)
+
+
+async def rand_pick(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """For the gamblers. Returns a random symbol to buy and a sell date"""
+    log.info(f"Someone is gambling! Random_pick command ran by {update.message.chat.username}")
+
+    await update.message.reply_text(
+        text=s.random_pick(),
+        parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        disable_notification=True,
+    )
+
+
+async def error(update: Update, context: ContextTypes.DEFAULT_TYPE):
+    """Log Errors caused by Updates."""
+    log.warning('Update "%s" caused error "%s"', update, error)
+
+    tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
+    tb_string = "".join(tb_list)
+
+    err_code = "".join([random.choice(string.ascii_lowercase) for i in range(5)])
+    log.warning(f"Logging error: {err_code}")
+
+    if update:
+        log.warning(
+            f"An exception was raised while handling an update\n"
+            f"\tupdate = {html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False))}\n"
+            f"\tcontext.chat_data = {str(context.chat_data)}\n"
+            f"\tcontext.user_data = {str(context.user_data)}\n"
+            f"\t{html.escape(tb_string)}"
+        )
+
+        await update.message.reply_text(
+            text=f"An error has occured. Please inform @MisterBiggs if the error persists. Error Code: `{err_code}`",
+            parse_mode=telegram.constants.ParseMode.MARKDOWN,
+        )
+    else:
+        log.warning("No message to send to user.")
+        log.warning(tb_string)
+
+
+def main():
+    """Start the context.bot."""
+    # Create the EventHandler and pass it your bot's token.
+    application = Application.builder().token(TELEGRAM_TOKEN).build()
+
+    # on different commands - answer in Telegram
+    application.add_handler(CommandHandler("start", start))
+    application.add_handler(CommandHandler("help", help))
+    application.add_handler(CommandHandler("license", license))
+    application.add_handler(CommandHandler("trending", trending))
+    application.add_handler(CommandHandler("random", rand_pick))
+    application.add_handler(CommandHandler("donate", donate))
+    application.add_handler(CommandHandler("status", status))
+    application.add_handler(CommandHandler("inline", inline_query))
+
+    # Charting can be slow so they run async.
+    application.add_handler(CommandHandler("intra", intra, block=False))
+    application.add_handler(CommandHandler("intraday", intra, block=False))
+    application.add_handler(CommandHandler("day", intra, block=False))
+    application.add_handler(CommandHandler("chart", chart, block=False))
+    application.add_handler(CommandHandler("month", chart, block=False))
+
+    # on noncommand i.e message - echo the message on Telegram
+    application.add_handler(MessageHandler(filters.TEXT, symbol_detect))
+    application.add_handler(MessageHandler(filters.PHOTO, symbol_detect_image))
+
+    # Inline Bot commands
+    application.add_handler(InlineQueryHandler(inline_query))
+
+    # Pre-checkout handler to final check
+    application.add_handler(PreCheckoutQueryHandler(precheckout_callback))
+
+    # Payment success
+    application.add_handler(MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback))
+
+    # log all errors
+    application.add_error_handler(error)
+
+    # Start the Bot
+    application.run_polling(allowed_updates=Update.ALL_TYPES)
+
+
+if __name__ == "__main__":
+    main()

telegram/telegram-reqs.txt

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

tests.py

@@ -0,0 +1,23 @@
+import time
+
+import keyboard
+
+tests = """$$xno
+$tsla
+/intra $tsla
+/intra $$btc
+/chart $tsla
+/chart $$btc
+/help
+/trending""".split(
+    "\n"
+)
+
+print("press enter to start")
+keyboard.wait("enter")
+
+for test in tests:
+    print(test)
+    keyboard.write(test)
+    time.sleep(1)
+    keyboard.press_and_release("enter")