Message Sender — Telegram Bot

A telegram bot that sends messages to the different platforms.

From the receiver's (that is, a bot's owner's) side, it helps to concetrate only on the important messages and to not worry, that you miss something. From the sender's (for example, friend's) side, it gives a handy Telegram interface that simplify a using of the message sender.

Running

Before reading this chapter, ensure that you have an installed and set up MariaDB or MySQL.

Steps to set up the project:

1. Clone the repository:

   git clone https://github.com/roli2py/message-sender-telegram-bot

2. Navigate to the repository

   cd message-sender-telegram-bot

3. Install the package by uv (recommended) or pip:

   # Install by `uv`
   uv sync
   
   # ...or by `pip`
   pip install .

4. Fill a sqlalchemy.url property in the alembic.ini file:

   # ...
   # replace the placeholders to appropriate data
   sqlalchemy.url = mysql+pymysql://user:pass@host:port/dbname
   # ...

5. Migrate the database by alembic:

   alembic upgrade head

6. Duplicate the example.env file and name it to .env:

   cp example.env .env

7. Fill the .env file with the appropriate data.
8. Export the .env file to your environment:

   set -a && source .env && set +a

   Reference: https://gist.github.com/mihow/9c7f559807069a03e302605691f85572
9. Run the main module of the message_sender_telegram_bot package:

   python3 -m message_sender_telegram_bot.main

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md.

Code of Conduct

See CODE_OF_CONDUCT.md.

License

See LICENSE.