Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pytdbot/client
Easy-to-use asynchronous TDLib wrapper for Python.
https://github.com/pytdbot/client
async asyncio bot bot-api library mtproto python tdlib tdlib-python telegram telegram-api telegram-bot telegram-bot-api
Last synced: about 1 month ago
JSON representation
Easy-to-use asynchronous TDLib wrapper for Python.
- Host: GitHub
- URL: https://github.com/pytdbot/client
- Owner: pytdbot
- License: mit
- Created: 2022-06-04T18:20:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T22:29:54.000Z (7 months ago)
- Last Synced: 2024-05-29T03:23:07.399Z (7 months ago)
- Topics: async, asyncio, bot, bot-api, library, mtproto, python, tdlib, tdlib-python, telegram, telegram-api, telegram-bot, telegram-bot-api
- Language: Python
- Homepage:
- Size: 165 MB
- Stars: 54
- Watchers: 3
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pytdbot [](https://pypi.org/project/Pytdbot) [](https://github.com/tdlib/td) [](https://pepy.tech/project/pytdbot)
Pytdbot (Python TDLib) is an asynchronous [**TDLib**](https://github.com/tdlib/td) wrapper for **Telegram** users/bots written in **Python**.
### Features
``Pytdbot`` offers numerous advantages, including:
- **Easy to Use**: Designed with simplicity in mind, making it accessible for developers
- **Performance**: Fast and powerful, making it ready to fight
- **Asynchronous**: Fully asynchronous that allows for non-blocking requests and improved responsiveness
- **Scalable**: Easily scalable using [TDLib Server](https://github.com/pytdbot/tdlib-server)
- **Well-typed**: Provides clear and well-defined methods and types to enhance developer experience
- **Decorator-Based Updates**: Simplifies the implementation of update handlers through a decorator pattern
- **Bound Methods**: Features types bound methods for improved usability
- **Unlimited Support**: Supports **Plugins**, [**filters**](pytdbot/filters.py#L23), [**TDLib**](https://github.com/tdlib/td) types/functions and much more
### Requirements
- Python 3.9+
- Telegram [API key](https://my.telegram.org/apps)
- [tdjson](https://github.com/tdlib/td#building)
- [deepdiff](https://github.com/seperman/deepdiff)
- [aio-pika](https://github.com/mosquito/aio-pika)
### Installation
> For better performance, it's recommended to install [orjson](https://github.com/ijl/orjson#install) or [ujson](https://github.com/ultrajson/ultrajson#ultrajson).
You can install Pytdbot using pip:
```bash
pip install pytdbot
```
To install the development version from Github, use the following command:
```bash
pip install git+https://github.com/pytdbot/client.git
```
### Examples
Basic example:
```python
import asyncio
from pytdbot import Client, types
client = Client(
token="1088394097:AAQX2DnWiw4ihwiJUhIHOGog8gGOI", # Your bot token or phone number if you want to login as user
api_id=0,
api_hash="API_HASH",
lib_path="/path/to/libtdjson.so", # Path to TDjson shared library
files_directory="BotDB", # Path where to store TDLib files
database_encryption_key="1234echobot$",
td_verbosity=2, # TDLib verbosity level
td_log=types.LogStreamFile("tdlib.log", 104857600), # Set TDLib log file path
)
@client.on_updateNewMessage()
async def print_message(c: Client, message: types.UpdateNewMessage):
print(message)
@client.on_message()
async def say_hello(c: Client, message: types.Message):
msg = await message.reply_text(f"Hey {await message.mention(parse_mode='html')}! I'm cooking up a surprise... 🍳👨🍳", parse_mode="html")
async with message.action("choose_sticker"):
await asyncio.sleep(5)
await msg.edit_text("Boo! 👻 Just kidding.")
# Run the client
client.run()
```
For more examples, check the [examples](https://github.com/pytdbot/client/tree/main/examples) folder.
# Thanks to
- You for viewing or using this project.
- [@levlam](https://github.com/levlam) for maintaining [TDLib](https://github.com/tdlib/td) and for the help to create [Pytdbot](https://github.com/pytdbot/client).
# License
MIT [License](https://github.com/pytdbot/client/blob/main/LICENSE)