Async bot framework for Telegram Messenger designed for Python >= 3.5.
Named after シー・ツー
Clone the repo, fill settings.py with your settings. Run:
python3 cc.py
You can also run bot with different config module. For example, if your settings file is called settings_test.py, run:
python3 cc.py -s settings_test
You can daemonize bot by adding -d option:
python3 cc.py -d
To get all available options check:
python3 cc.py --help
All modules should be written with async in mind, since modules executor is non-blocking and built on top of Python's asyncio.
However, if you write blocking module, it will not block main event loop anyway, CC is designed to run blocking module in another thread.
Async modules should define main method as async def main(bot, *args, **kwargs) and use await keyword where it's needed. You can check some modules inside modules dir of this repo and see differences between blocking and non-blocking modules.
Module types:
user_*- command called with '/command' syntax, available for all usersowner_*- command called with '/command' syntax, available only for owner (there'sowneroption in the settings)audio_*- module will be called on each audio messagevideo_*- called on each video messagetext_*- called on each text messagephoto_*- called on each message with photosticker_*- called on each message with sticker
Check currently available modules by running /lsmod command in chat.
You can run the full test suite using:
python3 -m unittest discover tests