Metadata-Version: 1.1
Name: Pyrogram
Version: 0.3.0
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`_
        
        -   `Requirements`_
        
        -   `Installation`_
        
        -   `Getting Started`_
        
        -   `Development`_
        
        -   `Documentation`_
        
        -   `Contribution`_
        
        -   `Feedback`_
        
        -   `License`_
        
        
        Overview
        ========
        
        **Pyrogram** is a Client Library written from the ground up in Python, designed
        for Python application developers. It offers simple and complete access to the
        `Telegram Messenger API`_. Pyrogram:
        
        -   Provides idiomatic, developer-friendly Python code (either generated or
            hand-written) making the Telegram API simple to use.
        
        -   Handles all the low-level details of communication with the Telegram servers
            by implementing the `MTProto Mobile Protocol v2.0`_.
        
        -   Makes use of the latest Telegram API version (`Layer 73`_).
        
        -   Can be easily installed and upgraded using ``pip``.
        
        -   Requires a minimal set of dependencies.
        
        
        Requirements
        ============
        
        -   Python 3.3 or higher.
        
        -   A Telegram API key.
        
        
        Installation
        ============
        
        You can easily install and upgrade the library using standard Python tools:
        
        .. code:: shell
        
            $ pip install --upgrade pyrogram
            
        
        Getting Started
        ===============
        
        -   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
        
        -   Then you can start with this:
        
            .. code:: python
        
                from pyrogram import Client
        
                client = Client(session_name="example")
                client.start()
        
                # Get information about yourself
                print(client.get_me())
            
        That's all you need for getting started with Pyrogram. For more detailed information,
        please refer to the `Wiki`_:
        
        -   `Introduction`_
        
        Other references:
        
        -   `docs.pyrogram.ml`_
        
        Development
        ===========
        
        The library is still in its early stages, thus lots of functionalities aiming to
        make working with Telegram's API easy are yet to be added and documented.
        
        However, being the core functionalities already implemented, every Telegram API
        method listed in the API scheme can be used right away; the goal is therefore to
        build a powerful, simple to use, `bot-like`_ interface on top of those low-level
        functions.
        
        
        Documentation
        =============
        
        - Pyrogram's API documentation at `docs.pyrogram.ml`_.
        - Guides and examples can be found on the `Wiki`_.
        
        
        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 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 73`: compiler/api/source/main_api.tl
        
        .. _`Wiki`: https://github.com/pyrogram/pyrogram/wiki
        
        .. _`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/joinchat/AWDQ8lK2HgBN7ka4OyWVTw
        
        .. _`docs.pyrogram.ml`: https://docs.pyrogram.ml
        
        .. _`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 73
        
        .. |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
