fanbot | A bot to drive twitter and tweet positive things

Installation should go pretty quickly.
Clone this repository - git clone https://github.com/rpalo/fanbot.git && cd fanbot
(Optional) Create a virtual environment for the application - python3 -m venv .venv If you name it .venv, the .gitignore file will ignore it by default.
(Required only if you did step 2) Activate your virtual environment
Windows PowerShell: .venv/scripts/activate
*nix: source .venv/bin/activate
Install the required packages - pip3 install -r requirements.txt
Create your secrets file - mv fanbot/secrets.sample.py fanbot/secrets.py
Create a twitter account for your bot.
While logged in as this bot, create a twitter app for your bot.
From the "Keys and Access Tokens" tab of your new app, create a new key.
Take note of your Consumer Key, Consumer Secret, Access Token, and Access Token Secret.
Fill these values into your secrets.py file. Also fill in the username of the account you wish to be a fan of.
Fill out the main.py file with instructions of your own. Take note of Twitter's rate limiting policy. See the schedule module documentation for more info.
Run the tests to make sure everything's working right. In the main folder, simply type pytest. (As is evident, this uses Pytest. If you prefer nose or another testing tool, you might have to do some tweedling before you can test. Or maybe not. Not sure.)
Let 'er rip! python3 main.py
(Optional) Set up your bot as a service so it will run on a remote server and have output logs and you can leave it alone the "right way".
Included in the main folder is a file fanbot.service.
You'll need to edit this folder to include the absolute path to your python executable and your main.py file. You can also include any command-line arguments.
Once you've got your service file ready, copy it to /lib/systemd/system: sudo cp fanbot.service /lib/systemd/system/fanbot.service
It needs permissions of 644 to work: sudo chmod 644 /lib/sytemd/system/fanbot.service
Then referesh systemd to make sure it's managing your service: $ sudo systemctl daemon-reload $ sudo systemctl enable fanbot.service
Make sure everything works properly: $ sudo reboot ... $ sudo systemctl status fanbot.service # You should see something good like "active" with a few startup logs.
(Optional) To run the service from inside your virtual environment, simply point the python executable to the one in your .venv folder (i.e. /home/{{ you }}/fanbot/.venv/bin/python). The rest will work as expected.