Code cleanup

README.MD

@@ -14,13 +14,13 @@ Use this bot for communicate with users in case you do not want to provide your
 
 ## Usage
 
-Messages with an available [content type](./src/bot/handlers/users.py#L24) will be transfered to admin group or admin chat.
+Messages with an **available content type** *(TEXT, ANIMATION, AUDIO, DOCUMENT, PHOTO, VIDEO, VOICE)* will be transferred to **admin group** or **admin chat**.
 
 *(See variable `chat_id` from [config.yaml](./deploy/example.config.yaml#L6))*
 
 If the transfer is successful, the requesting party will be notified.
 
-Admin can answer to message by reply. The answer will be sent to the person who asked.
+**Admin** can **answer** to message **by reply**. The answer will be sent to the person who asked.
 
 If the transfer is successful, the administrator will be notified.
 
@@ -68,6 +68,13 @@ and build docker image:
 
 And use this image with [docker-compose.yml](./deploy/example.docker-compose.yml) from `deploy` dir.
 
+## Hosting
+You can rent a server from various hosters, for example from [Aeza](https://aeza.net/?ref=380831).
+
+>*By registering via the [link](https://aeza.net/?ref=380831) you will support the project and receive a 15% bonus on your balance, which will be valid for 24 hours.*
+
+The bot will require the simplest VDS, in rubles this is approximately 100-200 for promotional offers, or about 500 rubles per month.
+
 ## Develop and Contribute
 
 Feel free to create issue or pull request.

requirements.txt

@@ -1,7 +1,8 @@
-aiogram==3.1.0
-sulguk==0.5.0
+aiogram==3.1.1
+# sulguk==0.6.0
+# wait for fix https://github.com/Tishka17/sulguk/issues/19
+git+https://github.com/bralbral/sulguk.git
 pydantic-settings==2.0.3
-pyaml==23.9.6
+pyaml==23.9.7
 structlog~=23.1.0
-# asyncio speedup
 uvloop==0.17.0; sys_platform == 'linux'

src/bot/handlers/admins/router.py

@@ -16,6 +16,15 @@
 async def reply_to_user(
     message: Message, bot: Bot, messages: Messages, errors: Errors, **kwargs
 ):
+    """
+    Answer to user by reply from admin chat or group
+    :param message:
+    :param bot:
+    :param messages:
+    :param errors:
+    :param kwargs:
+    :return:
+    """
     try:
         user_id = extract_id(message.reply_to_message)
     except ValueError as ex:

src/bot/handlers/misc.py

@@ -14,6 +14,13 @@
     Command("start", "help"),
 )  # type: ignore
 async def start_help_handler(message: Message, messages: Messages, **kwargs) -> None:
+    """
+    Handle /start or /help message
+    :param message:
+    :param messages:
+    :param kwargs:
+    :return:
+    """
     await message.answer(
         messages.help_message,
         disable_web_page_preview=True,

src/bot/handlers/users.py

@@ -11,7 +11,6 @@
 router = Router(name="users")
 
 
-# process messages only from PM
 @router.message(F.chat.id == F.from_user.id)  # type: ignore
 async def handle_user_message(
     message: Message,
@@ -21,6 +20,15 @@ async def handle_user_message(
     errors: Errors,
     **kwargs,
 ):
+    """Handle user message and send it to admin chat (group)
+    :param message:
+    :param bot:
+    :param chat_id:
+    :param messages:
+    :param errors:
+    :param kwargs:
+    :return:
+    """
     if message.content_type not in (
         ContentType.TEXT,
         ContentType.ANIMATION,
@@ -52,7 +60,7 @@ async def handle_user_message(
         )
 
     else:
-        if len(message.caption) > 1000:
+        if message.caption and len(message.caption) > 1000:
             await message.reply(text=errors.too_long_message_caption)
             return
 

src/bot/utils/setup_bot.py

@@ -7,6 +7,10 @@
 
 
 async def setup_bot(config: BotConfig) -> Bot:
+    """
+    :param config:
+    :return:
+    """
     bot: Bot = Bot(
         token=config.token.get_secret_value(),
     )

src/bot/utils/setup_dispatcher.py

@@ -12,6 +12,13 @@
 def setup_dispatcher(
     logger: BoundLogger, chat_id: int, messages: Messages, errors: Errors
 ) -> Dispatcher:
+    """
+    :param logger:
+    :param chat_id:
+    :param messages:
+    :param errors:
+    :return:
+    """
     dp: Dispatcher = Dispatcher(
         storage=MemoryStorage(),
         logger=logger,

src/config/utils.py

@@ -4,6 +4,10 @@
 
 
 def load_config(config_path: str) -> Config:
+    """
+    :param config_path:
+    :return:
+    """
     with open(file=config_path, mode="rb") as fh:
         raw_data: dict = yaml.load(stream=fh, Loader=yaml.FullLoader)
         config: Config = Config.model_validate(raw_data)