Skip to content

essaNAJJAR/Userge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8d2909e · Jul 5, 2020
May 5, 2020
Jul 5, 2020
May 26, 2020
May 24, 2020
May 26, 2020
May 26, 2020
May 14, 2020
Mar 15, 2020
Mar 27, 2020
Jun 7, 2020
Jul 2, 2020
Jul 2, 2020
Mar 16, 2020
Jul 2, 2020
Jun 2, 2020
Mar 23, 2020
May 26, 2020
Jul 2, 2020

Repository files navigation

Userge
Pluggable Telegram UserBot
Inspiration  •  Features  •  Example  •  Requirements  •  Project Credits  •  Copyright & License

Userge 🔥

Build Status Python Version Release Stars Forks Issues Open Issues Closed PR Open PR Closed Contributors Repo Size License Commit Activity Plugins Repo! Join Channel! DeepSource

Userge is a Powerful , Pluggable Telegram UserBot written in Python using Pyrogram.

Inspiration 😇

This project is inspired by the following projects :)

Special Thanks to all of you !!!.

Features 😍

  • Powerful and Very Useful built-in Plugins
    • gdrive [ upload / download / etc ] ( Team Drives Supported! ) 🤥
    • zip / tar / unzip / untar / unrar
    • telegram upload / download
    • pmpermit / afk
    • notes / filters
    • split / combine
    • gadmin
    • plugin manager
    • etc...
  • Channel & Group log support
  • Database support
  • Build-in help support
  • Easy to Setup & Use
  • Easy to add / port Plugins
  • Easy to write modules with the modified client

Example Plugin 🤨

from userge import userge, Message

LOG = userge.getLogger(__name__)  # logger object

CHANNEL = userge.getCLogger(__name__)  # channel logger object

@userge.on_cmd("test", about="help text to this command")  # adding handler and help text to .test command
async def testing(message: Message):
   LOG.info("starting test command...")  # log to console

   await message.edit("testing...", del_in=5)  # this will be automatically deleted after 5 sec

   await CHANNEL.log("testing completed!")  # log to channel

Requirements 🥴

How To Deploy 👷

  • HEROKU Method 🔧

    First click the button below.

    If you don't have HU_STRING_SESSION just ignore it.

    After Deployed to Heroku first turn off the app (resources -> turn off) and run bash genStr in console (more -> run console).

    After that copy the string session and past it in Config Vars (settings -> reveal config vars).

    Finally turn on the app and check the logs (settings -> view logs) :)

    Deploy

  • Other Method 🔧

    # clone the repo
    git clone https://github.com/UsergeTeam/Userge.git
    cd Userge
    
    # create virtualenv
    virtualenv -p /usr/bin/python3 venv
    . ./venv/bin/activate
    
    # install requirements
    pip install -r requirements.txt
    
    # Create config.env as given config.env.sample and fill that
    cp config.env.sample config.env
    
    # get string session and add it to config.env
    bash genStr
    
    # finally run the Userge ;)
    bash run
  • More Detailed Guide 📝

TODO: add Docker Support.

Video Tutorial 🎥

Tutorial

Support & Discussions 👥

Head over to the Discussion Group and Update Channel

Project Credits 💆‍♂️

Copyright & License 👮

About

Userge, Durable as a Serge

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 96.5%
  • Shell 3.5%