mirror of
				https://github.com/LonamiWebs/Telethon.git
				synced 2025-10-30 15:37:30 +03:00 
			
		
		
		
	Pure Python 3 MTProto API Telegram client library, for bots too!
			
		
		
			
			hacktoberfestlibrarymtprotopython-librarystarred-lonamiwebs-repostarred-repotelegramtelegram-apitelethon
			
		
		
		
		
		
		
		
		
		
		
			| Because Telegram can't actually use 0 for the pts, it uses 1, even if the count is 0. This forces the next update to use 2, or else it could not be fetched when using an offset of 1 (despite the count being 0 on the first update, which should not have bumped the second update to use 2). This caused Telethon to create an initial state of 0 for the new entry (and also "incorrectly" detected following updates as gaps, which would quickly trigger the call to get difference with a bad pts). Now Telethon is aware of this special-case and will not initialize state as 0, even if that's not the "correct" thing to do. | ||
|---|---|---|
| .github | ||
| readthedocs | ||
| telethon | ||
| telethon_examples | ||
| telethon_generator | ||
| tests | ||
| .coveragerc | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| dev-requirements.txt | ||
| LICENSE | ||
| logo.svg | ||
| optional-requirements.txt | ||
| pyproject.toml | ||
| README.rst | ||
| requirements.txt | ||
| setup.py | ||
| update-docs.sh | ||
Telethon
========
.. epigraph::
  ⭐️ Thanks **everyone** who has starred the project, it means a lot!
|logo| **Telethon** is an asyncio_ **Python 3**
MTProto_ library to interact with Telegram_'s API
as a user or through a bot account (bot API alternative).
.. important::
    If you have code using Telethon before its 1.0 version, you must
    read `Compatibility and Convenience`_ to learn how to migrate.
What is this?
-------------
Telegram is a popular messaging application. This library is meant
to make it easy for you to write Python programs that can interact
with Telegram. Think of it as a wrapper that has already done the
heavy job for you, so you can focus on developing an application.
Installing
----------
.. code-block:: sh
  pip3 install telethon
Creating a client
-----------------
.. code-block:: python
    from telethon import TelegramClient, events, sync
    # These example values won't work. You must get your own api_id and
    # api_hash from https://my.telegram.org, under API Development.
    api_id = 12345
    api_hash = '0123456789abcdef0123456789abcdef'
    client = TelegramClient('session_name', api_id, api_hash)
    client.start()
Doing stuff
-----------
.. code-block:: python
    print(client.get_me().stringify())
    client.send_message('username', 'Hello! Talking to you from Telethon')
    client.send_file('username', '/home/myself/Pictures/holidays.jpg')
    client.download_profile_photo('me')
    messages = client.get_messages('username')
    messages[0].download_media()
    @client.on(events.NewMessage(pattern='(?i)hi|hello'))
    async def handler(event):
        await event.respond('Hey!')
Next steps
----------
Do you like how Telethon looks? Check out `Read The Docs`_ for a more
in-depth explanation, with examples, troubleshooting issues, and more
useful information.
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _MTProto: https://core.telegram.org/mtproto
.. _Telegram: https://telegram.org
.. _Compatibility and Convenience: https://docs.telethon.dev/en/stable/misc/compatibility-and-convenience.html
.. _Read The Docs: https://docs.telethon.dev
.. |logo| image:: logo.svg
    :width: 24pt
    :height: 24pt