Every Telegram bot needs token from the @BotFather. When registering a token, keep in mind:
- For participating in groups, Group mode should be enabled;
- To see group message history, Group privacy mode should be disabled.
Options must be passed via configuration.ini file. By default, bot will be looking for configuration.ini file in the
root directory (same level with this README file), or you can specify other path using --config parameter.
See comments in __init__.py files in app/bot directory (ideally, this is only directory you should be working with).
Of course, you are free to take a look/change code in the rest of the project, however, template is configured so that
only app/bot should be changed. Some functions/definitions for you to use are exposed in app/public module.
- Define your data models in
app/bot/modelsmodule. - Generate DB migrations for new models in
app/bot/migrations(usingscripts/update_migrations.py) - Place your handlers logic in
app/bot/coremodule. - Add your handlers to the appropriate file in
app/bot/routingmodule.
Project root directory should be added to PYTHONPATH. There are few scripts in /scripts directory, that are useful
for the development:
update_migrations.py: autogenerate migrations from the updated models. Requires configuration.run_tests.py: launch python tests.run_bot.py: launch bot itself. Requires configuration.
Path to db directory is optional.
docker run --restart always --name <instance name> -d \
-v <path to configuration>:/instance/configuration.ini \
-v <path to the db directory>:/build \
<docker image name>