Metadata-Version: 2.4
Name: Telethon-MCUB
Version: 1.43.12
Summary: Full-featured Telegram client library for Python 3, forked for userbot use
Author-email: Lonami Exo <totufals@hotmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/hairpin01/Telethon-MCUB
Project-URL: Repository, https://github.com/hairpin01/Telethon-MCUB
Project-URL: Issues, https://github.com/hairpin01/Telethon-MCUB/issues
Keywords: telegram,api,chat,client,library,messaging,mtproto,userbot
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications :: Chat
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pyaes
Requires-Dist: rsa
Provides-Extra: cryptg
Requires-Dist: cryptg; extra == "cryptg"
Provides-Extra: socks
Requires-Dist: python-socks[asyncio]; extra == "socks"
Provides-Extra: media
Requires-Dist: hachoir; extra == "media"
Requires-Dist: pillow; extra == "media"
Provides-Extra: speedups
Requires-Dist: isal; extra == "speedups"
Provides-Extra: all
Requires-Dist: cryptg; extra == "all"
Requires-Dist: python-socks[asyncio]; extra == "all"
Requires-Dist: hachoir; extra == "all"
Requires-Dist: pillow; extra == "all"
Requires-Dist: isal; extra == "all"
Dynamic: license-file

Telethon-MCUB
=============

Telethon-MCUB is a maintained Telethon fork for MCUB and userbot-oriented
workloads. The Python import path remains ``telethon``, but the package name
for installation and publishing is ``Telethon-MCUB``.

Installation
------------

Install the base package:

.. code-block:: sh

    pip install -U Telethon-MCUB

Install with optional extras:

.. code-block:: sh

    pip install -U "Telethon-MCUB[cryptg]"
    pip install -U "Telethon-MCUB[socks]"
    pip install -U "Telethon-MCUB[media]"
    pip install -U "Telethon-MCUB[speedups]"
    pip install -U "Telethon-MCUB[all]"

Optional extras:

* ``cryptg`` for faster encryption/decryption.
* ``socks`` for proxy support through ``python-socks[asyncio]``.
* ``media`` for image resizing and media metadata extraction via ``pillow`` and
  ``hachoir``.
* ``speedups`` for faster gzip handling through ``isal``.
* ``all`` to install every optional dependency listed above.

Quick Start
-----------

.. code-block:: python

    from telethon import TelegramClient, events, sync

    api_id = 12345
    api_hash = "0123456789abcdef0123456789abcdef"

    client = TelegramClient("session_name", api_id, api_hash)
    client.start()

    print(client.get_me().stringify())
    client.send_message("username", "Hello from Telethon-MCUB")

    @client.on(events.NewMessage(pattern="(?i)hi|hello"))
    async def handler(event):
        await event.respond("Hey!")

Fork Notes
----------

* The package is published as ``Telethon-MCUB``, but existing code should keep
  importing ``telethon``.
* MCUB-specific changes and release history are tracked in ``CHANGELOG.md``.
* Core Telethon concepts and API documentation are still largely applicable:
  https://docs.telethon.dev

Project Links
-------------

* Repository: https://github.com/hairpin01/Telethon-MCUB
* Issues: https://github.com/hairpin01/Telethon-MCUB/issues
