maxrubika 1.0.0__tar.gz

maxrubika-1.0.0/LICENSE

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

maxrubika-1.0.0/PKG-INFO

@@ -0,0 +1,519 @@
+Metadata-Version: 2.4
+Name: maxrubika
+Version: 1.0.0
+Summary: Python async library for Rubika Messenger - Build bots and userbots effortlessly.
+Home-page: https://github.com/MEH2RAB/maxrubika
+Author: MEHRAB Farahmand
+Author-email: MEH2RABx@gmail.com
+Project-URL: Documentation, https://maxrubi.ir
+Project-URL: Source, https://github.com/MEH2RAB/maxrubika
+Project-URL: Channel, https://rubika.ir/MAXRubika
+Keywords: maxrubika,rubika,bot,robot,asyncio,client
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: AsyncIO
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🤖 MAXRubika
+
+> Python async library for Rubika Messenger - Build bots and userbots effortlessly
+
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-maxrubi.ir-brightgreen.svg)](https://maxrubi.ir)
+[![GitHub stars](https://img.shields.io/github/stars/yourusername/maxrubika)](https://github.com/yourusername/maxrubika/stargazers)
+
+
+## ✨ Features
+
+- ✅ **Full Rubika Bot API** - All methods supported
+- ✅ **Async/Await** - Built with `asyncio` for maximum performance
+- ✅ **Type Hints** - Full typing support for better IDE integration
+- ✅ **Plugin System** - Easily extend your bot with plugins
+- ✅ **Middleware Support** - Intercept and process events
+- ✅ **Webhook & Polling** - Both modes supported
+- ✅ **Rich Filter System** - Powerful event filtering
+- ✅ **Decorator-based Handlers** - Clean and intuitive syntax
+- ✅ **Zero Dependencies** - Only `aiohttp` required
+- 🚧 **UserBot Support** - Coming soon! (Personal account automation)
+
+
+## 📦 Installation
+
+```bash
+pip install maxrubika
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/MEH2RAB/maxrubika.git
+cd maxrubika
+pip install -e .
+```
+
+
+## 🚀 Quick Start
+
+```python
+from maxrubika import Bot
+
+bot = Bot("TOKEN")
+
+@bot.on_command("start")
+async def start(bot, event):
+    await event.reply("سلام! به ربات خوش آمدید 👋")
+
+bot.run()
+```
+
+## 📖 Full Documentation
+
+All public methods are fully documented with **detailed docstrings** including:
+
+- **Parameters** with types and descriptions
+- **Return values** 
+- **Usage examples**
+
+To view all available methods and their documentation, run:
+
+```python
+from maxrubika import Bot
+import inspect
+
+methods = [method for method in dir(Bot) 
+           if not method.startswith('_') 
+           and callable(getattr(Bot, method))]
+
+for method in methods:
+    func = getattr(Bot, method)
+    doc = inspect.getdoc(func)
+    print(f"→ {method}:\n   {doc}\n{'-'*50}")
+```
+
+For complete documentation with examples for every method, visit **[MAXRubi.ir](https://MAXRubi.ir)**.
+
+## 📚 Basic Usage
+
+### Send a Message
+
+```python
+await bot.send_message(
+    chat_id="b0abc123...",
+    text="Hello, World! 🌍"
+)
+```
+
+### Send a File
+
+```python
+await bot.send_file(
+    chat_id="b0abc123...",
+    file="path/to/image.jpg",
+    file_type="File",
+    text="Check this out!"
+)
+```
+
+### Send a Photo
+
+```python
+await bot.send_image(
+    chat_id="b0abc123...",
+    image="photo.jpg",
+    text="Nice photo!"
+)
+```
+
+### Send a Video
+
+```python
+await bot.send_video(
+    chat_id="b0abc123...",
+    video="video.mp4",
+    text="Watch this!"
+)
+```
+
+### Send a Voice Message
+
+```python
+await bot.send_voice(
+    chat_id="b0abc123...",
+    voice="voice.mp3",
+    text="Listen to this!"
+)
+```
+
+### Send a Music File
+
+```python
+await bot.send_music(
+    chat_id="b0abc123...",
+    music="song.mp3",
+    text="Enjoy the music!"
+)
+```
+
+### Send a GIF
+
+```python
+await bot.send_gif(
+    chat_id="b0abc123...",
+    gif="animation.gif",
+    text="Funny GIF!"
+)
+```
+
+### Send a Poll
+
+```python
+await bot.send_poll(
+    chat_id="b0abc123...",
+    question="What's your favorite color?",
+    options=["Red", "Blue", "Green"]
+)
+```
+
+### Send a Quiz
+
+```python
+await bot.send_quiz(
+    chat_id="b0abc123...",
+    question="What is 2+2?",
+    options=["3", "4", "5"],
+    correct_option=1
+)
+```
+
+### Send a Location
+
+```python
+await bot.send_location(
+    chat_id="b0abc123...",
+    latitude=35.6892,
+    longitude=51.3890
+)
+```
+
+### Send a Contact
+
+```python
+await bot.send_contact(
+    chat_id="b0abc123...",
+    phone_number="+989123456789",
+    first_name="MEHRAB",
+    last_name="Farahmand"
+)
+```
+
+
+## ⌨️ Inline Keyboard
+
+```python
+inline_keypad = [
+    ["Button 1", "Button 2"],
+    ["Button 3"]
+]
+
+await bot.send_message(
+    chat_id="b0abc123...",
+    text="Choose an option:",
+    inline_keypad=inline_keypad
+)
+```
+
+
+## 📋 Custom Keyboard
+
+```python
+chat_keypad = {
+    "rows": [
+        {
+            "buttons": [
+                {"id": "101", "type": "Simple", "button_text": "Yes"},
+                {"id": "102", "type": "Simple", "button_text": "No"},
+                {"id": "104", "type": "Simple", "button_text": "Maybe"}
+            ]
+        }
+    ]
+}
+
+await bot.send_message(
+    chat_id="b0abc123...",
+    text="Do you agree?",
+    chat_keypad=chat_keypad,
+    resize_keyboard=True,
+    one_time_keyboard=True
+)
+```
+
+```python
+inline_keypad = {
+    "rows": [
+        {
+            "buttons": [
+                {"id": "101", "type": "Simple", "button_text": "📊 View Report"},
+                {"id": "102", "type": "Simple", "button_text": "📥 Download"},
+                {"id": "103", "type": "Simple", "button_text": "🔔 Set Reminder"},
+                {"id": "104", "type": "Simple", "button_text": "❌ Close"},
+            ]
+        }
+    ]
+}
+
+await bot.send_message(
+    chat_id="b0abc123...",
+    text="**What would you like to do with this document?**",
+    inline_keypad=inline_keypad
+)
+```
+
+## 🎯 Handle Callbacks
+
+```python
+@bot.on_callback()
+async def on_callback(bot, event):
+    button_id = event.button_id
+    await bot.send_message(
+        chat_id=event.chat_id,
+        text=f"You pressed: {button_id}"
+    )
+```
+
+
+## 🔧 Commands
+
+```python
+@bot.on_command("start")
+async def start_command(bot, event):
+    await bot.send_message(
+        chat_id=event.chat_id,
+        text="Welcome! 🎉"
+    )
+
+@bot.on_command(["help", "راهنما"])
+async def help_command(bot, event):
+    await event.reply("How can I help you?")
+```
+
+
+## 🔍 Using Filters
+
+```python
+from maxrubika.filters import Text, ChatType, FromUser
+
+@bot.on_message(Text("hello") & ChatType("user"))
+async def on_hello(bot, event):
+    await event.reply("Hi there! 👋")
+
+@bot.on_message(FromUser("u0abc123..."))
+async def on_specific_user(bot, event):
+    await event.reply("I see you! 👀")
+
+@bot.on_message(IsImage() & FromUser("u0abc123..."))
+async def on_image_from_user(bot, event):
+    await event.reply("Nice image!")
+```
+
+
+## 🔌 Middleware
+
+```python
+@bot.middleware()
+async def log_middleware(bot, event, call_next):
+    print(f"Event: {event.update_type} from {event.chat_id}")
+    await call_next()
+```
+
+
+## 🔌 Plugin System
+
+### Create a Plugin
+
+```python
+from maxrubika.plugin import Plugin, create_plugin
+
+@create_plugin("greeter", version="1.0.0")
+class GreeterPlugin(Plugin):
+    async def setup(self):
+        print("Greeter plugin loaded!")
+    
+    async def teardown(self):
+        print("Greeter plugin unloaded!")
+```
+
+### Enable Plugins
+
+```python
+bot = Bot("TOKEN")
+await bot.plugin_manager.enable("greeter")
+```
+
+### Plugin with Dependencies
+
+```python
+@create_plugin(
+    "advanced_greeter",
+    version="1.0.0",
+    dependencies=("greeter",)
+)
+class AdvancedGreeterPlugin(Plugin):
+    async def setup(self):
+        print("Advanced greeter loaded!")
+```
+
+
+## 🌐 Webhook Setup
+
+```python
+bot = Bot("TOKEN")
+
+# Start with webhook
+await bot.start(
+    webhook_url="https://yourdomain.com",
+    webhook_path="/wk",
+    host="0.0.0.0",
+    port=8080
+)
+```
+
+### Register Webhook Endpoints
+
+```python
+await bot.update_bot_endpoints(
+    url="https://yourdomain.com/wk",
+    endpoint_type="ReceiveUpdate"
+)
+```
+
+### Register All Endpoints
+
+```python
+await bot.register_all_endpoints(
+    base_url="https://yourdomain.com"
+)
+```
+
+
+## 🔜 Coming Soon: UserBot
+
+```python
+from maxrubika import Client
+client = Client("mySession")
+
+a = client.get_me()
+print(a)
+```
+
+
+## 📁 Project Structure
+
+```
+maxrubika/
+├── TheBot.py                 # Main Bot class
+├── TheClient.py             # UserBot class (coming soon)
+├── bot/                   # All Bot modules (unified)
+│   ├── __init__.py
+│   ├── registry.py        # Handler registry
+│   ├── bridge.py          # Bridge between MTProto and Bot API
+│   ├── lifecycle.py       # Bot lifecycle management
+│   ├── message.py         # Message handling
+│   ├── callback.py        # Callback query handling
+│   ├── command.py         # Command handling
+│   ├── middleware.py      # Middleware system
+│   ├── start.py           # Start logic
+│   ├── run.py             # Running the bot
+│   ├── plugin.py          # Plugin system
+│   ├── exceptions.py      # Error classes
+│   ├── filters.py         # Event filters
+│   ├── metadata.py        # Metadata handling
+│   ├── keypad_mixin.py    # Keypad utilities
+│   ├── file_extensions.py # File type mappings
+│   ├── send_message.py    # Send message methods
+│   ├── send_file.py
+│   ├── send_poll.py
+│   ├── send_quiz.py
+│   ├── send_location.py
+│   ├── send_contact.py
+│   ├── send_image.py
+│   ├── send_video.py
+│   └── ......
+├── types/                 # Type definitions
+│   ├── __init__.py
+│   ├── incoming.py
+│   └── update.py        # Coming soon
+├── hybrid.py              # Compatibility layer
+└── __init__.py            # Package entry point
+```
+
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our Contributing Guide.
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+## 👤 Author
+
+**MEHRAB Farahmand**
+
+## Get in Touch
+
+| Platform | Link |
+|----------|------|
+| Rubika Channel | [@MAXRubika](https://rubika.ir/MAXRubika) |
+| Rubika Profile | [@Online_User](https://rubika.ir/Online_User) |
+| Telegram | [@MEH2RAB](https://t.me/MEH2RAB) |
+| Documentation | [MAXRubi.ir](https://MAXRubi.ir) |
+| GitHub | [@MEH2RAB](https://github.com/MEH2RAB) |
+| Email | [MEH2RABx@gmail.com](mailto:MEH2RABx@gmail.com) |
+
+> 💬 If you have any questions, issues, or suggestions, feel free to reach out to me on **Rubika** ([@Online_User](https://rubika.ir/Online_User)) or **Telegram** ([@MEH2RAB](https://t.me/MEH2RAB)). I'll be happy to help!
+
+---
+
+**Special thanks to the management team of MAX Server ([@The_MAXWare](https://t.me/The_MAXWare)) for their invaluable support and contributions to this project.**
+
+## ⭐ Support
+
+If you like this project, please give it a star! ⭐
+
+
+## 🙏 Acknowledgments
+
+- Built with ❤️ for the Rubika community