{"id":13611076,"url":"https://github.com/TeamUltroid/pyUltroid","last_synced_at":"2025-04-13T01:34:23.716Z","repository":{"id":37409147,"uuid":"341040857","full_name":"TeamUltroid/pyUltroid","owner":"TeamUltroid","description":"[Ultroid] Base Library - Telethon","archived":false,"fork":false,"pushed_at":"2022-11-19T22:18:19.000Z","size":564,"stargazers_count":29,"open_issues_count":0,"forks_count":33,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-05-28T12:39:33.774Z","etag":null,"topics":["pip","pypi","python3","teamultroid","telegram","telegram-bot","telethon","ultroid","userbot"],"latest_commit_sha":null,"homepage":"https://t.me/TeamUltroid","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TeamUltroid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-22T01:00:10.000Z","updated_at":"2024-02-08T21:07:41.000Z","dependencies_parsed_at":"2023-01-21T11:47:07.767Z","dependency_job_id":null,"html_url":"https://github.com/TeamUltroid/pyUltroid","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamUltroid%2FpyUltroid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamUltroid%2FpyUltroid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamUltroid%2FpyUltroid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamUltroid%2FpyUltroid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamUltroid","download_url":"https://codeload.github.com/TeamUltroid/pyUltroid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223132227,"owners_count":17092637,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pip","pypi","python3","teamultroid","telegram","telegram-bot","telethon","ultroid","userbot"],"created_at":"2024-08-01T19:01:51.551Z","updated_at":"2024-11-07T17:31:18.578Z","avatar_url":"https://github.com/TeamUltroid.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# py-Ultroid Library\r\n\r\nCore library of [The Ultroid](https://github.com/TeamUltroid/Ultroid), a python based telegram userbot.\r\n\r\n[![CodeFactor](https://www.codefactor.io/repository/github/teamultroid/pyultroid/badge)](https://www.codefactor.io/repository/github/teamultroid/pyultroid)\r\n[![PyPI - Version](https://img.shields.io/pypi/v/py-Ultroid?style=round)](https://pypi.org/project/py-Ultroid)    \r\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/py-Ultroid?label=DOWNLOADS\u0026style=round)](https://pypi.org/project/py-Ultroid)    \r\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity)\r\n[![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/TeamUltroid/Ultroid)\r\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)\r\n\r\n# Installation\r\n```bash\r\npip3 install -U py-Ultroid\r\n```\r\n\r\n# Documentation \r\n[![Documentation](https://img.shields.io/badge/Documentation-Ultroid-blue)](http://ultroid.tech/)\r\n\r\n# Usage\r\n- Create folders named `plugins`, `addons`, `assistant` and `resources`.   \r\n- Add your plugins in the `plugins` folder and others accordingly.   \r\n- Create a `.env` file with following mandatory Environment Variables\r\n   ```\r\n   API_ID\r\n   API_HASH\r\n   SESSION\r\n   REDIS_URI\r\n   REDIS_PASSWORD\r\n   ```\r\n- Check\r\n[`.env.sample`](https://github.com/TeamUltroid/Ultroid/blob/main/.env.sample) for more details.   \r\n- Run `python3 -m pyUltroid` to start the bot.   \r\n\r\n## Creating plugins\r\n - ### To work everywhere\r\n\r\n```python\r\n@ultroid_cmd(\r\n    pattern=\"start\"\r\n)   \r\nasync def _(e):   \r\n    await e.eor(\"Ultroid Started!\")   \r\n```\r\n\r\n- ### To work only in groups\r\n\r\n```python\r\n@ultroid_cmd(\r\n    pattern=\"start\",\r\n    groups_only=True,\r\n)   \r\nasync def _(e):   \r\n    await eor(e, \"Ultroid Started.\")   \r\n```\r\n\r\n- ### Assistant Plugins 👇\r\n\r\n```python\r\n@asst_cmd(\"start\")   \r\nasync def _(e):   \r\n    await e.reply(\"Ultroid Started.\")   \r\n```\r\n\r\nSee more working plugins on [the offical repository](https://github.com/TeamUltroid/Ultroid)!\r\n\r\n\u003e Made with 💕 by [@TeamUltroid](https://t.me/TeamUltroid).    \r\n\r\n\r\n# License\r\n[![License](https://www.gnu.org/graphics/agplv3-155x51.png)](LICENSE)   \r\nUltroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.\r\n\r\n# Credits\r\n* [![TeamUltroid-Devs](https://img.shields.io/static/v1?label=TeamUltroid\u0026message=devs\u0026color=critical)](https://t.me/UltroidDevs)\r\n* [Lonami](https://github.com/Lonami) for [Telethon](https://github.com/LonamiWebs/Telethon)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamUltroid%2FpyUltroid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTeamUltroid%2FpyUltroid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamUltroid%2FpyUltroid/lists"}