Contributing

Hello everybody! 💪

Any contribution to this project is appreciated and welcomed 😎 Just make sure that you follow these simple rules:

Please, name your branch like: feat/... | fix/... | chore/... [in brief, use the correct prefix to indicate if it is a new feature, some fix or a version upgrade]
Open a new PR and let's see if what you did works on PartitelleBotTest [as a best practice, the PR title should be like: feat: ... | fix: ... | chore: ...]
If it works, I bring your contribution to PartitelleBot

Best, Giovanni

Init the environment

To init the environment, run the following commands:

pyenv install
pyenv local
pip install -r requirements.txt

Make sure that the python version is the one specified in the .python-version file:

python --version

Create a .env file and fill it with the correct values. You can use the default.env file as a template.

To run the tests, run the following command:

python -m unittest discover test

To run the bot, run the following command:

python main.py

If you're running the bot locally (ENV = local), the bot will start polling messages from Telegram.

If you're running the bot on other environments (ENV != local), the bot will start a webhook listener instead.

This is useful to test the bot on a local environment before pushing the changes to the remote server.