bobby-b-bot / reddit

Reddit client for Bobby B Bot

Bobby B Bot - Reddit version

In this repository you can find the Reddit (and original) version of the Bobby B Bot.

How to use it

Simply write one of the keywords (usually variations of the bot's name) in a comment in the subreddits the bot is listening on, and the bot will reply with a random quote.

• Only listens on mentioned subreddits to avoid spamming other subs.
• Always follow and comply with Reddit bot rules and best practices: bottiquette

How to install

1. Create a virtual environment and activate it (this is optional but when working with Python, I cannot recommend it enough) or create a root folder that will hold all the code;
2. Clone reddit repository inside this virtual enviroment folder (let's call it 'root') and then clone utils repository. The final structure should be somewhat similar to this:

+ root
└───+ reddit
│     |-- praw.ini 
│     |-- blocked_users.json
│     |-- subs.json
│     |-- reddit_bot.py
└───+ utils
      |-- __init__.py
      |-- core.py
      |-- logging_config.ini
      |-- quotes.json
      |-- triggers.json

4. Run command pip install -r requirements.txt in reddit directory (this should install the requirements for utils as well, otherwise, you can also run the command in utils folder);
5. Done, you are ready to configure it.

TL;DR Installation:

$ python -m venv <venv_name>
$ cd venv_name
$ source bin/activate
(venv_name) $ git clone https://github.com/bobby-b-bot/reddit.git
(venv_name) $ git clone https://github.com/bobby-b-bot/utils.git
(venv_name) $ cd reddit
(venv_name) $ pip install -r requirements.txt

How to configure and run

1. Create and maintain the .env file for environment variables in reddit folder (ENV = 'TEST' or 'PROD' and TST_SUBS);
2. Create and maintain the praw.ini file for PRAW (Python Reddit API) in root reddit folder (see PRAW documentation);
3. Create and mantain a logging_config.ini file in utils folder for logging configuration (see documentation);
4. Run the bot (python reddit_bot.py).
5. Have fun!

How to contribute

Feature requests such as new quotes or more subreddits to run the bot on are welcome via issues on GitHub! Feel free to contribute. You can also contribute by donating via Ko-fi or PayPal to keep the servers running.