<p align="center">
<a href="https://github.com/dawn/nekozee">
<img src="https://dawn.github.io/nekozee-docs/main/_static/nekozee.png" alt="nekozee" width="128">
</a>
<br>
<b>Telegram MTProto API Framework for Python</b>
<br>
<a href="https://dawn.github.io/nekozee-docs">
Documentation
</a>
•
<a href="https://github.com/dawn/nekozee/issues">
Issues
</a>
•
<a href="https://t.me/Zee_Mirror">
Support
</a>
</p>
## nekozee
> 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 nekozee!")
app.run()
```
**nekozee** is a modern, elegant and
asynchronous [MTProto API](https://dawn.github.io/nekozee-docs/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.
### Key Features
- **Ready**: Install nekozee 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 -U nekozee
```
### Resources
- Check out the docs at https://dawn.github.io/nekozee-docs to learn more about nekozee, get started right
away and discover more in-depth material for building your client applications.
- Join the official group at https://t.me/OpenFileZ and stay tuned for news, updates and announcements.
Raw data
{
"_id": null,
"home_page": null,
"name": "nekozee",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.12",
"maintainer_email": null,
"keywords": "black bsxcs telegram chat messenger mtproto api client library python",
"author": null,
"author_email": "Z-Mirror <hello@dawn-in.eu.org>",
"download_url": "https://files.pythonhosted.org/packages/b6/31/e1f7268872407a832924e1dfd8469be9703266a10aaf9c603e0ba3380183/nekozee-2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/dawn/nekozee\">\n <img src=\"https://dawn.github.io/nekozee-docs/main/_static/nekozee.png\" alt=\"nekozee\" width=\"128\">\n </a>\n <br>\n <b>Telegram MTProto API Framework for Python</b>\n <br>\n <a href=\"https://dawn.github.io/nekozee-docs\">\n Documentation\n </a>\n \u2022\n <a href=\"https://github.com/dawn/nekozee/issues\">\n Issues\n </a>\n \u2022\n <a href=\"https://t.me/Zee_Mirror\">\n Support\n </a>\n</p>\n\n## nekozee\n\n> Elegant, modern and asynchronous Telegram MTProto API framework in Python for users and bots\n\n``` python\nfrom pyrogram import Client, filters\n\napp = Client(\"my_account\")\n\n\n@app.on_message(filters.private)\nasync def hello(client, message):\n await message.reply(\"Hello from nekozee!\")\n\n\napp.run()\n```\n\n**nekozee** is a modern, elegant and\nasynchronous [MTProto API](https://dawn.github.io/nekozee-docs/topics/mtproto-vs-botapi)\nframework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot\nidentity (bot API alternative) using Python.\n\n### Key Features\n\n- **Ready**: Install nekozee with pip and start building your applications right away.\n- **Easy**: Makes the Telegram API simple and intuitive, while still allowing advanced usages.\n- **Elegant**: Low-level details are abstracted and re-presented in a more convenient way.\n- **Fast**: Boosted up by [TgCrypto](https://github.com/pyrogram/tgcrypto), a high-performance cryptography library written in C. \n- **Type-hinted**: Types and methods are all type-hinted, enabling excellent editor support.\n- **Async**: Fully asynchronous (also usable synchronously if wanted, for convenience).\n- **Powerful**: Full access to Telegram's API to execute any official client action and more.\n\n### Installing\n\n``` bash\npip3 install -U nekozee\n```\n\n### Resources\n\n- Check out the docs at https://dawn.github.io/nekozee-docs to learn more about nekozee, get started right\naway and discover more in-depth material for building your client applications.\n- Join the official group at https://t.me/OpenFileZ and stay tuned for news, updates and announcements.\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "nekozee",
"version": "2",
"project_urls": {
"Community": "https://t.me/z_mirror",
"Documentation": "https://dawn.github.io/nekozee-docs",
"Source": "https://github.com/Dawn-India/Z-Mirror",
"Tracker": "https://github.com/Dawn-India/Z-Mirror/issues"
},
"split_keywords": [
"black",
"bsxcs",
"telegram",
"chat",
"messenger",
"mtproto",
"api",
"client",
"library",
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7309848630f7cd8dd20b53427fbd8a091871cb38d7047aae738eb4b15ac22b21",
"md5": "93fccfffd5a1713242b44e421a61b46b",
"sha256": "97ff07999d46e641e280969b62af86047835ab26720d2cef0310cbca1a4831e2"
},
"downloads": -1,
"filename": "nekozee-2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93fccfffd5a1713242b44e421a61b46b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.12",
"size": 4105103,
"upload_time": "2024-08-19T08:19:10",
"upload_time_iso_8601": "2024-08-19T08:19:10.098034Z",
"url": "https://files.pythonhosted.org/packages/73/09/848630f7cd8dd20b53427fbd8a091871cb38d7047aae738eb4b15ac22b21/nekozee-2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b631e1f7268872407a832924e1dfd8469be9703266a10aaf9c603e0ba3380183",
"md5": "6abe61b22e7d6f90521c8c01c81e6d15",
"sha256": "3fc215de1e698eee112f9820adcc7cae626c1d52cae4519dacbacf86aea7e948"
},
"downloads": -1,
"filename": "nekozee-2.tar.gz",
"has_sig": false,
"md5_digest": "6abe61b22e7d6f90521c8c01c81e6d15",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.12",
"size": 2436258,
"upload_time": "2024-08-19T08:19:08",
"upload_time_iso_8601": "2024-08-19T08:19:08.689536Z",
"url": "https://files.pythonhosted.org/packages/b6/31/e1f7268872407a832924e1dfd8469be9703266a10aaf9c603e0ba3380183/nekozee-2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-19 08:19:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dawn-India",
"github_project": "Z-Mirror",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aiofiles",
"specs": []
},
{
"name": "aioshutil",
"specs": []
},
{
"name": "anytree",
"specs": []
},
{
"name": "apscheduler",
"specs": []
},
{
"name": "aria2p",
"specs": []
},
{
"name": "asyncio",
"specs": []
},
{
"name": "bencoding",
"specs": []
},
{
"name": "cloudscraper",
"specs": []
},
{
"name": "dnspython",
"specs": []
},
{
"name": "feedparser",
"specs": []
},
{
"name": "flask",
"specs": []
},
{
"name": "gevent",
"specs": []
},
{
"name": "google-api-python-client",
"specs": []
},
{
"name": "google-auth-httplib2",
"specs": []
},
{
"name": "google-auth-oauthlib",
"specs": []
},
{
"name": "gunicorn",
"specs": []
},
{
"name": "httpx",
"specs": []
},
{
"name": "lxml",
"specs": []
},
{
"name": "motor",
"specs": []
},
{
"name": "natsort",
"specs": []
},
{
"name": "pillow",
"specs": []
},
{
"name": "psutil",
"specs": []
},
{
"name": "pycryptodome",
"specs": []
},
{
"name": "pymongo",
"specs": []
},
{
"name": "python-dotenv",
"specs": []
},
{
"name": "python-magic",
"specs": []
},
{
"name": "qbittorrent-api",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "telegraph",
"specs": []
},
{
"name": "tenacity",
"specs": []
},
{
"name": "tgcrypto",
"specs": []
},
{
"name": "urllib3",
"specs": []
},
{
"name": "uvloop",
"specs": []
},
{
"name": "xattr",
"specs": []
},
{
"name": "yt-dlp",
"specs": []
}
],
"lcname": "nekozee"
}