Hi! Welcome to AlarmBot!
The project is an easy house alarm managed by a Telegram Bot.
🏅 Badges
🎬 Demo
⚙️ Install
👨 Author
©️ License
Project.
Checks.
AlarmBot comes up as a personal project that aspires to define an useful and simple Telegram Bot to manage a home alarm system. It just defines the registration system and the API to notify users via Telegram, not the alarm trigger.
For that purpose, it will use the pyTelegramBotAPI library to define a Telegram Bot, together with FastAPI as the framework for the API that triggers notifications, together with Uvicorn as ASGI web server.
AlarmBot is a simple system whose deployment just depends on a .env file that contains a Token from Telegram Bot (if you don't know how to obtain one, follow this official tutorial).
Now, the available commands to work with AlarmBot are listed:
Execute AlarmBot Starts a Telegram Bot and defines a FastAPI API with Uvicorn.
invoke executeStop AlarmBot Stops the execution by killing the related processes.
invoke stopClean AlarmBot Cleans the python caché and log files from both APIs.
invoke cleanTo install all dependencies you just need to execute the following:
pip3 install -r requirements.txtAlarmBot is an open source project that is open for new contributions if you want to. To contribute to the project you can contact me or just open a new pull request. Thanks in advance!
Carlos Morales Aguilera
GPLv3: The permissions under this strong copyleft license are conditional on making the full source code of the licensed works and modifications, including larger works using a licensed work, available under the same license. Copyright and licensing notices should be retained. Taxpayers provide an express grant of patent rights.
Permissions:
- Commercial use.
- Distribution.
- Modification.
- Use of patent.
- Private use.
Conditions:
- Reveal source.
- License and copyright notice.
- Same license.
- State changes.
Limitations:
- Responsibility.
- Warranty.