python-telegram-client

Python library to help you build your own Telegram clients


License
MIT
Install
pip install python-telegram-client==0.17.0.post0

Documentation

python-telegram-client

Build Status PyPI DockerHub Read the Docs (version)

This is a fork of alexander-akhmetov/python-telegram. The root package is renamed from "telegram" to "teleclient" to avoid name conflict with python-telegram-bot.

Installation

This library requires Python 3.6+ and Linux or MacOS.

pip install python-telegram-client

See documentation for more details.

How to use

Have a look at the tutorial :)

Basic example:

from teleclient.client import Telegram
from teleclient.text import Spoiler

tg = Telegram(
    api_id='api_id',
    api_hash='api_hash',
    phone='+31611111111',  # you can pass 'bot_token' instead
    database_encryption_key='changekey123',
    files_directory='/tmp/.tdlib_files/',
)
tg.login()

# if this is the first run, library needs to preload all chats
# otherwise the message will not be sent
result = tg.get_chats()
result.wait()

chat_id: int
result = tg.send_message(chat_id, Spoiler('Hello world!'))
# `tdlib` is asynchronous, so `python-telegram` always returns you an `AsyncResult` object.
# You can receive a result with the `wait` method of this object.
result.wait()
print(result.update)

tg.stop()  # you must call `stop` at the end of the script

More examples you can find in the /examples/ directory.


More information in the documentation.

Development

See CONTRIBUTING.md.