frizz925 / shippostbot

Your friendly bot for pairing your favorite anime characters, ShippostBot

ShippostBot

Your friendly bot for pairing your favorite anime characters, ShippostBot

Usage

Requirements

Here are the requirements in order to use the bot:

• Python 3.7
  • pip
  • virtualenv
• ImageMagick
• Git

Furthermore, the bot had only been tested to work on Ubuntu 18.04. It may still work on other platforms like macOS and Windows if you have the required tools and software, but they have not been tested yet.

Setup

The following commands assume that you're using bash or similar shell.

Clone the repository using Git.

git clone https://github.com/Frizz925/shippostbot.git
cd shippostbot

It is recommended to create a virtualenv in order to keep the bot in an isolated environment so that it would work normally.

virtualenv -p $(which python3.7) .venv
source .venv/bin/activate

At this point, you should be inside an isolated environment of virtualenv. You can then use pip to install the required Python packages.

pip install -r requirements.txt

Testing

Simply run the following command to see if the test cases pass successfully.

python -m unittest

Using the bot

After that, simply run the bot's package module to start using the bot.

python -m shippostbot

Command line arguments

Options:
  -t, --selection-type TEXT  Define how the bot selects the characters
  -p, --publisher TEXT       Which publisher to use to publish the post
  -s, --storage TEXT         Storage type to be used by the bot
  --help                     Show this message and exit.

Environment variables

General environment variables

Variables	Description
FACEBOOK_ACCESS_TOKEN	Access token for Facebook Graph API
S3_REGION	The region where the S3 bucket is located
S3_BUCKET_NAME	The name of the S3 bucket

Deployment

TBA

Issues and Suggestions

Should you find any issues with the bot or if you happen to have any suggestions to further improve the bot, you can head over to the Issues page.

License

GPL-3.0