kurigram-addons 0.1.0__tar.gz

kurigram_addons-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 PyMaster
+
+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.

kurigram_addons-0.1.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: kurigram-addons
+Version: 0.1.0
+Summary: This package brings together several addons to kurigram including pykeyboard and FSM
+License: MIT
+Author: Johnnie
+Author-email: 99084912+johnnie-610@users.noreply.github.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: kurigram (>=2.1.35,<3.0.0)
+Description-Content-Type: text/markdown
+
+<img align=center src=./logo.png length=80 width = 400>
+
+
+> This library is a collection of popular Addons and patches for pyrogram/Kurigram.
+> Currently, Pykeyboard and Pyrogram-patch have been added. You're welcome to add more.
+
+# Installation
+
+```shell
+pip install kurigram-addons
+```
+
+# Usage
+
+Please refer to specific readme.md for each addon.
+

kurigram_addons-0.1.0/README.md

@@ -0,0 +1,15 @@
+<img align=center src=./logo.png length=80 width = 400>
+
+
+> This library is a collection of popular Addons and patches for pyrogram/Kurigram.
+> Currently, Pykeyboard and Pyrogram-patch have been added. You're welcome to add more.
+
+# Installation
+
+```shell
+pip install kurigram-addons
+```
+
+# Usage
+
+Please refer to specific readme.md for each addon.

kurigram_addons-0.1.0/pykeyboard/README.md

@@ -0,0 +1,308 @@
+<div align="center">
+<p align="center">
+<img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/logo.png" alt="pykeyboard">
+</p>
+
+<p><h2>🎉This is pykeyboard for <a href="https://pypi.org/project/Kurigram/"</a>Kuigram 🎉</h2></p>
+ <br>
+ <p><strong><em>No need to change your code, just install the library and you're good to go.</em></strong></p>
+
+</div>
+
+# Pykeyboard
+
+- [Pykeyboard](#pykeyboard)
+- [What&#39;s new?](#whats-new)
+- [Installation](#installation)
+- [Documentation](#documentation)
+  - [Inline Keyboard](#inline-keyboard)
+    - [Parameters:](#parameters)
+    - [Inline Keyboard add buttons](#inline-keyboard-add-buttons)
+      - [Code](#code)
+      - [Result](#result)
+    - [Inline Keyboard row buttons](#inline-keyboard-row-buttons)
+      - [Code](#code-1)
+      - [Result](#result-1)
+    - [Pagination inline keyboard](#pagination-inline-keyboard)
+      - [Parameters:](#parameters-1)
+      - [Pagination 3 pages](#pagination-3-pages)
+      - [Code](#code-2)
+      - [Result](#result-2)
+      - [Pagination 5 pages](#pagination-5-pages)
+      - [Code](#code-3)
+      - [Result](#result-3)
+      - [Pagination 9 pages](#pagination-9-pages)
+      - [Code](#code-4)
+      - [Result](#result-4)
+      - [Pagination 100 pages](#pagination-100-pages)
+      - [Code](#code-5)
+      - [Result](#result-5)
+      - [Pagination 150 pages and buttons](#pagination-150-pages-and-buttons)
+      - [Code](#code-6)
+      - [Result](#result-6)
+    - [Languages inline keyboard](#languages-inline-keyboard)
+      - [Parameters:](#parameters-2)
+      - [Code](#code-7)
+      - [Result](#result-7)
+  - [Reply Keyboard](#reply-keyboard)
+    - [Parameters:](#parameters-3)
+    - [Reply Keyboard add buttons](#reply-keyboard-add-buttons)
+      - [Code](#code-8)
+      - [Result](#result-8)
+    - [Reply Keyboard row buttons](#reply-keyboard-row-buttons)
+      - [Code](#code-9)
+      - [Result](#result-9)
+
+# What's new?
+
+- Minor changes due to update in Kurigram.
+
+# Documentation
+
+## Inline Keyboard
+
+```python
+from pykeyboard import InlineKeyboard
+```
+
+##### Parameters:
+
+- row_width (integer, default 3)
+
+### Inline Keyboard add buttons
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard, InlineButton
+
+
+keyboard = InlineKeyboard(row_width=3)
+keyboard.add(
+    InlineButton('1', 'inline_keyboard:1'),
+    InlineButton('2', 'inline_keyboard:2'),
+    InlineButton('3', 'inline_keyboard:3'),
+    InlineButton('4', 'inline_keyboard:4'),
+    InlineButton('5', 'inline_keyboard:5'),
+    InlineButton('6', 'inline_keyboard:6'),
+    InlineButton('7', 'inline_keyboard:7')
+)
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/add_inline_button.png" alt="add_inline_button"></p>
+
+### Inline Keyboard row buttons
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard, InlineButton
+
+
+keyboard = InlineKeyboard()
+keyboard.row(InlineButton('1', 'inline_keyboard:1'))
+keyboard.row(
+    InlineButton('2', 'inline_keyboard:2'),
+    InlineButton('3', 'inline_keyboard:3')
+)
+keyboard.row(InlineButton('4', 'inline_keyboard:4'))
+keyboard.row(
+    InlineButton('5', 'inline_keyboard:5'),
+    InlineButton('6', 'inline_keyboard:6')
+)
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/row_inline_button.png" alt="row_inline_button"></p>
+
+### Pagination inline keyboard
+
+```python
+from pykeyboard import InlineKeyboard
+```
+
+#### Parameters:
+
+- count_pages (integer)
+- current_page (integer)
+- callback_pattern (string) - use of the `{number}` pattern is `<ins>`required`</ins>`
+
+#### Pagination 3 pages
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard
+
+keyboard = InlineKeyboard()
+keyboard.paginate(3, 3, 'pagination_keyboard:{number}')
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/pagination_keyboard_3.png" alt="pagination_keyboard_3"></p>
+
+#### Pagination 5 pages
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard
+
+keyboard = InlineKeyboard()
+keyboard.paginate(5, 3, 'pagination_keyboard:{number}')
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/pagination_keyboard_5.png" alt="pagination_keyboard_5"></p>
+
+#### Pagination 9 pages
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard
+
+keyboard = InlineKeyboard()
+keyboard.paginate(9, 5, 'pagination_keyboard:{number}')
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/pagination_keyboard_9.png" alt="pagination_keyboard_9"></p>
+
+#### Pagination 100 pages
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard
+
+keyboard = InlineKeyboard()
+keyboard.paginate(100, 100, 'pagination_keyboard:{number}')
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/pagination_keyboard_100.png" alt="pagination_keyboard_100"></p>
+
+#### Pagination 150 pages and buttons
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard, InlineButton
+
+keyboard = InlineKeyboard()
+keyboard.paginate(150, 123, 'pagination_keyboard:{number}')
+keyboard.row(
+    InlineButton('Back', 'pagination_keyboard:back'),
+    InlineButton('Close', 'pagination_keyboard:close')
+)
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/pagination_keyboard_150.png" alt="pagination_keyboard_150"></p>
+
+### Languages inline keyboard
+
+```python
+from pykeyboard import InlineKeyboard
+```
+
+#### Parameters:
+
+- callback_pattern (string) - use of the `{locale}` pattern is `<ins>`required`</ins>`
+- locales (string | list) - list of language codes
+  - be_BY - Belarusian
+  - de_DE - German
+  - zh_CN - Chinese
+  - en_US - English
+  - fr_FR - French
+  - id_ID - Indonesian
+  - it_IT - Italian
+  - ko_KR - Korean
+  - tr_TR - Turkish
+  - ru_RU - Russian
+  - es_ES - Spanish
+  - uk_UA - Ukrainian
+  - uz_UZ - Uzbek
+- row_width (integer, default 2)
+
+#### Code
+
+```python
+from pykeyboard import InlineKeyboard
+
+
+keyboard = InlineKeyboard(row_width=3)
+keyboard.languages(
+    'languages:{locale}', ['en_US', 'ru_RU', 'id_ID'], 2
+)
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/languages_keyboard.png" alt="languages_keyboard"></p>
+
+## Reply Keyboard
+
+```python
+from pykeyboard import ReplyKeyboard
+```
+
+#### Parameters:
+
+- resize_keyboard (bool, optional)
+- one_time_keyboard (bool, optional)
+- selective (bool, optional)
+- row_width (integer, default 3)
+
+### Reply Keyboard add buttons
+
+#### Code
+
+```python
+from pykeyboard import ReplyKeyboard, ReplyButton
+
+
+keyboard = ReplyKeyboard(row_width=3)
+keyboard.add(
+    ReplyButton('Reply button 1'),
+    ReplyButton('Reply button 2'),
+    ReplyButton('Reply button 3'),
+    ReplyButton('Reply button 4'),
+    ReplyButton('Reply button 5')
+)
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/add_reply_button.png" alt="add_reply_button"></p>
+
+### Reply Keyboard row buttons
+
+#### Code
+
+```python
+from pykeyboard import ReplyKeyboard, ReplyButton
+
+
+keyboard = ReplyKeyboard()
+keyboard.row(ReplyButton('Reply button 1'))
+keyboard.row(
+    ReplyButton('Reply button 2'),
+    ReplyButton('Reply button 3')
+)
+keyboard.row(ReplyButton('Reply button 4'))
+keyboard.row(ReplyButton('Reply button 5'))
+```
+
+#### Result
+
+<p><img src="https://raw.githubusercontent.com/johnnie-610/pykeyboard/main/docs/source/images/row_reply_button.png" alt="row_reply_button"></p>

kurigram_addons-0.1.0/pykeyboard/__init__.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2025 Johnnie
+#
+# This software is released under the MIT License.
+# https://opensource.org/licenses/MIT
+
+from .keyboard_base import Button, InlineButton
+from .inline_keyboard import InlineKeyboard
+from .reply_keyboard import ReplyKeyboard, ReplyButton, ReplyKeyboardRemove, ForceReply
+
+__version__ = "0.1.2"
+__all__ = [
+    "Button",
+    "InlineButton",
+    "InlineKeyboard",
+    "ReplyKeyboard",
+    "ReplyButton",
+    "ReplyKeyboardRemove",
+    "ForceReply",
+]
+
+__author__ = "Johnnie"

kurigram_addons-0.1.0/pykeyboard/inline_keyboard.py

@@ -0,0 +1,187 @@
+# Copyright (c) 2025 Johnnie
+#
+# This software is released under the MIT License.
+# https://opensource.org/licenses/MIT
+
+from pyrogram.emoji import *
+from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton
+from dataclasses import dataclass
+from .keyboard_base import KeyboardBase, InlineButton
+from functools import lru_cache
+
+
+@dataclass
+class InlineKeyboard(InlineKeyboardMarkup, KeyboardBase):
+    _PAGINATION_SYMBOLS = {
+        "first": "« {}",
+        "prev": "‹ {}",
+        "current": "· {} ·",
+        "next": "{} ›",
+        "last": "{} »",
+    }
+
+    _LOCALES: dict[str, str] = {
+        "be_BY": f"{FLAG_BELARUS} Беларуская",  # Belarusian - Belarus
+        "de_DE": f"{FLAG_GERMANY} Deutsch",  # German - Germany
+        "zh_CN": f"{FLAG_CHINA} 中文",  # Chinese - China
+        # English - United States
+        "en_US": f"{FLAG_UNITED_KINGDOM}  English",
+        "fr_FR": f"{FLAG_FRANCE} Français",  # French - France
+        # Indonesian - Indonesia
+        "id_ID": f"{FLAG_INDONESIA} Bahasa Indonesia",
+        "it_IT": f"{FLAG_ITALY} Italiano",  # Italian - Italy
+        "ko_KR": f"{FLAG_SOUTH_KOREA} 한국어",  # Korean - Korea
+        "tr_TR": f"{FLAG_TURKEY} Türkçe",  # Turkish - Turkey
+        "ru_RU": f"{FLAG_RUSSIA} Русский",  # Russian - Russia
+        "es_ES": f"{FLAG_SPAIN} Español",  # Spanish - Spain
+        "uk_UA": f"{FLAG_UKRAINE} Українська",  # Ukrainian - Ukraine
+        "uz_UZ": f"{FLAG_UZBEKISTAN} Oʻzbekcha",  # Uzbek - Uzbekistan
+    }
+
+    def __post_init__(self):
+        super().__init__(inline_keyboard=self.keyboard)
+
+    @lru_cache(maxsize=128)
+    def _create_button(
+        self, text: str, callback_data: str | int
+    ) -> InlineKeyboardButton:
+        """Create cached button to avoid recreation of identical buttons."""
+        return InlineButton(
+            text=text, callback_data=self.callback_pattern.format(number=callback_data)
+        )
+
+    def paginate(
+        self, count_pages: int, current_page: int, callback_pattern: str
+    ) -> None:
+        """Optimized pagination with better edge case handling.
+
+        Args:
+            count_pages (int): Total number of pages.
+            current_page (int): The page number currently being viewed.
+            callback_pattern (str): The pattern used for callback data.
+
+        Example:
+            >>> keyboard = InlineKeyboard()
+            >>> keyboard.paginate(10, 1, 'page_{number}')
+            >>> print(keyboard.keyboard)
+            [[InlineKeyboardButton(text='· 1 ·', callback_data='page_1'), ...]]
+
+        """
+        self.count_pages = max(1, count_pages)
+        self.current_page = max(1, min(current_page, self.count_pages))
+        self.callback_pattern = callback_pattern
+
+        if self.count_pages <= 5:
+            pagination = self._build_small_pagination()
+        else:
+            pagination = self._build_large_pagination()
+
+        self.keyboard.append(pagination)
+
+    def _build_small_pagination(self) -> list[InlineKeyboardButton]:
+        return [
+            self._create_button(
+                (
+                    self._PAGINATION_SYMBOLS["current"].format(i)
+                    if i == self.current_page
+                    else str(i)
+                ),
+                i,
+            )
+            for i in range(1, self.count_pages + 1)
+        ]
+
+    def _build_large_pagination(self) -> list[InlineKeyboardButton]:
+        if self.current_page <= 3:
+            return self._build_left_pagination()
+        elif self.current_page > self.count_pages - 3:
+            return self._build_right_pagination()
+        return self._build_middle_pagination()
+
+    def _build_left_pagination(self) -> list[InlineKeyboardButton]:
+        buttons = []
+        for i in range(1, 6):
+            if i == self.current_page:
+                text = self._PAGINATION_SYMBOLS["current"].format(i)
+            elif i == 4:
+                text = self._PAGINATION_SYMBOLS["next"].format(i)
+            elif i == 5:
+                text = self._PAGINATION_SYMBOLS["last"].format(self.count_pages)
+                i = self.count_pages
+            else:
+                text = str(i)
+            buttons.append(self._create_button(text, i))
+        return buttons
+
+    def _build_middle_pagination(self) -> list[InlineKeyboardButton]:
+        return [
+            self._create_button(self._PAGINATION_SYMBOLS["first"].format(1), 1),
+            self._create_button(
+                self._PAGINATION_SYMBOLS["prev"].format(self.current_page - 1),
+                self.current_page - 1,
+            ),
+            self._create_button(
+                self._PAGINATION_SYMBOLS["current"].format(self.current_page),
+                self.current_page,
+            ),
+            self._create_button(
+                self._PAGINATION_SYMBOLS["next"].format(self.current_page + 1),
+                self.current_page + 1,
+            ),
+            self._create_button(
+                self._PAGINATION_SYMBOLS["last"].format(self.count_pages),
+                self.count_pages,
+            ),
+        ]
+
+    def _build_right_pagination(self) -> list[InlineKeyboardButton]:
+        buttons = [
+            self._create_button(self._PAGINATION_SYMBOLS["first"].format(1), 1),
+            self._create_button(
+                self._PAGINATION_SYMBOLS["prev"].format(self.count_pages - 3),
+                self.count_pages - 3,
+            ),
+        ]
+
+        for i in range(self.count_pages - 2, self.count_pages + 1):
+            text = (
+                self._PAGINATION_SYMBOLS["current"].format(i)
+                if i == self.current_page
+                else str(i)
+            )
+            buttons.append(self._create_button(text, i))
+
+        return buttons
+
+    def languages(
+        self, callback_pattern: str, locales: str | list[str], row_width: int = 2
+    ) -> None:
+        """Optimized language selection keyboard.
+
+        Args:
+            callback_pattern (str): The pattern used for callback data.
+            locales (str | list[str]): One or more locales to be used in the keyboard.
+            row_width (int, optional): The number of buttons per row. Defaults to 2.
+
+        Example:
+            >>> keyboard = InlineKeyboard()
+            >>> keyboard.languages('lang_{locale}', ['en_US', 'ru_RU', 'uk_UA'])
+            >>> print(keyboard.keyboard)
+            [[InlineKeyboardButton(text='English', callback_data='lang_en_US'), InlineKeyboardButton(text='Русский', callback_data='lang_ru_RU')], [InlineKeyboardButton(text='Українська', callback_data='lang_uk_UA')]]
+
+        """
+        if isinstance(locales, str):
+            locales = [locales]
+
+        buttons = [
+            InlineButton(
+                text=self._LOCALES.get(locale, "Invalid locale"),
+                callback_data=callback_pattern.format(locale=locale),
+            )
+            for locale in locales
+            if locale in self._LOCALES
+        ]
+
+        self.keyboard = [
+            buttons[i : i + row_width] for i in range(0, len(buttons), row_width)
+        ]

kurigram_addons-0.1.0/pykeyboard/keyboard_base.py

@@ -0,0 +1,64 @@
+# Copyright (c) 2025 Johnnie
+#
+# This software is released under the MIT License.
+# https://opensource.org/licenses/MIT
+
+from dataclasses import dataclass, field
+from pyrogram.types import InlineKeyboardButton, WebAppInfo, CallbackGame, LoginUrl
+
+
+@dataclass
+class KeyboardBase:
+    row_width: int = 3
+    keyboard: list[list] = field(default_factory=list)
+
+    def add(self, *args: object) -> None:
+        self.keyboard = [
+            list(args[i : i + self.row_width])
+            for i in range(0, len(args), self.row_width)
+        ]
+
+    def row(self, *args: object) -> None:
+        self.keyboard.append(list(args))
+
+
+@dataclass
+class Button:
+
+    text: str
+
+    def __post_init__(self):
+        if not isinstance(self.text, str):
+            raise ValueError("Button text must be a string")
+
+
+@dataclass
+class InlineButton(InlineKeyboardButton, Button):
+    callback_data: str | bytes | None = None
+    url: str | None = None
+    web_app: WebAppInfo | None = None
+    login_url: LoginUrl | None = None
+    user_id: int | None = None
+    switch_inline_query: str | None = None
+    switch_inline_query_current_chat: str | None = None
+    callback_game: CallbackGame | None = None
+    requires_password: bool | None = None
+    pay: bool | None = None
+    copy_text: str | None = None
+
+    def __post_init__(self):
+        super().__post_init__()
+        super(InlineKeyboardButton, self).__init__(
+            text=self.text,
+            callback_data=self.callback_data,
+            url=self.url,
+            web_app=self.web_app,
+            login_url=self.login_url,
+            user_id=self.user_id,
+            switch_inline_query=self.switch_inline_query,
+            switch_inline_query_current_chat=self.switch_inline_query_current_chat,
+            callback_game=self.callback_game,
+            requires_password=self.requires_password,
+            pay=self.pay,
+            copy_text=self.copy_text,
+        )