Skip to main content

Function based library for telegram telethon projects.

Project description

py-Ultroid Library

Core library of The Ultroid, a python based telegram userbot.

CodeFactor PyPI - Version
PyPI - Downloads
Maintenance Open Source Love svg2 PRs Welcome

Installation

pip3 install -U py-Ultroid

Documentation

Documentation

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
    REDIS_URI
    REDIS_PASSWORD
    
  • Check .env.sample for more details.
  • Run python3 -m pyUltroid to start the bot.

Creating plugins

  • To work everywhere

@ultroid_cmd(
    pattern="start"
)   
async def _(e):   
    await e.eor("Ultroid Started!")   
  • To work only in groups

@ultroid_cmd(
    pattern="start",
    groups_only=True,
)   
async def _(e):   
    await eor(e, "Ultroid Started.")   
  • Assistant Plugins 👇

@asst_cmd("start")   
async def _(e):   
    await e.reply("Ultroid Started.")   

See more working plugins on the offical repository!

Made with 💕 by @TeamUltroid.

License

License
Ultroid is licensed under GNU Affero General Public License v3 or later.

Credits

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pyUltroid_fns-0.0.1b0-py3-none-any.whl (63.1 kB view details)

Uploaded Python 3

File details

Details for the file pyUltroid_fns-0.0.1b0-py3-none-any.whl.

File metadata

  • Download URL: pyUltroid_fns-0.0.1b0-py3-none-any.whl
  • Upload date:
  • Size: 63.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for pyUltroid_fns-0.0.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 101af69c3f90c4dc3f7f43e45ca5c150000a7f6970c14a0e48596894fe9a32c4
MD5 50dcd9a680efc501420f7889560ad24d
BLAKE2b-256 bfcf876c7128c28eefe89dffc08bdd5dde176dea5a9d79231cc61e3f5a89ef77

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page