TFinance 1.2.0

.dockerignore

@@ -0,0 +1,2 @@
+**/*.db
+**/logs

.env.example

@@ -0,0 +1,2 @@
+BOT_TOKEN=your_telegram_bot_token
+DATABASE_NAME=database

.github/workflows/python-app.yml

@@ -12,20 +12,41 @@ permissions:
 jobs:
   black-test:
     runs-on: ubuntu-latest
-    container: python:3.11
+    container: python:3.13-alpine
     steps:
       - uses: actions/checkout@v3
       - name: Install dependencies
         run: pip install black
       - name: Check code formatting with black
-        run: black ./ --check --verbose --diff
+        run: black ./tfinance --check --verbose --diff
 
   flake8-test:
     runs-on: ubuntu-latest
-    container: python:3.11
+    container: python:3.13-alpine
     steps:
     - uses: actions/checkout@v3
     - name: Install dependencies
       run: pip install -r requirements/test.txt
     - name: Check code formatting with flake8
-      run: flake8 ./
+      run: flake8 ./tfinance
+
+  prod-deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: [ black-test, flake8-test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Deploy to server
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USERNAME }}
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            cd ~/TFinance
+            git reset --hard origin/main  
+            git pull origin main
+            docker compose down -v
+            docker compose up --build -d

.gitignore

@@ -1,5 +1,6 @@
 /.idea
-/logs
-/data.db
-/safety_key.py
-stocks.json
+logs
+sqlite
+*.db
+stocks.json
+.env

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.13-alpine
+
+COPY ./requirements /requirements
+RUN pip install --no-cache-dir -r requirements/prod.txt
+RUN rm -rf requirements
+
+COPY ./tfinance /tfinance/
+WORKDIR /tfinance
+
+ENTRYPOINT ["python", "main.py"]

README.md

@@ -5,8 +5,8 @@
 Проект: Telegram bot TFinace
 
 TFinance - телеграм бот, позволяющий получить доступ к курсу 
-акций. На понравившиеся вам акции вы можете подписаться и включить ежедненую
-рассылку их курса. Также вы можете попытать удачу и сыграть в игру, предугодав 
+акций. На понравившиеся вам акции вы можете подписаться и включить ежедневную
+рассылку их курса. Также вы можете попытать удачу и сыграть в игру, предугадав 
 будущий курс, в случае удачи вы заработаете 1 очко в криптоигре.
 
 <h2>Задачи, которые мы выполнили:</h2>
@@ -23,7 +23,7 @@ TFinance - телеграм бот, позволяющий получить до
     <li>Использовали команду /unfollow для отписки от акции.</li>
     <li>Использовали команду /stock для вывода курса акции.</li>
     <li>Использовали команду /stocks для вывода акций с биржи.</li>
-    <li>Использовали команду /daily для подписки на ежедненую расслылку курсов 
+    <li>Использовали команду /daily для подписки на ежедневную рассылку курсов 
 	избранных акций.</li>
     <li>Получение списка акций с биржи с помощью http-запросов.</li>
     </ul>

docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  tfinance_bot:
+    build: .
+    container_name: tfinance_bot
+    env_file:
+      - ./.env
+    restart: unless-stopped
+    volumes:
+      - ./etc_tfinance/logs:/tfinance/logs
+      - ./etc_tfinance/sqlite:/tfinance/sqlite

pyproject.toml

@@ -1,19 +1,12 @@
 [tool.flake8]
-max-line-length = 89
+max-line-length = 79
 inline-quotes="double"
 import-order-style="google"
-extend-ignore = [
-    "R503",
-    "R502",
-    "F401",
-    "N802",
-]
 exclude = [
     ".git",
     "__pycache__",
-    "docs/source/conf.py",
     "venv",
 ]
 
 [tool.black]
-line-length = 89
+line-length = 79

requirements.txt

@@ -1,6 +1,6 @@
 matplotlib>=3.5.3
+python-dotenv>=1.0.1
 python-telegram-bot>=21.1.1
 python-telegram-bot[job-queue]
-pytz>=2024.1
 requests>=2.31.0
 yfinance>=0.2.38

requirements/prod.txt

@@ -1,6 +1,6 @@
 matplotlib>=3.5.3
+python-dotenv>=1.0.1
 python-telegram-bot>=21.1.1
 python-telegram-bot[job-queue]
-pytz>=2024.1
 requests>=2.31.0
 yfinance>=0.2.38

requirements/test.txt

@@ -1,6 +1,10 @@
 flake8>=6.1.0
+flake8-all-not-strings>=0.0.2
 flake8-commas>=2.1.0
 flake8-comments>=0.1.2
+flake8-dunder-all>=0.4.1
+flake8-encodings>=0.5.1
+flake8-eradicate>=1.5.0
 flake8-print>=5.0.0
 Flake8-pyproject>=1.2.3
 flake8-quotes>=3.3.2

blast.py → tfinance/blast.py

@@ -11,7 +11,8 @@
 
 async def notify_assignees(context: CallbackContext):
     db = Database()
-    # Перебираем всех пользователей и рассылаем каждому курсы их избранных акций.
+    # Перебираем всех пользователей и
+    # рассылаем каждому курсы их избранных акций.
     for user in db.get_users():
         if db.check_user_daily_notify(user):
             if user.favourite_stocks:
@@ -35,3 +36,9 @@ async def daily(update: Update, _):
     else:
         await update.message.reply_text("Ежедневная рассылка включена")
     db.user_daily_notify(user)
+
+
+__all__ = [
+    "daily",
+    "notify_assignees",
+]

tfinance/config.py

@@ -0,0 +1,12 @@
+import os
+from zoneinfo import ZoneInfo
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+BOT_TOKEN = os.getenv("BOT_TOKEN")
+DATABASE_NAME = os.getenv("DATABASE_NAME")
+
+TIMEZONE = ZoneInfo("Europe/Moscow")

database.py → tfinance/database.py

@@ -1,6 +1,8 @@
 import sqlite3
+from pathlib import Path
 
 from models import User
+from config import DATABASE_NAME
 
 
 def singleton(cls):
@@ -22,7 +24,11 @@ class Database:
 
     def __init__(self):
         # Подключение к БД с отключенной проверкой потока.
-        self.con = sqlite3.connect("data.db", check_same_thread=False)
+        Path("sqlite").mkdir(exist_ok=True)
+        self.con = sqlite3.connect(
+            f"sqlite/{DATABASE_NAME}.db",
+            check_same_thread=False,
+        )
         self.cur = self.con.cursor()
         self.setup()
 
@@ -111,7 +117,8 @@ def add_prediction(self, user: User, stock_name: str, updown: str):
         if predictions[0]:
             prediction = f"{predictions[0]} {prediction}"
         self.cur.execute(
-            f"UPDATE users SET prediction = ' {prediction}' WHERE id = {user.id}",
+            f"UPDATE users SET prediction = ' {prediction}' "
+            f"WHERE id = {user.id}",
         )
         self.con.commit()
 
@@ -145,7 +152,9 @@ def delete_predictions(self, user: User):
         :param user: Экземпляр класса User с данными об этом пользователе.
         :return: None
         """
-        self.cur.execute(f"UPDATE users SET prediction = '' WHERE id = {user.id}")
+        self.cur.execute(
+            f"UPDATE users SET prediction = '' WHERE id = {user.id}",
+        )
         self.con.commit()
 
     def select_stock(self, user: User, stock_name: str):
@@ -161,11 +170,12 @@ def select_stock(self, user: User, stock_name: str):
         if selected_stocks:
             stock_name = f"{selected_stocks} {stock_name}"
         self.cur.execute(
-            f"UPDATE users SET selected_stock = '{stock_name}' WHERE id = {user.id}",
+            f"UPDATE users SET selected_stock = '{stock_name}' "
+            f"WHERE id = {user.id}",
         )
         self.con.commit()
 
-    def get_selected_stock_byid(self, user: User, message_id) -> str:
+    def get_selected_stock_byid(self, user: User, message_id) -> str | None:
         """
             Получить название акции по id сообщения с игрой.
         :param user: Экземпляр класса User с данными об этом пользователе.
@@ -179,6 +189,7 @@ def get_selected_stock_byid(self, user: User, message_id) -> str:
             for i in data.split():
                 if str(message_id) == i.split(":")[-1]:
                     return i.split(":")[0]
+        return None
 
     def get_selected_stocks(self, user: User) -> list:
         """
@@ -253,7 +264,8 @@ def add_favourites_stocks(self, user: User, stock_name: str):
         if stocks and stocks[0]:
             stock_name = f"{stocks[0]} {stock_name}"
         self.cur.execute(
-            f"UPDATE users SET favourites_stocks = '{stock_name}' WHERE id = {user.id}",
+            f"UPDATE users SET favourites_stocks = '{stock_name}' "
+            f"WHERE id = {user.id}",
         )
         self.con.commit()
 
@@ -299,7 +311,8 @@ def remove_favourites_stock(self, user: User, stock_name: str):
             else:
                 a = f"'{' '.join(a)}'"
             self.cur.execute(
-                f"UPDATE users SET favourites_stocks = {a} WHERE id = {user.id}",
+                f"UPDATE users SET favourites_stocks = {a} "
+                f"WHERE id = {user.id}",
             )
             self.con.commit()
 
@@ -310,7 +323,8 @@ def user_daily_notify(self, user: User):
         :return: None
         """
         self.cur.execute(
-            f"UPDATE users SET daily_notify = NOT daily_notify WHERE id = {user.id}",
+            f"UPDATE users SET daily_notify = NOT daily_notify "
+            f"WHERE id = {user.id}",
         )
         self.con.commit()
 
@@ -339,3 +353,8 @@ def add_point(self, user: User):
         )
         user.points += 1
         self.con.commit()
+
+
+__all__ = [
+    "Database",
+]

exceptions.py → tfinance/exceptions.py

@@ -14,3 +14,11 @@ class EmptyDataFrameError(Exception):  # Пустой дата фрейм
 
 class WrongPeriodError(Exception):  # Неверный период
     pass
+
+
+__all__ = [
+    "StockSelectedAlready",
+    "PredictionAlreadySet",
+    "EmptyDataFrameError",
+    "WrongPeriodError",
+]

functions.py → tfinance/functions.py

@@ -13,3 +13,8 @@ def create_user(update: Update) -> User:
         user_data["language_code"],
         user_data["is_bot"],
     )
+
+
+__all__ = [
+    "create_user",
+]

game.py → tfinance/game.py

@@ -1,8 +1,22 @@
-from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
-from telegram.ext import ContextTypes, CallbackContext
+from telegram import (
+    InlineKeyboardButton,
+    InlineKeyboardMarkup,
+    Update,
+)
+from telegram.ext import (
+    ContextTypes,
+    CallbackContext,
+    ConversationHandler,
+    CommandHandler,
+    CallbackQueryHandler,
+)
 
 from database import Database
-from exceptions import EmptyDataFrameError, PredictionAlreadySet, StockSelectedAlready
+from exceptions import (
+    EmptyDataFrameError,
+    PredictionAlreadySet,
+    StockSelectedAlready,
+)
 from functions import create_user
 from graphics.visualize import check_stock_prices, do_stock_image
 from models import User
@@ -17,12 +31,14 @@ async def game_menu(update: Update, context: ContextTypes.DEFAULT_TYPE):
     # Сохраняем id сообщения для возможности одновременной
     message_id = str(int(update.message.message_id) + 2)
     # Игры на многих акциях.
-    # Прибавляем 2 т.к. отправляем 2 сообщения: фото и приписку к нему с клавиатурой.
+    # Прибавляем 2 т.к. отправляем 2 сообщения:
+    # фото и приписку к нему с клавиатурой.
     try:
         # Проверка на наличие аргументов.
         if not context.args:
             await update.message.reply_text(
-                "Неправильно введена команда! Попробуйте: /game [индекс акции]",
+                "Неправильно введена команда! "
+                "Попробуйте: /game [индекс акции]",
             )
         # Проверка: была ли выбрана акция до этого? Избегаем читерства.
         if db.check_selected_stocks(user):
@@ -80,7 +96,8 @@ async def game_menu(update: Update, context: ContextTypes.DEFAULT_TYPE):
         )
         db.remove_selected_stock(user, message_id)
 
-    # Возвращаем 1, чтобы показать ConversationHandler'у состояние, в котором находимся.
+    # Возвращаем 1, чтобы показать ConversationHandler'у состояние,
+    # в котором находимся.
     return 1
 
 
@@ -194,3 +211,21 @@ async def game_results(context: CallbackContext):
         # Удаляем пройденные прогнозы
         db.delete_predictions(user)
         user.prediction = db.get_predictions(user)
+
+
+game_handler = ConversationHandler(
+    entry_points=[CommandHandler("game", game_menu)],
+    states={
+        1: [
+            CallbackQueryHandler(higher_game, pattern="^1$"),
+            CallbackQueryHandler(lower_game, pattern="^2$"),
+        ],
+    },
+    fallbacks=[CommandHandler("game", game_menu)],
+)
+
+
+__all__ = [
+    "game_handler",
+    "game_results",
+]