Merge pull request #27 from Aidenable/dev

v1.3.5: `eval`, `bash`, `stats`, `help` commands; list paginator; docs improvements

Author: Aidenable

docs/source/_static/help-command.png

@@ -77,53 +77,103 @@ Both decorators accept optional arguments:
 Examples
 ~~~~~~~~~~~~
 
-Static layout:
+Static inline keyboard:
 ^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
    from raito import rt
 
-   @rt.keyboard.static(inline=True)
-   def faq_buttons():
+   @rt.keyboard.static()
+   def info_markup():
        return [
-           ("Terms of Service", "tos"),
-           ("Privacy", "privacy"),
+           [("💬 Support", "support")],
+           [("🔒 Privacy", "privacy"), ("📄 TOS", "terms_of_use")]
        ]
 
-Dynamic layout:
+    @router.message(...)
+    async def handler(message: Message):
+        await message.answer("Buttons:", reply_markup=info_markup())
+
+Static reply keyboard:
+^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from raito import rt
+
+    @rt.keyboard.static(inline=False)
+    def info_markup():
+        return [
+            ["💬 Support"],
+            [["🔒 Privacy"], ["📄 TOS"]]
+        ]
+
+    @router.message(...)
+    async def handler(message: Message):
+        await message.answer("Buttons:", reply_markup=info_markup())
+
+Dynamic inline keyboard:
 ^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
    from aiogram.utils.keyboard import InlineKeyboardBuilder
    from raito import rt
 
-   from ... import Player
+   @rt.keyboard.dynamic(1, 2)
+   def info_markup(builder: InlineKeyboardBuilder, privacy_url: str, tos_url: str):
+       builder.button(text="💬 Support", callback_data="support")
+       builder.button(text="🔒 Privacy", url=privacy_url)
+       builder.button(text="📄 TOS", url=tos_url)
+
+    @router.message(...)
+    async def handler(message: Message):
+        await message.answer("Buttons:", reply_markup=info_markup(
+            privacy_url="https://example.com/privacy",
+            tos_url="https://example.com/tos",
+        ))
 
-   @rt.keyboard.dynamic()
-   def leaderboard(builder: InlineKeyboardBuilder, players: list[Player]):
-       for player in players:
-           builder.button(text=f"{player.name}", callback_data=f"player:{player.id}")
+Dynamic reply keyboard:
+^^^^^^^^^^^^^^^^
+
+.. code-block:: python
 
-       builder.adjust(1, 2, 2)
+    from aiogram.utils.keyboard import ReplyKeyboardBuilder
+    from raito import rt
 
-Dynamic pagination-like example:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    @rt.keyboard.dynamic(1, 2, inline=False)
+    def info_markup(builder: ReplyKeyboardBuilder):
+        builder.button(text="💬 Support")
+        builder.button(text="🔒 Privacy")
+        builder.button(text="📄 TOS")
+
+    @router.message(...)
+    async def handler(message: Message):
+        await message.answer("Buttons:", reply_markup=info_markup())
+
+Custom adjust:
+^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
    from aiogram.utils.keyboard import InlineKeyboardBuilder
    from raito import rt
 
-   from ... import Player
-
    @rt.keyboard.dynamic(adjust=False)
-   def leaderboard(builder: InlineKeyboardBuilder, players: list[Player]):
-       for i, player in enumerate(players, start=1):
-           builder.button(text=f"#{i} {player.name}", callback_data=f"player:{player.id}")
+   def admin_markup(builder: InlineKeyboardBuilder, show_balance_management: bool = False):
+       adjust = []
+
+       builder.button(text="👤 Users", callback_data="users")
+       adjust.append(1)
+
+       if show_balance_management:
+           builder.button(text="📤 Withdraw", callback_data="withdraw")
+           builder.button(text="📥 Deposit", callback_data="deposit")
+           adjust.append(2)
 
-       builder.button(text="◀️", callback_data="prev")
-       builder.button(text="▶️", callback_data="next")
+       builder.adjust(*adjust)
 
-       builder.adjust(3)
+    @router.message(...)
+    async def handler(message: Message):
+        await message.answer("Buttons:", reply_markup=admin_markup(True))

docs/source/plugins/keyboards.rst

@@ -74,8 +74,11 @@ To manually attach navigation:
 
 .. code-block:: python
 
+   builder = InlineKeyboardBuilder()
    navigation = paginator.build_navigation()
+
    builder.attach(builder.from_markup(navigation))
+   builder.button(text="Back", callback_data="menu")
 
 ---------
 

docs/source/plugins/pagination.rst

@@ -49,7 +49,7 @@ Use Telegram commands to manage roles:
 
 To manage roles, you must already have one of the following:
 
-- `developer`
+- `developer` (defined in ``Raito(developers=[...]``)
 - `owner`
 - `administrator`
 
@@ -113,8 +113,81 @@ Access control is enforced on ``assign`` / ``revoke``:
 - Only trusted roles can assign
 - You can't assign or revoke your own role
 
+.. code-block:: python
+
+    from aiogram import Router, filters, types
+
+    from raito import Raito, rt
+    from raito.plugins.roles import ADMINISTRATOR, DEVELOPER, OWNER
+
+    router = Router(name="tester")
+
+
+    @router.message(filters.Command("give_tester"), DEVELOPER | OWNER | ADMINISTRATOR)
+    @rt.params(user_id=int)
+    async def give_tester(message: types.Message, raito: Raito, user_id: int) -> None:
+        if not message.from_user or not message.bot:
+            return
+
+        await raito.role_manager.assign_role(message.bot.id, message.from_user.id, user_id, "tester")
+        await message.answer(
+            text=f"User with ID <code>{user_id}</code> is now a tester!",
+            parse_mode="HTML",
+        )
+
+
+    @router.message(filters.Command("testers"), DEVELOPER | OWNER | ADMINISTRATOR)
+    async def testers(message: types.Message, raito: Raito) -> None:
+        if not message.from_user or not message.bot:
+            return
+
+        testers = await raito.role_manager.get_users(message.bot.id, "tester")
+        user_ids = [str(user_id) for user_id in testers]
+        await message.answer(text="🧪 Testers: " + ", ".join(user_ids))
+
+
 -----
 
+Available Roles
+~~~~~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 70
+
+   * - Role
+     - Slug
+     - Description
+   * - 🖥️ Developer
+     - developer
+     - Has full access to all internal features, including debug tools and unsafe operations.
+   * - 👑 Owner
+     - owner
+     - Top-level administrator with permissions to manage administrators and global settings.
+   * - 💼 Administrator
+     - administrator
+     - Can manage users, moderate content, and configure most system settings.
+   * - 🛡️ Moderator
+     - moderator
+     - Can moderate user activity, issue warnings, and enforce rules within their scope.
+   * - 📊 Manager
+     - manager
+     - Oversees non-technical operations like campaigns, tasks, or content planning.
+   * - ❤️ Sponsor
+     - sponsor
+     - Supporter of the project. Usually does not have administrative privileges.
+   * - 👤 Guest
+     - guest
+     - Has temporary access to specific internal features (e.g., analytics). Typically invited users.
+   * - 💬 Support
+     - support
+     - Handles user support requests and assists with onboarding or issues.
+   * - 🧪 Tester
+     - tester
+     - Helps test new features and provide feedback. May have access to experimental tools.
+
+------
+
 Custom Roles
 ~~~~~~~~~~~~
 

docs/source/plugins/roles.rst

@@ -51,3 +51,11 @@ What's happening here?
        await message.answer("Pong! 🏓")
 
 📦 Not installed yet? See :doc:`installation`
+
+-----
+
+Also, Raito has a built-in commands. Send ``.rt help`` to your bot to see the list.
+
+.. image:: /_static/help-command.png
+   :alt: Raito Help Command Example
+   :align: left

docs/source/quick_start.rst

@@ -7,3 +7,4 @@ Utils
     suppress_not_modified
     logging
     retry
+    truncate

docs/source/utils/index.rst

@@ -0,0 +1,10 @@
+✂️ truncate
+=============================
+
+Truncates a string to a given length.
+
+.. code-block:: python
+
+   from raito.utils.helpers.truncate import truncate
+
+   truncate("Hello, world!", 8)  # Returns "Hello..."

docs/source/utils/truncate.rst

@@ -17,11 +17,7 @@ async def lifespan(raito: Raito, bot: Bot, dispatcher: Dispatcher) -> AsyncGener
 
     yield
 
-    rt.debug("Removing webhook...")
-    await bot.delete_webhook()
-
-    rt.log.debug("Closing dispatcher storages...")
+    rt.log.debug("Closing dispatcher storage...")
     await dispatcher.storage.close()
-    await dispatcher.fsm.storage.close()
 
     rt.log.info("👋 Bye!")

examples/02-lifespan/handlers/lifespan.py

@@ -17,11 +17,7 @@ async def lifespan(raito: Raito, bot: Bot, dispatcher: Dispatcher) -> AsyncGener
 
     yield
 
-    rt.debug("Removing webhook...")
-    await bot.delete_webhook()
-
-    rt.log.debug("Closing dispatcher storages...")
+    rt.log.debug("Closing dispatcher storage...")
     await dispatcher.storage.close()
-    await dispatcher.fsm.storage.close()
 
     rt.log.info("👋 Bye!")

examples/03-commands/handlers/events/lifespan.py

@@ -2,7 +2,7 @@
 from aiogram.types import Message
 
 from raito import rt
-from raito.plugins.roles.roles import DEVELOPER
+from raito.plugins.roles import DEVELOPER
 
 router = Router(name="eval")