https://github.com/z44d/tgram
A developer-friendly Telegram Bot API library designed for Python enthusiasts.
https://github.com/z44d/tgram
bot-api client http-client python telegram telegram-api telegram-bot telegram-bot-api telegram-bots
Last synced: 29 days ago
JSON representation
A developer-friendly Telegram Bot API library designed for Python enthusiasts.
- Host: GitHub
- URL: https://github.com/z44d/tgram
- Owner: z44d
- License: mit
- Archived: true
- Created: 2024-06-14T21:05:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-10T09:55:18.000Z (about 1 month ago)
- Last Synced: 2026-01-11T03:11:41.695Z (about 1 month ago)
- Topics: bot-api, client, http-client, python, telegram, telegram-api, telegram-bot, telegram-bot-api, telegram-bots
- Language: Python
- Homepage: https://z44d.github.io/tgram/
- Size: 5.83 MB
- Stars: 44
- Watchers: 1
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Tgram A developer-friendly Telegram Bot API library designed for Python enthusiasts.
Channel • Documentation • Examples
⚠️ NOTICE: This project is archived and no longer under maintenance. ⚠️
## 🚀 Quick Start
Here's a basic example to get started with tgram:
```python
import asyncio
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
)
asyncio.run(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)**.