Updated README.md

master
salvadorpla 3 years ago
parent b23400ecec
commit 6c5070d2b8

@ -1,10 +1,10 @@
# mailing
Mail your Mastodon server inactive users and track their feedback, written in Python.
Mail your Mastodon server inactive users and track their feedback.
Any user can ask the bot for the weather of any country like this: @bot weather: New York
The bot will reply/toot with all the information given by OpenWeatherMap API.
To run this bot you need to get your API key at https://openweathermap.org/api
This code written in Python get all more than a year inactive users from Mastodon's database and email them with the subject and message of your choice.
Emailed inactive users data are stored into new Postgresql database to track feedback and status.
Run mailing.py periodically to catch 'new' inactive users and uptade the elapsed days of the already emailed ones.
### Dependencies
@ -16,7 +16,7 @@ To run this bot you need to get your API key at https://openweathermap.org/api
Within Python Virtual Environment:
1. Run 'db-setup.py' to create needed database and table and the rest of parameters. All inactive users collected data (see point 3) will be written there.
1. Run 'db-setup.py' to set database parameters and create needed database and table. All collected data of inactive users (see point 3) will be written there.
2. Run 'setup.py' to set your SMTP parameters and desired email subject. They will be saved to 'secrets/secrets.txt' for further use.

Loading…
Cancel
Save