Pluggable Telegram bot and userbot based on Telethon
Go to file
udf 06ff8e59de
press H for heuristics
2019-01-14 18:31:32 +02:00
disabledplugins move sp_kick_invite to disabled 2018-11-01 23:17:30 +02:00
stdplugins press H for heuristics 2019-01-14 18:31:32 +02:00
uniborg Merge branch 'master' into kate 2018-12-23 14:22:12 +02:00
.gitignore load api key from module 2018-12-26 23:28:41 +02:00
LICENSE Initial commit 2018-04-06 18:47:57 +03:00
README.md fix links 2018-11-09 21:08:59 +02:00
api_key.example.py load api key from module 2018-12-26 23:28:41 +02: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 load api key from module 2018-12-26 23:28:41 +02: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/udf/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.