Metadata-Version: 1.1
Name: Pyrogram
Version: 0.4.1
Summary: Telegram MTProto API Client Library for Python
Home-page: https://github.com/pyrogram/pyrogram
Author: Dan Tès
Author-email: admin@pyrogram.ml
License: LGPLv3+
Description-Content-Type: UNKNOWN
Description: |logo|
        
        |description|
        
        |scheme| |mtproto|
        
        Table of Contents
        =================
        
        -   `Overview`_
        
            -   `Features`_
        
            -   `Requirements`_
        
        -   `Getting Started`_
            
            -   `Installation`_
            
            -   `Configuration`_
            
            -   `Usage`_
        
        -   `Documentation`_
        
        -   `Contribution`_
        
        -   `Feedback`_
        
        -   `License`_
        
        
        Overview
        ========
        
        **Pyrogram** is a fully functional Telegram Client Library written from the ground up in Python.
        It offers simple and complete access to the `Telegram Messenger API`_ and is designed for Python
        developers keen on building custom Telegram applications.
        
        
        Features
        --------
        
        -   **Easy to setup**: Pyrogram can be easily installed and upgraded using ``pip``, requires
            a minimal set of dependencies (which are also automatically managed) and very few lines
            of code to get started with.
        
        -   **Easy to use**: Pyrogram provides idiomatic, developer-friendly, clean and readable
            Python code (either generated or hand-written) making the Telegram API simple to use.
            
        -   **High level**: Pyrogram automatically handles all the low-level details of
            communication with the Telegram servers by implementing the
            `MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing
            a reliable connection.
            
        -   **Updated**: Pyrogram makes use of the latest Telegram API version, currently `Layer 75`_.
            
        -   **Documented**: Pyrogram API public methods are documented and resemble the well
            established Telegram Bot API, thus offering a familiar look to Bot developers.
        
        -   **Full API support**: Beside the simple, bot-like methods offered by the Pyrogram API,
            the library also provides a complete, low-level access to every single Telegram API method.
        
        
        Requirements
        ------------
        
        -   Python 3.3 or higher.
        
        -   A Telegram API key.
            
        
        Getting Started
        ===============
        
        Installation
        ------------
        
        -   You can easily install and upgrade the library using standard Python tools:
        
            .. code:: shell
        
                $ pip install --upgrade pyrogram
        
        Configuration
        -------------
        
        -   Create a new ``config.ini`` file at the root of your working directory, copy-paste
            the following and replace the **api_id** and **api_hash** values with `your own`_:
        
            .. code:: ini
        
                [pyrogram]
                api_id = 12345
                api_hash = 0123456789abcdef0123456789abcdef
        
        Usage
        -----
        
        -   And here's how Pyrogram looks:
        
            .. code:: python
        
                from pyrogram import Client
        
                client = Client("example")
                client.start()
        
                client.send_message("me", "Hi there! I'm using Pyrogram")
                client.send_photo("me", "/home/dan/pic.jpg", "Nice photo!")
        
                client.stop()
            
        That's all you need for getting started with Pyrogram. For more detailed information,
        please refer to the Documentation_.
        
        
        Documentation
        =============
        
        - The entire Pyrogram's documentation resides at https://docs.pyrogram.ml.
        
        
        Contribution
        ============
        
        **You are very welcome to contribute** by either submitting pull requests or
        reporting issues/bugs as well as suggesting best practices, ideas, enhancements
        on both code and documentation. Any help is appreciated!
        
        
        Feedback
        ========
        
        Means for getting in touch:
        
        -   `Telegram`_
        -   `GitHub`_
        -   `Email`_
        
        
        License
        =======
        
        -   Copyright (C) 2017-2018 Dan Tès <https://github.com/delivrance>
        
        -   Licensed under the terms of the
            `GNU Lesser General Public License v3 or later (LGPLv3+)`_
            
        
        .. _`Telegram Messenger API`: https://core.telegram.org/api#telegram-api
        
        .. _`MTProto Mobile Protocol v2.0`: https://core.telegram.org/mtproto
        
        .. _`Layer 75`: compiler/api/source/main_api.tl
        
        .. _`your own`: https://github.com/pyrogram/pyrogram/wiki/Getting-Started#api-keys
        
        .. _`Introduction`: https://github.com/pyrogram/pyrogram/wiki/Getting-Started
        
        .. _`Telegram`: https://t.me/haskell
        
        .. _`bot-like`: https://core.telegram.org/bots/api#available-methods
        
        .. _`GitHub`: https://github.com/pyrogram/pyrogram/issues
        
        .. _`Email`: admin@pyrogram.ml
        
        .. _`GNU Lesser General Public License v3 or later (LGPLv3+)`: COPYING.lesser
        
        .. |logo| image:: https://pyrogram.ml/images/logo.png
            :target: https://pyrogram.ml
            :alt: Pyrogram
        
        .. |description| replace:: **Telegram MTProto API Client Library for Python**
        
        .. |scheme| image:: https://www.pyrogram.ml/images/scheme.svg
            :target: compiler/api/source/main_api.tl
            :alt: Scheme Layer 75
        
        .. |mtproto| image:: https://www.pyrogram.ml/images/mtproto.svg
            :target: https://core.telegram.org/mtproto
            :alt: MTProto v2.0
        
Keywords: telegram mtproto api client library python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
