Simple Reddit Bot Library
Project description
Bottr makes writing bots for reddit easy. It currently provides two predefined bots:
- CommentBot:
Listens to new comments in a list of subreddits
- SubmissionBot:
Listens to new submission in a list of subreddits
Bottr makes use of the Python Reddit API Wrapper PRAW.
Documentation: bottr.readthedocs.io
Check out [bottr-template](https://github.com/slang03/bottr-template) for a convenient code template to start with.
Installation
Bottr is available on PyPi and can be installed via
$ pip install bottr
Quick Start
The following is a quick example on how to monitor r/AskReddit for new comments. If a comment
contains the string 'banana'
, the bot replies 'This comment is bananas.'
import praw
import time
from bottr.bot import CommentBot
def parse_comment(comment):
"""Define what to do with a comment"""
if 'banana' in comment.body:
comment.reply('This comment is bananas.')
if __name__ == '__main__':
# Get reddit instance with login details
reddit = praw.Reddit(client_id='id',
client_secret='secret',
password='botpassword',
user_agent='Script by /u/...',
username='botname')
# Create Bot with methods to parse comments
bot = CommentBot(reddit=reddit,
func_comment=parse_comment,
subreddits=['AskReddit'])
# Start Bot
bot.start()
# Run bot for 10 minutes
time.sleep(10*60)
# Stop Bot
bot.stop()
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bottr-0.1.4.tar.gz
(6.6 kB
view hashes)
Built Distribution
bottr-0.1.4-py3-none-any.whl
(8.7 kB
view hashes)