Pluggable Telegram bot and userbot based on Telethon
Go to file
Dan Elkouby c1e3b2f3c3 Don't allow unloading _core
Prevents getting stuck with no way of administrating the bot
2018-07-01 17:44:56 +03:00
stdplugins all: handle replies 2018-06-24 15:49:45 +03:00
uniborg Don't allow unloading _core 2018-07-01 17:44:56 +03:00
.gitignore Create a Storage class and inject storage on plugins 2018-04-23 13:19:55 +02:00
LICENSE Initial commit 2018-04-06 18:47:57 +03:00
README.md Don't allow unloading _core 2018-07-01 17:44:56 +03:00
requirements-stdborg.txt create stdborg requirements file 2018-06-01 01:18:34 +01:00
requirements.txt Fix #13 2018-07-01 16:19:27 +03:00
stdborg.py Use connection_retries 2018-06-21 18:57:06 +03:00

README.md

uniborg

Pluggable asyncio Telegram userbot based on Telethon.

installing

Simply clone the repository and run the main file:

git clone https://github.com/uniborg/uniborg.git
cd uniborg
python stdborg.py

design

The modular design of the project enhances your Telegram experience through plugins which you can enable or disable on demand.

Each plugin gets the borg, logger and storage magical variables to ease their use. Thus creating a plugin as easy as adding a new file under the plugin directory to do the job:

# stdplugins/myplugin.py
from telethon import events

@borg.on(events.NewMessage(pattern='hi'))
async def handler(event):
    await event.reply('hey')

internals

The core features offered by the custom TelegramClient live under the uniborg/ directory, with some utilities, enhancements and the core plugin.

learning

Check out the already-mentioned plugins directory to learn how to write your own, and consider reading Telethon's documentation.