<p align="center">
<a href="https://github.com/nerogram/nerogram">
<img src="https://docs.nerogram.org/_static/nerogram.png" alt="Nerogram" width="128">
</a>
<br>
<b>Telegram MTProto API Framework for Python</b>
<br>
<a href="https://nerogram.org">
Homepage
</a>
•
<a href="https://docs.nerogram.org">
Documentation
</a>
•
<a href="https://docs.nerogram.org/releases">
Releases
</a>
•
<a href="https://t.me/nerogram">
News
</a>
</p>
## Nerogram
> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots
``` python
from nerogram import Client, filters
app = Client("my_account")
@app.on_message(filters.private)
async def hello(client, message):
await message.reply("Hello from Nerogram!")
app.run()
```
**Nerogram** is a modern, elegant and asynchronous [MTProto API](https://docs.nerogram.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 Nerogram, 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/nerogram).
### Key Features
- **Ready**: Install Nerogram 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/nerogram/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 nerogram
```
### Resources
- Check out the docs at https://docs.nerogram.org to learn more about Nerogram, get started right
away and discover more in-depth material for building your client applications.
- Join the official channel at https://t.me/nerogram and stay tuned for news, updates and announcements.
Raw data
{
"_id": null,
"home_page": "https://github.com/nmiabdfhmy",
"name": "Nerogram",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": null,
"keywords": "telegram chat messenger mtproto api client library python",
"author": "Naka",
"author_email": "nprostd@nerogram.org",
"download_url": "https://files.pythonhosted.org/packages/32/e7/cf9a07be8a41ac291e5fafc5154f1cc906c966d98a2ef98a56f8df6e5121/Nerogram-2.0.112.tar.gz",
"platform": null,
"description": "<p align=\"center\">\r\n <a href=\"https://github.com/nerogram/nerogram\">\r\n <img src=\"https://docs.nerogram.org/_static/nerogram.png\" alt=\"Nerogram\" width=\"128\">\r\n </a>\r\n <br>\r\n <b>Telegram MTProto API Framework for Python</b>\r\n <br>\r\n <a href=\"https://nerogram.org\">\r\n Homepage\r\n </a>\r\n \u2022\r\n <a href=\"https://docs.nerogram.org\">\r\n Documentation\r\n </a>\r\n \u2022\r\n <a href=\"https://docs.nerogram.org/releases\">\r\n Releases\r\n </a>\r\n \u2022\r\n <a href=\"https://t.me/nerogram\">\r\n News\r\n </a>\r\n</p>\r\n\r\n## Nerogram\r\n\r\n> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots\r\n\r\n``` python\r\nfrom nerogram import Client, filters\r\n\r\napp = Client(\"my_account\")\r\n\r\n\r\n@app.on_message(filters.private)\r\nasync def hello(client, message):\r\n await message.reply(\"Hello from Nerogram!\")\r\n\r\n\r\napp.run()\r\n```\r\n\r\n**Nerogram** is a modern, elegant and asynchronous [MTProto API](https://docs.nerogram.org/topics/mtproto-vs-botapi)\r\nframework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot\r\nidentity (bot API alternative) using Python.\r\n\r\n### Support\r\n\r\nIf you'd like to support Nerogram, you can consider:\r\n\r\n- [Become a GitHub sponsor](https://github.com/sponsors/delivrance).\r\n- [Become a LiberaPay patron](https://liberapay.com/delivrance).\r\n- [Become an OpenCollective backer](https://opencollective.com/nerogram).\r\n\r\n### Key Features\r\n\r\n- **Ready**: Install Nerogram with pip and start building your applications right away.\r\n- **Easy**: Makes the Telegram API simple and intuitive, while still allowing advanced usages.\r\n- **Elegant**: Low-level details are abstracted and re-presented in a more convenient way.\r\n- **Fast**: Boosted up by [TgCrypto](https://github.com/nerogram/tgcrypto), a high-performance cryptography library written in C. \r\n- **Type-hinted**: Types and methods are all type-hinted, enabling excellent editor support.\r\n- **Async**: Fully asynchronous (also usable synchronously if wanted, for convenience).\r\n- **Powerful**: Full access to Telegram's API to execute any official client action and more.\r\n\r\n### Installing\r\n\r\n``` bash\r\npip3 install nerogram\r\n```\r\n\r\n### Resources\r\n\r\n- Check out the docs at https://docs.nerogram.org to learn more about Nerogram, get started right\r\naway and discover more in-depth material for building your client applications.\r\n- Join the official channel at https://t.me/nerogram and stay tuned for news, updates and announcements.\r\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots",
"version": "2.0.112",
"project_urls": {
"Community": "https://t.me/nerogram",
"Documentation": "https://docs.nerogram.org",
"Download": "https://github.com/nmiabdfhmy/nerogram/releases/latest",
"Homepage": "https://github.com/nmiabdfhmy",
"Source": "https://github.com/nmiabdfhmy/nerogram",
"Tracker": "https://github.com/nmiabdfhmy/nerogram/issues"
},
"split_keywords": [
"telegram",
"chat",
"messenger",
"mtproto",
"api",
"client",
"library",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32e7cf9a07be8a41ac291e5fafc5154f1cc906c966d98a2ef98a56f8df6e5121",
"md5": "2350faa2015279658b04709bbf5d1aca",
"sha256": "ad1091ab593631d39e8838665ab32cd6819de61073f6e3ece05157a38073c46e"
},
"downloads": -1,
"filename": "Nerogram-2.0.112.tar.gz",
"has_sig": false,
"md5_digest": "2350faa2015279658b04709bbf5d1aca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 393859,
"upload_time": "2025-01-06T19:29:43",
"upload_time_iso_8601": "2025-01-06T19:29:43.762264Z",
"url": "https://files.pythonhosted.org/packages/32/e7/cf9a07be8a41ac291e5fafc5154f1cc906c966d98a2ef98a56f8df6e5121/Nerogram-2.0.112.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 19:29:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nmiabdfhmy",
"github_project": "nerogram",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pyaes",
"specs": [
[
"==",
"1.6.1"
]
]
},
{
"name": "pysocks",
"specs": [
[
"==",
"1.7.1"
]
]
}
],
"tox": true,
"lcname": "nerogram"
}
JSON
