/reddit_mail_alerter

A simple script to run as a cronjob to log unread reddit messages to Gotify

Primary LanguagePythonMIT LicenseMIT

Reddit Mail Alerter

A simple script to run as a cronjob to log unread reddit messages to any number of logging handlers

Requirements

  • python3
  • see requirements.txt

Quickstart

  • Create a "script" application for Reddit's API here
  • Enter your user and API credentials in config.json, using config.json.example as a template
  • Configure logging as you wish
  • Simply run ./reddit_mail_alerter.py

Configuration Setup

See config.json.example for an example configuration file.

The auth_info section should contain a valid dictinary of arguments to provide to the praw.Reddit constructor, as detailed here. If the user_agent attribute is not provided, it will be set to "reddit_mail_alerter".

Arguments

Short Name Long Name Type Description
--config str Path to config file - defaults to ./config.json
N/A --avoid-marking-read bool If set, do not mark messages as read after alerting on them