Basic Reminder Bot
Have you ever wanted a reminder bot? Look no more! This bot is for you :D
Made with a 100% love.
Give the project a star!
Report Bug
·
Request Feature
About The Project
Hi there! In Telegram we have a lot of bots, from bots made for moderate groups to bots made to make UNO games. Made as a fun-made
Main modules
Bot installation
Setting up environment variables
In order to run the bot you have to set up the following environment variables:
- API_KEY - The API key provided by the bot father in Telegram
- DB_URI - MongoDB URI to store the reminders (support for SQL databases or CSV storage might be added)
Linux
export API_KEY="YOUR_API_KEY"
export DB_URI="mongodb+srv://YOUR_MONGODB_URI"
Windows
set API_KEY="YOUR_API_KEY"
set DB_URI="mongodb+srv://YOUR_MONGODB_URI"
Setting up the webhook
If we want to use our bot we need to set up a webhook, i.e., where we can receive the updates Telegram provides us. To achieve that we can use ngrok to get an HTTP/HTTPS URL or any host like heroku.
If we use heroku to host our Flask app it automatically will set up an URL for us, however, if we use ngrok instead to get an URL, we need to make sure that ngrok is running on the same host thar we are running our Flask app.
Once we have our URL and Flask app running, we need to make a request to setWebhook Telegram's endpoint.
Running the bot
You have 3 ways to run the bot:
- Using the flask module
- Running the python file
- Using a WSGI Server (such as Gunicorn)
Using Flask module
To start the bot using the Flask module you need to set up the "FLASK_APP" environment variable:
Linux
export FLASK_APP="main.py"
Windows
set FLASK_APP="main.py"
Once you've set your environment variables you can run your bot with:
python -m flask run
Running the python file
Starting the bot with this method is the easiest one, simply you need to type:
python main.py
And thats it!
Using a WSGI Server
There are multiple WSGI containers to choose from, here we will choose gunicorn as it is the easiest to set up.
First of all you need to install it via PIP
pip install gunicorn
Once we've done that we can start our Bot by doing
gunicorn main:app
And that's it, we should see our Bot being started :)
Usage of the bot
The bot is pretty much user-friendly, for now, we only have 2 commands (excluding the /help command):
- /remind - Used to create a reminder in format: /remind in <number> year(s) <number> month(s) <number> day(s) <number> hour(s) <number> minute(s). While replying a message.
Ex: /remind in 3 days - /myreminders - Replies with a list that contains your reminders.
And that's it! you now know how to use the bot:).
Extra - Setting up bot's language
To set up the bot's language you need to define the environment variable "lang", right now the bot is compatible with english and spanish. To use spanish set the "lang" variable to "es", if this variable isn't provided or any other language is provided the bot will use english on its config.
Contributing
Wanna contribute to the project? Great! Please follow the next steps in order to submit any feature or bug-fix :) You can also send me your ideas to my Telegram, any submit is greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the AGPL-3.0 License. See LICENSE
for more information.
Contact
Telegram: - @freshSauce
Project Link: https://github.com/freshSauce/Basic-Reminder-Bot
Changelog
0.1.0
- Code uploaded to Github.