Skip to main content

Easy-to-use asynchronous TDLib wrapper for Python.

Project description

Pytdbot

Version TDLib version Downloads Telegram Chat

Buy me a Cup of TON

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.

Thanks to

  • You for viewing or using this project.

  • @levlam for maintaining TDLib and for the help to create Pytdbot.

License

MIT License

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytdbot-0.10.0.dev3.tar.gz (541.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytdbot-0.10.0.dev3-py3-none-any.whl (553.3 kB view details)

Uploaded Python 3

File details

Details for the file pytdbot-0.10.0.dev3.tar.gz.

File metadata

  • Download URL: pytdbot-0.10.0.dev3.tar.gz
  • Upload date:
  • Size: 541.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pytdbot-0.10.0.dev3.tar.gz
Algorithm Hash digest
SHA256 267a860ad76a22b865cd34d605a8cfa66342c47b1ebdca6c73ebd51a01379ba6
MD5 0de6e23b4d22d2cee9acb4fe0621ad29
BLAKE2b-256 9af0b1b3ff6d2f0b7196012842d598142762150f01cabad095e351b28d91f182

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytdbot-0.10.0.dev3.tar.gz:

Publisher: publish-to-pypi.yml on pytdbot/client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytdbot-0.10.0.dev3-py3-none-any.whl.

File metadata

  • Download URL: pytdbot-0.10.0.dev3-py3-none-any.whl
  • Upload date:
  • Size: 553.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pytdbot-0.10.0.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 e2e6d48eafc0985071ff2265ac357ee6a84c826acf9f0beabd180a3cb779b25f
MD5 6268197d80da668d0e5b18d6a2e7e7d1
BLAKE2b-256 088bc9cd1ea204580642b04488f31875c7b67c79c70731a22126da2d9bbc5f64

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytdbot-0.10.0.dev3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on pytdbot/client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page