This release is a pre-release and may not be stable for production use.
Pytdbot
Pytdbot is an asynchronous TDLib 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
- 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, TDLib types/functions and much more
Requirements
Installation
For better performance, it's recommended to install orjson or ujson.
You can install Pytdbot with TDLib included using pip:
pip install --upgrade pytdbot[tdjson]
If the installation fails, then install without pre-built TDLib:
pip install pytdbot
Then you need to build TDLib from source and pass it to Client.lib_path.
You could also install the development version using the following command:
pip install --pre pytdbot
Examples
Basic example:
import asyncio
import logging
from pytdbot import Client, types
logging.basicConfig(
level=logging.INFO,
format="[%(levelname)s][p %(process)d %(threadName)s][%(created)f][%(filename)s:%(lineno)d][%(funcName)s][%(name)s] %(message)s",
)
client = Client(
token="1088394097:AAQX2DnWiw4ihwiJUhIHOGog8gGOI", # Your bot token
api_id=0,
api_hash="API_HASH",
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
asyncio.run(client.run())
For more examples, check the examples folder.
Using AI agents
Pytdbot includes a skill and a local docs CLI so coding agents can use the library correctly (bound methods, helpers, TDLib types, and so on)
- Install Pytdbot
- Point your agent at the skill file:
- In this repo:
pytdbot/ai/SKILL.md - or using
curl -O "https://raw.githubusercontent.com/pytdbot/client/refs/heads/main/pytdbot/ai/SKILL.md"
- In this repo:
- Register it the way your tool expects (project skill, agent rule, or “read this file first”)
The skill explains how Pytdbot is meant to be used; the CLI returns live signatures from your installed version.
Thanks to
-
You for viewing or using this project.
-
@levlam for maintaining TDLib and for the help to create Pytdbot.
License
MIT License
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pytdbot-0.10.2.dev1.tar.gz.
File metadata
- Download URL: pytdbot-0.10.2.dev1.tar.gz
- Upload date:
- Size: 844.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7dbc523efe66b6874930ac2cb9fc3548bdcf4144f6bd931b7f4093054fd27a8b
|
|
| MD5 |
84ed7a4290a7a3b092f64acc6f676bf8
|
|
| BLAKE2b-256 |
5a190c08711a0ad70339509b29800eb61b65894a9a896631b816116af6600d08
|
Provenance
The following attestation bundles were made for pytdbot-0.10.2.dev1.tar.gz:
Publisher:
publish-to-pypi.yml on pytdbot/client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pytdbot-0.10.2.dev1.tar.gz -
Subject digest:
7dbc523efe66b6874930ac2cb9fc3548bdcf4144f6bd931b7f4093054fd27a8b - Sigstore transparency entry: 2355695018
- Sigstore integration time:
-
Permalink:
pytdbot/client@e3025b28ea357f36abdada3a0573e20a4687455a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/pytdbot
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@e3025b28ea357f36abdada3a0573e20a4687455a -
Trigger Event:
push
-
Statement type:
File details
Details for the file pytdbot-0.10.2.dev1-py3-none-any.whl.
File metadata
- Download URL: pytdbot-0.10.2.dev1-py3-none-any.whl
- Upload date:
- Size: 866.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4bc0b1eb7a64eb314258391bc2e074785450aead0f5c169a83d5e1bfad561a5
|
|
| MD5 |
063d147d0a9f077360c47d021809588b
|
|
| BLAKE2b-256 |
32775581d2828a58be9aeb88da9178bee874e41cb6ad77d3af47ba5854e2aad9
|
Provenance
The following attestation bundles were made for pytdbot-0.10.2.dev1-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on pytdbot/client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pytdbot-0.10.2.dev1-py3-none-any.whl -
Subject digest:
e4bc0b1eb7a64eb314258391bc2e074785450aead0f5c169a83d5e1bfad561a5 - Sigstore transparency entry: 2355695459
- Sigstore integration time:
-
Permalink:
pytdbot/client@e3025b28ea357f36abdada3a0573e20a4687455a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/pytdbot
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@e3025b28ea357f36abdada3a0573e20a4687455a -
Trigger Event:
push
-
Statement type:
