Telethon-v1.24


NameTelethon-v1.24 JSON
Version 1.24.18 PyPI version JSON
download
home_pagehttps://github.com/vanutp/Telethon
SummaryUpdated fork of 1.24 branch of Telethon, primarily used by TGPy
upload_time2024-08-31 00:55:30
maintainerNone
docs_urlNone
authorvanutp
requires_python>=3.5
licenseMIT
keywords telegram api chat client library messaging mtproto
VCS
bugtrack_url
requirements pyaes rsa
Travis-CI No Travis.
coveralls test coverage
            Telethon-v1.24
==============

vanutp's fork of v1.24 branch of telethon

Parse modes
-----------

* Parse modes are reworked to be more accurate and more compatible with TDLib/Bot API.

HTML:

* Custom emojis are supported via ``<tg-emoji>`` or ``<emoji>`` tags with ``document``, ``document_id``, ``document-id``, ``emoji``, ``emoji_id`` or ``emoji-id`` attributes.
* Spoilers are supported via either ``<span class="tg-spoiler">`` or ``<tg-spoiler>`` tags.
* Pre blocks with language are supported via ``<pre><code class="language-<name>">`` tags.


Markdown:

* This implementation tries to be compatible with MarkdownV2 from TDLib/Bot API.
* The unparser is ported from aiogram, the parser is written from scratch.
* Escaping is done via backslash. Any character can be escaped.
* All entities and escapes are ignored in pre and code blocks.
  That means that you can't use ``````` in pre block and ````` in code block at all,
  but you can use any other characters inside them without escaping.

* All entities and escapes are ignored in URLs (but not in URL captions).
  That means you can't use ``)`` in URL.
  For example, ``[*bold \*text*](https://example.com/\\))`` is equivalent to
  ``<a href="https://example.com/\\"><b>bold *text</b></a>)``.

* You must escape ``_*[]()~`|\`` characters in any other context.
  Note that escaping ``>#+-={}.!`` characters is not required.

* Custom emojis are supported via ``[👍](tg://emoji?id=6334815245336315702)'`` syntax.


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/latest/misc/compatibility-and-convenience.html
.. _Read The Docs: https://docs.telethon.dev

.. |logo| image:: logo.svg
    :width: 24pt
    :height: 24pt

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vanutp/Telethon",
    "name": "Telethon-v1.24",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": null,
    "keywords": "telegram api chat client library messaging mtproto",
    "author": "vanutp",
    "author_email": "hello@vanutp.dev",
    "download_url": "https://files.pythonhosted.org/packages/3b/17/6d7ecde61b2164fc5063e19a3d37fb6dba1e9aec93bd303ee3b5dd5b1421/Telethon-v1.24-1.24.18.tar.gz",
    "platform": null,
    "description": "Telethon-v1.24\n==============\n\nvanutp's fork of v1.24 branch of telethon\n\nParse modes\n-----------\n\n* Parse modes are reworked to be more accurate and more compatible with TDLib/Bot API.\n\nHTML:\n\n* Custom emojis are supported via ``<tg-emoji>`` or ``<emoji>`` tags with ``document``, ``document_id``, ``document-id``, ``emoji``, ``emoji_id`` or ``emoji-id`` attributes.\n* Spoilers are supported via either ``<span class=\"tg-spoiler\">`` or ``<tg-spoiler>`` tags.\n* Pre blocks with language are supported via ``<pre><code class=\"language-<name>\">`` tags.\n\n\nMarkdown:\n\n* This implementation tries to be compatible with MarkdownV2 from TDLib/Bot API.\n* The unparser is ported from aiogram, the parser is written from scratch.\n* Escaping is done via backslash. Any character can be escaped.\n* All entities and escapes are ignored in pre and code blocks.\n  That means that you can't use ``````` in pre block and ````` in code block at all,\n  but you can use any other characters inside them without escaping.\n\n* All entities and escapes are ignored in URLs (but not in URL captions).\n  That means you can't use ``)`` in URL.\n  For example, ``[*bold \\*text*](https://example.com/\\\\))`` is equivalent to\n  ``<a href=\"https://example.com/\\\\\"><b>bold *text</b></a>)``.\n\n* You must escape ``_*[]()~`|\\`` characters in any other context.\n  Note that escaping ``>#+-={}.!`` characters is not required.\n\n* Custom emojis are supported via ``[\ud83d\udc4d](tg://emoji?id=6334815245336315702)'`` syntax.\n\n\nTelethon\n========\n.. epigraph::\n\n  \u2b50\ufe0f Thanks **everyone** who has starred the project, it means a lot!\n\n|logo| **Telethon** is an asyncio_ **Python 3**\nMTProto_ library to interact with Telegram_'s API\nas a user or through a bot account (bot API alternative).\n\n.. important::\n\n    If you have code using Telethon before its 1.0 version, you must\n    read `Compatibility and Convenience`_ to learn how to migrate.\n\nWhat is this?\n-------------\n\nTelegram is a popular messaging application. This library is meant\nto make it easy for you to write Python programs that can interact\nwith Telegram. Think of it as a wrapper that has already done the\nheavy job for you, so you can focus on developing an application.\n\n\nInstalling\n----------\n\n.. code-block:: sh\n\n  pip3 install telethon\n\n\nCreating a client\n-----------------\n\n.. code-block:: python\n\n    from telethon import TelegramClient, events, sync\n\n    # These example values won't work. You must get your own api_id and\n    # api_hash from https://my.telegram.org, under API Development.\n    api_id = 12345\n    api_hash = '0123456789abcdef0123456789abcdef'\n\n    client = TelegramClient('session_name', api_id, api_hash)\n    client.start()\n\n\nDoing stuff\n-----------\n\n.. code-block:: python\n\n    print(client.get_me().stringify())\n\n    client.send_message('username', 'Hello! Talking to you from Telethon')\n    client.send_file('username', '/home/myself/Pictures/holidays.jpg')\n\n    client.download_profile_photo('me')\n    messages = client.get_messages('username')\n    messages[0].download_media()\n\n    @client.on(events.NewMessage(pattern='(?i)hi|hello'))\n    async def handler(event):\n        await event.respond('Hey!')\n\n\nNext steps\n----------\n\nDo you like how Telethon looks? Check out `Read The Docs`_ for a more\nin-depth explanation, with examples, troubleshooting issues, and more\nuseful information.\n\n.. _asyncio: https://docs.python.org/3/library/asyncio.html\n.. _MTProto: https://core.telegram.org/mtproto\n.. _Telegram: https://telegram.org\n.. _Compatibility and Convenience: https://docs.telethon.dev/en/latest/misc/compatibility-and-convenience.html\n.. _Read The Docs: https://docs.telethon.dev\n\n.. |logo| image:: logo.svg\n    :width: 24pt\n    :height: 24pt\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Updated fork of 1.24 branch of Telethon, primarily used by TGPy",
    "version": "1.24.18",
    "project_urls": {
        "Download": "https://github.com/vanutp/Telethon/releases",
        "Homepage": "https://github.com/vanutp/Telethon"
    },
    "split_keywords": [
        "telegram",
        "api",
        "chat",
        "client",
        "library",
        "messaging",
        "mtproto"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8668ae1c384d5509a86cfa17d75c9f9c1fadc9aea8f90503d984b03ca496b1d",
                "md5": "bd08038e2741decaa537f38c7ab575e0",
                "sha256": "2d689dcbac2e84ad42cfac99f6fcc4e98d8574369fd66200e63568c463027bfc"
            },
            "downloads": -1,
            "filename": "Telethon_v1.24-1.24.18-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bd08038e2741decaa537f38c7ab575e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 661607,
            "upload_time": "2024-08-31T00:55:28",
            "upload_time_iso_8601": "2024-08-31T00:55:28.468657Z",
            "url": "https://files.pythonhosted.org/packages/c8/66/8ae1c384d5509a86cfa17d75c9f9c1fadc9aea8f90503d984b03ca496b1d/Telethon_v1.24-1.24.18-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b176d7ecde61b2164fc5063e19a3d37fb6dba1e9aec93bd303ee3b5dd5b1421",
                "md5": "d8e756fe8e9c11607378527acfc7d8b2",
                "sha256": "ad582e9ea307a4e2e3461219ed17ee813aebbf5dfa62d4e5a9af42bd63b21256"
            },
            "downloads": -1,
            "filename": "Telethon-v1.24-1.24.18.tar.gz",
            "has_sig": false,
            "md5_digest": "d8e756fe8e9c11607378527acfc7d8b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 587706,
            "upload_time": "2024-08-31T00:55:30",
            "upload_time_iso_8601": "2024-08-31T00:55:30.818216Z",
            "url": "https://files.pythonhosted.org/packages/3b/17/6d7ecde61b2164fc5063e19a3d37fb6dba1e9aec93bd303ee3b5dd5b1421/Telethon-v1.24-1.24.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-31 00:55:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vanutp",
    "github_project": "Telethon",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "pyaes",
            "specs": []
        },
        {
            "name": "rsa",
            "specs": []
        }
    ],
    "lcname": "telethon-v1.24"
}
        
Elapsed time: 0.35140s