tulir-telethon


Nametulir-telethon JSON
Version 1.34.0a3 PyPI version JSON
download
home_pagehttps://github.com/tulir/Telethon
SummaryFull-featured Telegram client library for Python 3
upload_time2024-01-08 12:34:36
maintainer
docs_urlNone
authorLonami Exo
requires_python>=3.5
licenseMIT
keywords telegram api chat client library messaging mtproto
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            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.
    As with any third-party library for Telegram, be careful not to
    break `Telegram's ToS`_ or `Telegram can ban the account`_.

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
.. _Telegram's ToS: https://core.telegram.org/api/terms
.. _Telegram can ban the account: https://docs.telethon.dev/en/stable/quick-references/faq.html#my-account-was-deleted-limited-when-using-the-library
.. _Read The Docs: https://docs.telethon.dev

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tulir/Telethon",
    "name": "tulir-telethon",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "telegram api chat client library messaging mtproto",
    "author": "Lonami Exo",
    "author_email": "totufals@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/34/27/7ddc283058f0e3bc547d189b7fc617dfdc596ee55b3af3d9c260e7d6e65c/tulir-telethon-1.34.0a3.tar.gz",
    "platform": null,
    "description": "Telethon\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    As with any third-party library for Telegram, be careful not to\n    break `Telegram's ToS`_ or `Telegram can ban the account`_.\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/stable/misc/compatibility-and-convenience.html\n.. _Telegram's ToS: https://core.telegram.org/api/terms\n.. _Telegram can ban the account: https://docs.telethon.dev/en/stable/quick-references/faq.html#my-account-was-deleted-limited-when-using-the-library\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": "Full-featured Telegram client library for Python 3",
    "version": "1.34.0a3",
    "project_urls": {
        "Homepage": "https://github.com/tulir/Telethon"
    },
    "split_keywords": [
        "telegram",
        "api",
        "chat",
        "client",
        "library",
        "messaging",
        "mtproto"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c438c8ebd7ada29bc3d5a387d30f0aa111036fc38fd7e09845841f763728e0bb",
                "md5": "5c8fa4c49e5877268041d0b0acdfc549",
                "sha256": "3de0493bc9257da6a103a528d60053b4858708f7b18752154142aba90a48f3d3"
            },
            "downloads": -1,
            "filename": "tulir_telethon-1.34.0a3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c8fa4c49e5877268041d0b0acdfc549",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 647472,
            "upload_time": "2024-01-08T12:34:33",
            "upload_time_iso_8601": "2024-01-08T12:34:33.551406Z",
            "url": "https://files.pythonhosted.org/packages/c4/38/c8ebd7ada29bc3d5a387d30f0aa111036fc38fd7e09845841f763728e0bb/tulir_telethon-1.34.0a3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34277ddc283058f0e3bc547d189b7fc617dfdc596ee55b3af3d9c260e7d6e65c",
                "md5": "92c51231da2c5391114f56bef938fad6",
                "sha256": "d4f6e27fcaad60cdb1fe40b8b3c1d7b212d6d66676f43b6ce8c8d88b64fc65e8"
            },
            "downloads": -1,
            "filename": "tulir-telethon-1.34.0a3.tar.gz",
            "has_sig": false,
            "md5_digest": "92c51231da2c5391114f56bef938fad6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 577740,
            "upload_time": "2024-01-08T12:34:36",
            "upload_time_iso_8601": "2024-01-08T12:34:36.393500Z",
            "url": "https://files.pythonhosted.org/packages/34/27/7ddc283058f0e3bc547d189b7fc617dfdc596ee55b3af3d9c260e7d6e65c/tulir-telethon-1.34.0a3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-08 12:34:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tulir",
    "github_project": "Telethon",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "requirements": [],
    "lcname": "tulir-telethon"
}
        
Elapsed time: 0.17420s