telekit 0.0.1__tar.gz

telekit-0.0.1/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: telekit
+Version: 0.0.1
+Summary: This is the simplest module for making Telegram Bots.
+Home-page: https://t.me/TeleKitLib
+Author: romashka
+Author-email: comfy6011@gmail.com
+License: MIT
+Project-URL: Telegram, https://t.me/TeleKitLib
+Keywords: files speedfiles
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pyTelegramBotAPI>=4.27.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# TeleKit Library
+
+## Overview
+
+**TeleKit** is a Python library designed to simplify common tasks for developers working with Telegram bots or Python projects in general.  
+It provides tools for:  
+
+- Managing data with `Vault`, a lightweight interface for SQLite databases.  
+- Organizing and processing text data using `chapters`, which allows converting `.txt` files into Python dictionaries for easy access.  
+- Creating modular, reusable handlers and chains for structured code.  
+
+The library is designed to reduce boilerplate code and make Python development more efficient.
+
+---
+
+## Quick Guide
+
+Here is an example of defining a handler using TeleKit:
+
+```python
+import telebot.types
+import telekit
+import typing
+
+
+class StartHandler(telekit.Handler):
+
+    # ------------------------------------------
+    # Initialization
+    # ------------------------------------------
+
+    @classmethod
+    def init_handler(cls, bot: telebot.TeleBot) -> None:
+        """
+        Initializes the message handler for the '/start' command.
+        """
+        @bot.message_handler(commands=['start'])
+        def handler(message: telebot.types.Message) -> None:
+            cls(message).handle()
+
+    # ------------------------------------------
+    # Handling Logic
+    # ------------------------------------------
+
+    def handle(self) -> None:
+        chain: telekit.Chain = self.get_chain()
+         
+        chain.sender.set_title("Hello")
+        chain.sender.set_message("Welcome to the bot! Click the button below to start interacting.")
+        chain.sender.set_photo("https://static.wikia.nocookie.net/ssb-tourney/images/d/db/Bot_CG_Art.jpg/revision/latest?cb=20151224123450")
+        chain.sender.set_effect(chain.sender.Effect.PARTY)
+
+        def counter_factory() -> typing.Callable[[int], int]:
+            count = 0
+            def counter(value: int=1) -> int:
+                nonlocal count
+                count += value
+                return count
+            return counter
+        
+        click_counter = counter_factory()
+
+        @chain.inline_keyboard({"⊕": 1, "⊖": -1}, row_width=2)
+        def _(message: telebot.types.Message, value: int) -> None:
+            chain.sender.set_message(f"You clicked {click_counter(value)} times")
+            chain.edit_previous_message()
+            chain.send()
+
+        chain.send()
+```
+
+---
+
+## Chapters Example
+
+TeleKit allows you to store large texts or structured information in `.txt` files and access them as Python dictionaries:
+
+**`help.txt`**:
+
+```txt
+# intro
+Welcome to TeleKit library. Here are the available commands:
+
+# entry
+/entry — Example command for handling input
+
+# about
+TeleKit is a general-purpose library for Python projects.
+```
+
+Usage in Python:
+
+```python
+import telekit
+
+chapters: dict[str, str] = telekit.chapters.read("help.txt")
+
+print(chapters["intro"])
+# Output: "Welcome to TeleKit library. Here are the available commands:"
+
+print(chapters["entry"])
+# Output: "/entry — Example command for handling input"
+```
+
+This approach allows separating content from code and accessing text sections programmatically.
+
+---
+
+## Features
+
+- Easy-to-use modular handlers and chains for structured project code.  
+- `Vault` for persistent storage of Python data structures in SQLite.  
+- `Chapters` for converting `.txt` files into Python dictionaries.  
+- Lightweight and minimal dependencies, fully compatible with Python 3.12 and higher.
+
+---
+
+## Getting Started With Server / Main.py
+
+```python
+
+# Your server.py or main.py
+
+import telebot
+import telekit
+
+from . import handlers # All your handlers
+
+bot = telebot.TeleBot("TOKEN")
+telekit.Server(bot).polling()
+```
+
+# Getting Started With Handlers
+
+```python
+
+# handlers/start.py
+
+import telebot.types
+import telekit
+import typing
+
+
+class StartHandler(telekit.Handler):
+
+    # ------------------------------------------
+    # Initialization
+    # ------------------------------------------
+
+    @classmethod
+    def init_handler(cls, bot: telebot.TeleBot) -> None:
+        """
+        Initializes the message handler for the '/start' command.
+        """
+        @bot.message_handler(commands=['start'])
+        def handler(message: telebot.types.Message) -> None:
+            cls(message).handle()
+
+    # ------------------------------------------
+    # Handling Logic
+    # ------------------------------------------
+
+    def handle(self) -> None:
+        chain: telekit.Chain = self.get_chain()
+         
+        chain.sender.set_title("Hello")
+        chain.sender.set_message("Welcome to the bot! Click the button below to start interacting.")
+        chain.sender.set_photo("https://static.wikia.nocookie.net/ssb-tourney/images/d/db/Bot_CG_Art.jpg/revision/latest?cb=20151224123450")
+        chain.sender.set_effect(chain.sender.Effect.PARTY)
+
+        def counter_factory() -> typing.Callable[[int], int]:
+            count = 0
+            def counter(value: int=1) -> int:
+                nonlocal count
+                count += value
+                return count
+            return counter
+        
+        click_counter = counter_factory()
+
+        @chain.inline_keyboard({"⊕": 1, "⊖": -1}, row_width=2)
+        def _(message: telebot.types.Message, value: int) -> None:
+            chain.sender.set_message(f"You clicked {click_counter(value)} times")
+            chain.edit_previous_message()
+            chain.send()
+
+        chain.send()
+```
+
+## Developer ##
+Telegram: [@TeleKitLib](https://t.me/TeleKitLib) 

telekit-0.0.1/README.md

@@ -0,0 +1,191 @@
+# TeleKit Library
+
+## Overview
+
+**TeleKit** is a Python library designed to simplify common tasks for developers working with Telegram bots or Python projects in general.  
+It provides tools for:  
+
+- Managing data with `Vault`, a lightweight interface for SQLite databases.  
+- Organizing and processing text data using `chapters`, which allows converting `.txt` files into Python dictionaries for easy access.  
+- Creating modular, reusable handlers and chains for structured code.  
+
+The library is designed to reduce boilerplate code and make Python development more efficient.
+
+---
+
+## Quick Guide
+
+Here is an example of defining a handler using TeleKit:
+
+```python
+import telebot.types
+import telekit
+import typing
+
+
+class StartHandler(telekit.Handler):
+
+    # ------------------------------------------
+    # Initialization
+    # ------------------------------------------
+
+    @classmethod
+    def init_handler(cls, bot: telebot.TeleBot) -> None:
+        """
+        Initializes the message handler for the '/start' command.
+        """
+        @bot.message_handler(commands=['start'])
+        def handler(message: telebot.types.Message) -> None:
+            cls(message).handle()
+
+    # ------------------------------------------
+    # Handling Logic
+    # ------------------------------------------
+
+    def handle(self) -> None:
+        chain: telekit.Chain = self.get_chain()
+         
+        chain.sender.set_title("Hello")
+        chain.sender.set_message("Welcome to the bot! Click the button below to start interacting.")
+        chain.sender.set_photo("https://static.wikia.nocookie.net/ssb-tourney/images/d/db/Bot_CG_Art.jpg/revision/latest?cb=20151224123450")
+        chain.sender.set_effect(chain.sender.Effect.PARTY)
+
+        def counter_factory() -> typing.Callable[[int], int]:
+            count = 0
+            def counter(value: int=1) -> int:
+                nonlocal count
+                count += value
+                return count
+            return counter
+        
+        click_counter = counter_factory()
+
+        @chain.inline_keyboard({"⊕": 1, "⊖": -1}, row_width=2)
+        def _(message: telebot.types.Message, value: int) -> None:
+            chain.sender.set_message(f"You clicked {click_counter(value)} times")
+            chain.edit_previous_message()
+            chain.send()
+
+        chain.send()
+```
+
+---
+
+## Chapters Example
+
+TeleKit allows you to store large texts or structured information in `.txt` files and access them as Python dictionaries:
+
+**`help.txt`**:
+
+```txt
+# intro
+Welcome to TeleKit library. Here are the available commands:
+
+# entry
+/entry — Example command for handling input
+
+# about
+TeleKit is a general-purpose library for Python projects.
+```
+
+Usage in Python:
+
+```python
+import telekit
+
+chapters: dict[str, str] = telekit.chapters.read("help.txt")
+
+print(chapters["intro"])
+# Output: "Welcome to TeleKit library. Here are the available commands:"
+
+print(chapters["entry"])
+# Output: "/entry — Example command for handling input"
+```
+
+This approach allows separating content from code and accessing text sections programmatically.
+
+---
+
+## Features
+
+- Easy-to-use modular handlers and chains for structured project code.  
+- `Vault` for persistent storage of Python data structures in SQLite.  
+- `Chapters` for converting `.txt` files into Python dictionaries.  
+- Lightweight and minimal dependencies, fully compatible with Python 3.12 and higher.
+
+---
+
+## Getting Started With Server / Main.py
+
+```python
+
+# Your server.py or main.py
+
+import telebot
+import telekit
+
+from . import handlers # All your handlers
+
+bot = telebot.TeleBot("TOKEN")
+telekit.Server(bot).polling()
+```
+
+# Getting Started With Handlers
+
+```python
+
+# handlers/start.py
+
+import telebot.types
+import telekit
+import typing
+
+
+class StartHandler(telekit.Handler):
+
+    # ------------------------------------------
+    # Initialization
+    # ------------------------------------------
+
+    @classmethod
+    def init_handler(cls, bot: telebot.TeleBot) -> None:
+        """
+        Initializes the message handler for the '/start' command.
+        """
+        @bot.message_handler(commands=['start'])
+        def handler(message: telebot.types.Message) -> None:
+            cls(message).handle()
+
+    # ------------------------------------------
+    # Handling Logic
+    # ------------------------------------------
+
+    def handle(self) -> None:
+        chain: telekit.Chain = self.get_chain()
+         
+        chain.sender.set_title("Hello")
+        chain.sender.set_message("Welcome to the bot! Click the button below to start interacting.")
+        chain.sender.set_photo("https://static.wikia.nocookie.net/ssb-tourney/images/d/db/Bot_CG_Art.jpg/revision/latest?cb=20151224123450")
+        chain.sender.set_effect(chain.sender.Effect.PARTY)
+
+        def counter_factory() -> typing.Callable[[int], int]:
+            count = 0
+            def counter(value: int=1) -> int:
+                nonlocal count
+                count += value
+                return count
+            return counter
+        
+        click_counter = counter_factory()
+
+        @chain.inline_keyboard({"⊕": 1, "⊖": -1}, row_width=2)
+        def _(message: telebot.types.Message, value: int) -> None:
+            chain.sender.set_message(f"You clicked {click_counter(value)} times")
+            chain.edit_previous_message()
+            chain.send()
+
+        chain.send()
+```
+
+## Developer ##
+Telegram: [@TeleKitLib](https://t.me/TeleKitLib) 

telekit-0.0.1/setup.cfg

@@ -0,0 +1,7 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+
+[metadata]
+license = MIT
+

telekit-0.0.1/setup.py

@@ -0,0 +1,28 @@
+from setuptools import setup, find_packages
+
+def readme():
+  with open('README.md', 'r') as f:
+    return f.read()
+
+setup(
+    name='telekit',
+    version='0.0.1',
+    author='romashka',
+    author_email='comfy6011@gmail.com',
+    description='This is the simplest module for making Telegram Bots.',
+    long_description=readme(),
+    long_description_content_type='text/markdown',
+    url='https://t.me/TeleKitLib',
+    packages=find_packages(),
+    install_requires=['pyTelegramBotAPI>=4.27.0'],
+    classifiers=[
+        'Programming Language :: Python :: 3.11',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent'
+    ],
+    keywords='files speedfiles ',
+    project_urls={
+        "Telegram": "https://t.me/TeleKitLib"
+    },
+    python_requires='>=3.12'
+)

telekit-0.0.1/telekit/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2025 Ving Studio, Romashka
+# Licensed under the MIT License. See LICENSE file for full terms.
+
+# engine/__init__.py
+from .handler import Handler
+from .chain import Chain
+from .callback_query_handler import CallbackQueryHandler
+from .server import Server, example
+from .snapvault.snapvault import Vault # type: ignore
+from .chapters import chapters
+from .user import User
+from . import senders
+
+__all__ = ["senders", "Chain", "Handler", "CallbackQueryHandler", "Server", "Vault", "User", "chapters", "example"]

telekit-0.0.1/telekit/callback_query_handler.py

@@ -0,0 +1,58 @@
+from typing import Any
+
+import telebot # type: ignore
+from telebot.types import ( # type: ignore
+    Message, 
+    InaccessibleMessage,
+    CallbackQuery
+)
+
+
+class CallbackQueryHandler:
+
+    bot: telebot.TeleBot
+    
+    @classmethod
+    def init(cls, bot: telebot.TeleBot):
+        """
+        Initializes the bot instance for the class.
+
+        Args:
+            bot (TeleBot): The Telegram bot instance to be used for sending messages.
+        """
+        cls.bot = bot
+
+        @bot.callback_query_handler(func=lambda call: True) # type: ignore
+        def handle_callback(call: telebot.types.CallbackQuery) -> None: # type: ignore
+            CallbackQueryHandler().handle(call)
+
+    def handle(self, call: CallbackQuery):
+        self._simulate(call.message, str(call.data), from_user=call.from_user)
+
+    def _simulate(self, message: Message | InaccessibleMessage, text: str, from_user: Any=None) -> None:
+        args = {}
+
+        is_bot: bool = getattr(getattr(message, "from_user", from_user), "is_bot", False)
+
+        args["message_id"]  = getattr(message, "message_id", None)
+        args["from_user"]   = from_user if from_user else getattr(message, "from_user", None)
+        args["date"]        = getattr(message, "date", None)
+        args["chat"]        = getattr(message, "chat", None)
+        args["json_string"] = getattr(message, "json", None)
+
+        args["content_type"] = "text"
+        args["options"]      = {}
+
+        if any(value is None for value in args.values()): # type: ignore
+            return print("Error: Missing required fields in message simulation.")
+        
+        original_message = message
+
+        message = Message(**args) # type: ignore
+        message.message_thread_id = getattr(original_message, "message_thread_id", None)
+        message.text = text
+
+        if message.from_user:
+            message.from_user.is_bot = is_bot
+
+        self.bot.process_new_messages([message]) # type: ignore