boilergram is a framework that helps you build your telegram bots using aiogram!
boilergram enforces and looks after a django-like structure of your project. Thus, you can focus on writing actual code and not worry about your project getting messy & unextendable.
boilergram is just an additional layer between the developer and the actual framework communicating with Telegram. boilergram does not in any way modify aiogram behaviour nor does it change the actual behaviour of your bot.
- Python >=3.11
- git
Install the package using a package manager of your choice. It is recommended that you use a virtual environment or any other dependency isolation tool when doing so. E.g.:
pip install boilergramAfter installing the package you can jumpstart your
aiogram's
project using the init command:
boilergram initboilergram will prompt you the required information and create your project. The project's tree would look like this:
mybot/
├── manage.py
└── mybot/
├── __init__.py
└── settings.py
Fill the mandatory variables (i.e. bot api token) in the
settings.py file, then start your freshly-baked bot
using manage.py!
python myproject/manage.py runbotThat's it for the basic usage. For more info on managing your project and creating your own apps, refer to the official documentation.
Refer to the Contributing Guidelines
boilergram is HEAVILY backed by aiogram. Leave them a star.