https://github.com/pyrogram/pyrogram

Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
https://github.com/pyrogram/pyrogram

async asynchronous asyncio bot-api client framework hacktoberfest library mtproto pyrogram python python-library telegram telegram-api

Last synced: about 1 month ago
JSON representation

Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots

• Host: GitHub
• URL: https://github.com/pyrogram/pyrogram
• Owner: pyrogram
• License: lgpl-3.0
• Created: 2017-12-12T09:37:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-03T10:32:28.000Z (5 months ago)
• Last Synced: 2024-04-14T06:49:28.399Z (5 months ago)
• Topics: async, asynchronous, asyncio, bot-api, client, framework, hacktoberfest, library, mtproto, pyrogram, python, python-library, telegram, telegram-api
• Language: Python
• Homepage: https://pyrogram.org
• Size: 7.01 MB
• Stars: 4,070
• Watchers: 89
• Forks: 1,265
• Open Issues: 267
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: COPYING

Awesome Lists containing this project

• awesome - pyrogram/pyrogram - Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots (Python)
• awesome - pyrogram/pyrogram - Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots (Python)
• awesome-python-resources - Source
• awesome-telegram - pyrogram - Telegram MTProto API Python client library framework for users and bots. (Bots / Bot Libs)

README

        


    

        

    

    


    Telegram MTProto API Framework for Python

    


    

        Homepage

    

    •

    

        Documentation

    

    •

    

        Releases

    

    •

    

        News

    



## Pyrogram

> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots

``` python

from pyrogram import Client, filters

app = Client("my_account")

@app.on_message(filters.private)

async def hello(client, message):

    await message.reply("Hello from Pyrogram!")

app.run()

```

**Pyrogram** is a modern, elegant and asynchronous [MTProto API](https://docs.pyrogram.org/topics/mtproto-vs-botapi)

framework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot

identity (bot API alternative) using Python.

### Support

If you'd like to support Pyrogram, you can consider:

- [Become a GitHub sponsor](https://github.com/sponsors/delivrance).

- [Become a LiberaPay patron](https://liberapay.com/delivrance).

- [Become an OpenCollective backer](https://opencollective.com/pyrogram).

### Key Features

- **Ready**: Install Pyrogram with pip and start building your applications right away.

- **Easy**: Makes the Telegram API simple and intuitive, while still allowing advanced usages.

- **Elegant**: Low-level details are abstracted and re-presented in a more convenient way.

- **Fast**: Boosted up by [TgCrypto](https://github.com/pyrogram/tgcrypto), a high-performance cryptography library written in C.  

- **Type-hinted**: Types and methods are all type-hinted, enabling excellent editor support.

- **Async**: Fully asynchronous (also usable synchronously if wanted, for convenience).

- **Powerful**: Full access to Telegram's API to execute any official client action and more.

### Installing

``` bash

pip3 install pyrogram

```

### Resources

- Check out the docs at https://docs.pyrogram.org to learn more about Pyrogram, get started right

away and discover more in-depth material for building your client applications.

- Join the official channel at https://t.me/pyrogram and stay tuned for news, updates and announcements.