# py-Ultroid Library
Core library of [The Ultroid](https://github.com/naya1503/Ayra), a python based telegram userbot.
[](https://www.codefactor.io/repository/github/naya1503/pyayra)
[](https://pypi.org/project/py-Ultroid)
[](https://pypi.org/project/py-Ultroid)
[](https://github.com/naya1503/Ayra/graphs/commit-activity)
[](https://github.com/naya1503/Ayra)
[](https://makeapullrequest.com)
# Installation
```bash
pip3 install -U py-Ayra
```
# Documentation
[](http://ayra.tech/)
# Usage
- Create folders named `plugins`, `addons`, `assistant` and `resources`.
- Add your plugins in the `plugins` folder and others accordingly.
- Create a `.env` file with following mandatory Environment Variables
```
API_ID
API_HASH
SESSION
MONGO_URI
```
- Check
[`.env.sample`](https://github.com/naya1503/Ayra/blob/main/.env.sample) for more details.
- Run `python3 -m Ayra` to start the bot.
## Creating plugins
- ### To work everywhere
```python
@ultroid_cmd(
pattern="start"
)
async def _(e):
await e.eor("Ayra Started!")
```
- ### To work only in groups
```python
@ultroid_cmd(
pattern="start",
groups_only=True,
)
async def _(e):
await eor(e, "Ayra Started.")
```
- ### Assistant Plugins 👇
```python
@asst_cmd("start")
async def _(e):
await e.reply("Ayra Started.")
```
See more working plugins on [the offical repository](https://github.com/naya1503/Ayra)!
> Made with 💕 by [Kynan](https://t.me/Rizzvbss).
# License
[](LICENSE)
Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.
# Credits
* [](https://t.me/Rizzvbss)
* [Lonami](https://github.com/Lonami) for [Telethon](https://github.com/LonamiWebs/Telethon)
Raw data
{
"_id": null,
"home_page": "https://github.com/naya1503/pyAyra",
"name": "auroralibs",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.7, <3.11",
"maintainer_email": "",
"keywords": "",
"author": "naya1503",
"author_email": "cosmospanas70@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/db/b1/cfa8a4140c8208f71cd62703ebd4a2945d430bd487c698206e2f9222ab67/auroralibs-8.0.6.tar.gz",
"platform": null,
"description": "# py-Ultroid Library\n\nCore library of [The Ultroid](https://github.com/naya1503/Ayra), a python based telegram userbot.\n\n[](https://www.codefactor.io/repository/github/naya1503/pyayra)\n[](https://pypi.org/project/py-Ultroid) \n[](https://pypi.org/project/py-Ultroid) \n[](https://github.com/naya1503/Ayra/graphs/commit-activity)\n[](https://github.com/naya1503/Ayra)\n[](https://makeapullrequest.com)\n\n# Installation\n```bash\npip3 install -U py-Ayra\n```\n\n# Documentation \n[](http://ayra.tech/)\n\n# Usage\n- Create folders named `plugins`, `addons`, `assistant` and `resources`. \n- Add your plugins in the `plugins` folder and others accordingly. \n- Create a `.env` file with following mandatory Environment Variables\n ```\n API_ID\n API_HASH\n SESSION\n MONGO_URI\n ```\n- Check\n[`.env.sample`](https://github.com/naya1503/Ayra/blob/main/.env.sample) for more details. \n- Run `python3 -m Ayra` to start the bot. \n\n## Creating plugins\n - ### To work everywhere\n\n```python\n@ultroid_cmd(\n pattern=\"start\"\n) \nasync def _(e): \n await e.eor(\"Ayra Started!\") \n```\n\n- ### To work only in groups\n\n```python\n@ultroid_cmd(\n pattern=\"start\",\n groups_only=True,\n) \nasync def _(e): \n await eor(e, \"Ayra Started.\") \n```\n\n- ### Assistant Plugins \ud83d\udc47\n\n```python\n@asst_cmd(\"start\") \nasync def _(e): \n await e.reply(\"Ayra Started.\") \n```\n\nSee more working plugins on [the offical repository](https://github.com/naya1503/Ayra)!\n\n> Made with \ud83d\udc95 by [Kynan](https://t.me/Rizzvbss). \n\n\n# License\n[](LICENSE) \nUltroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.\n\n# Credits\n* [](https://t.me/Rizzvbss)\n* [Lonami](https://github.com/Lonami) for [Telethon](https://github.com/LonamiWebs/Telethon)\n",
"bugtrack_url": null,
"license": "GNU AFFERO GENERAL PUBLIC LICENSE (v3)",
"summary": "A Secure and Powerful Python-Telethon Based Library For Ayra Userbot.",
"version": "8.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/naya1503/pyAyra/issues",
"Documentation": "https://ultroid.tech",
"Homepage": "https://github.com/naya1503/pyAyra",
"Source Code": "https://github.com/naya1503/pyAyra"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0683530407ae969a0b6564853c781f1faa13f8adf2324e85ef2b6cd8bb3d974c",
"md5": "9a13b4e71c64faa098b9008369721d52",
"sha256": "70bf473d6925702643c8289c6ce0265aa4010a9bac0b588a5797effcbd06fb21"
},
"downloads": -1,
"filename": "auroralibs-8.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a13b4e71c64faa098b9008369721d52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7, <3.11",
"size": 107332,
"upload_time": "2023-05-03T19:10:45",
"upload_time_iso_8601": "2023-05-03T19:10:45.178222Z",
"url": "https://files.pythonhosted.org/packages/06/83/530407ae969a0b6564853c781f1faa13f8adf2324e85ef2b6cd8bb3d974c/auroralibs-8.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dbb1cfa8a4140c8208f71cd62703ebd4a2945d430bd487c698206e2f9222ab67",
"md5": "abb2b6040dfb33caa06ff89ae8ad132a",
"sha256": "e81f1e2bd588d40901ee7e14d2c663a88233e588e7a47a78463bba57b28f9b05"
},
"downloads": -1,
"filename": "auroralibs-8.0.6.tar.gz",
"has_sig": false,
"md5_digest": "abb2b6040dfb33caa06ff89ae8ad132a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7, <3.11",
"size": 84054,
"upload_time": "2023-05-03T19:10:47",
"upload_time_iso_8601": "2023-05-03T19:10:47.806292Z",
"url": "https://files.pythonhosted.org/packages/db/b1/cfa8a4140c8208f71cd62703ebd4a2945d430bd487c698206e2f9222ab67/auroralibs-8.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-03 19:10:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "naya1503",
"github_project": "pyAyra",
"github_not_found": true,
"lcname": "auroralibs"
}
JSON
