# py-Ayra Library
Core library of [The Ayra](https://github.com/naya1503/Ayra), a python based telegram userbot.
[](https://pypi.org/project/py-Ayra)
[](https://pypi.org/project/py-Ayra)
[](https://github.com/naya1503/Naya-Userbot/graphs/commit-activity)
[](https://github.com/naya1503/Naya-Userbot)
[](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/py-Ayra/blob/main/.env.sample) for more details.
- Run `python3 -m Ayra` to start the bot.
## Creating plugins
- ### To work everywhere
```python
@ayra_cmd(
pattern="start"
)
async def _(e):
await e.eor("Ayra Started!")
```
- ### To work only in groups
```python
@ayra_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/py-Ayra)!
> Made with 💕 by [Kynan](https://t.me/kenapanan).
# License
[](LICENSE)
Naya-Userbot 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/kenapanan)
* [Lonami](https://github.com/Lonami) for [Telethon](https://github.com/LonamiWebs/Telethon)
Raw data
{
"_id": null,
"home_page": "https://github.com/naya1503/pyAyra",
"name": "py-Ayra",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.7, <3.12",
"maintainer_email": "",
"keywords": "",
"author": "naya1503",
"author_email": "cosmospanas70@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9a/14/4164fd5880c944fd6df3b569d2ad62b0f312bea98534b74441e8a9a0a45e/py-Ayra-2.1.6.tar.gz",
"platform": null,
"description": "# py-Ayra Library\n\nCore library of [The Ayra](https://github.com/naya1503/Ayra), a python based telegram userbot.\n\n[](https://pypi.org/project/py-Ayra) \n[](https://pypi.org/project/py-Ayra) \n[](https://github.com/naya1503/Naya-Userbot/graphs/commit-activity)\n[](https://github.com/naya1503/Naya-Userbot)\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/py-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@ayra_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@ayra_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/py-Ayra)!\n\n> Made with \ud83d\udc95 by [Kynan](https://t.me/kenapanan). \n\n\n# License\n[](LICENSE) \nNaya-Userbot 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/kenapanan)\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": "2.1.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": "43843ed3a46d87a46e859dac6d63acbcbd31701a1624d1da9522d336128d52a8",
"md5": "ee721e24d78dc985517c3575067ef87f",
"sha256": "1cd74d043967f133efc7ac85a4152f551aa089bc179e64c2f6278907a1df9a4d"
},
"downloads": -1,
"filename": "py_Ayra-2.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee721e24d78dc985517c3575067ef87f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7, <3.12",
"size": 105864,
"upload_time": "2023-12-20T15:33:46",
"upload_time_iso_8601": "2023-12-20T15:33:46.730300Z",
"url": "https://files.pythonhosted.org/packages/43/84/3ed3a46d87a46e859dac6d63acbcbd31701a1624d1da9522d336128d52a8/py_Ayra-2.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a144164fd5880c944fd6df3b569d2ad62b0f312bea98534b74441e8a9a0a45e",
"md5": "73335ed8f93cbc3a0fa0d6e4df7f0a96",
"sha256": "d0586df346ec9e026db59443d344773387a6fd54bff6f7e6a5ba82c7a810c8e5"
},
"downloads": -1,
"filename": "py-Ayra-2.1.6.tar.gz",
"has_sig": false,
"md5_digest": "73335ed8f93cbc3a0fa0d6e4df7f0a96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7, <3.12",
"size": 82676,
"upload_time": "2023-12-20T15:33:48",
"upload_time_iso_8601": "2023-12-20T15:33:48.307623Z",
"url": "https://files.pythonhosted.org/packages/9a/14/4164fd5880c944fd6df3b569d2ad62b0f312bea98534b74441e8a9a0a45e/py-Ayra-2.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-20 15:33:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "naya1503",
"github_project": "pyAyra",
"github_not_found": true,
"lcname": "py-ayra"
}
JSON
