Add README.md

This commit is contained in:
Homer S. 2018-01-28 17:33:48 +00:00
commit e2b77597b9
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# README
## About mastobot
This simple pyton3 script's purpose is just to copy a number of twitter accounts' statuses to corresponding Mastodon accounts.
## Prerequisites
To use #mastobot you need to install tweepy, Mastodon.py and wget. To do so you could e.g. just use pip3 by entering commandline:
``` sudo pip3 install tweepy ```
and vice versa.
Also, you have of course to register the goal accounts on Mastodon and to adjust both the mastodon.py file's _setting_path_ pointing to the absolute path to the settings.json file and
the setting.json file itself regarding to your needs.
Above this you need a twitter developer account to receive consumer and access keypairs. For a HowTo please take a look at the tweepy documentation.
## Usage
After having filled in every information into the settings.json file you could use e.g. ```crontab -e``` on unixoid systems from shell and add a line like
```*/15 * * * * python3 /home/username/mastobot/mastobot.py >> /home/username/mastobot.log``` which lets the script be triggered every 15 minutes.
By default the script will be limited to 25 tweets per account for this period which should definitely be enough for a human account I think.