forked from kate/uniborg
f80b450fcf | ||
---|---|---|
stdplugins | ||
uniborg | ||
.gitignore | ||
LICENSE | ||
README.md | ||
requirements-stdborg.txt | ||
requirements.txt | ||
stdborg.py |
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.