Metadata-Version: 2.1
Name: tgram
Version: 1.11.9
Summary: Very friendly BOT API library for Python developers.
License: MIT
Author: Zaid
Author-email: me@zaid.pro
Requires-Python: >=3.8
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
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: aiohttp (==3.10.2)
Description-Content-Type: text/markdown

<div align="center"> <a href="https://github.com/z44d/tgram"> <img src="https://github.com/user-attachments/assets/ad99412f-8d69-446c-bedf-5b7663f69727" alt="tgram" width="128"> </a> <h1>tgram</h1> <b>A user-friendly Telegram Bot API library for Python developers.</b> <br> <a href="https://t.me/tgbot_channel">Channel</a> • <a href="https://z44d.github.io/tgram/">Documentation</a> • <a href="https://github.com/z44d/tgram/tree/main/examples">Examples</a> </div>

<br>

<div align="center"> <a href="https://core.telegram.org/bots/api-changelog#september-6-2024"> <img src="https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram" alt="Supported Bot API version"> </a> <a href="https://pypi.org/project/tgram/"> <img src="https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37" alt="PyPI"> </a> <a href="https://pepy.tech/project/tgram"> <img src="https://static.pepy.tech/badge/tgram" alt="Downloads"> </a> <a href="https://t.me/tgbot_channel"> <img src="https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram" alt="Telegram Channel"> </a> <a href="https://t.me/tgbot_chat"> <img src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" alt="Telegram Group"> </a> </div>

## 🚀 Quick Start
Here's a basic example to get started with tgram:
```python
from tgram import TgBot, filters
from tgram.types import Message

bot = TgBot("YOUR_BOT_TOKEN")

@bot.on_message(filters.text & filters.private)
async def on_message(bot: TgBot, message: Message) -> Message:
    # Echo the incoming message
    return await message.reply_text(
        message.text,
        entities=message.entities
    )

bot.run()
```

## 📦 Features
- **Smart Plugins**: Auto-loadable plugins for modular development.
- **Filters for Handlers**: Simplify event handling with filters.
- **Bound Methods**: Access bound methods for different update types easily.

## 📚 Documentation
Full documentation is available [here](https://z44d.github.io/tgram/).

## 🔧 Installation
You can install the tgram library using one of the following methods:
### Via git:
```bash
pip install git+https://github.com/z44d/tgram -U
```
### Via PyPI (Recommended)
```bash
pip install tgram -U
```

## 💡 Requirements
- **Python**: Version 3.8 or higher.
- **Telegram Bot Token**: Obtain one by following [this guide](https://core.telegram.org/bots/tutorial#obtain-your-bot-token).

## 💬 Help & Support
- For general questions and help, join our **[Telegram chat](https://t.me/tgbot_chat)**.
- Follow updates via the **[Telegram Channel](https://t.me/tgbot_channel)**.
