FlairTimerModMail

FlairTimerModMail is a Reddit bot designed to monitor new posts in a specified subreddit for a particular flair. When a post receives the target flair, the bot starts a timer. If the flair remains on the post for a configurable number of hours, the bot sends a modmail notification to the subreddit moderators. This tool is useful for subreddits that use flairs to track posts requiring moderator attention or follow-up.

Features

Monitors new posts in a subreddit for a specific flair
Tracks how long a post has had the flair
Sends a modmail notification after a configurable time period
Configurable via environment variables or a config file
Supports running natively with Python or in Docker (standalone or with Docker Compose)

Requirements

Python 3.8+
Reddit API credentials (see below)

Configuration

The bot can be configured using a config/config.py file or via environment variables. When running in Docker, environment variables are recommended and can be managed with a .env file.

Required Configuration Values

USERNAME: Reddit username
PASSWORD: Reddit password
CLIENT_ID: Reddit API client ID
CLIENT_SECRET: Reddit API client secret
USER_AGENT: User agent string for Reddit API
SUBREDDIT: Subreddit to monitor
FLAIR_TEXT: Flair text to track (case sensitive)
INTERVAL: How often to scan (seconds)
HOURS: How many hours before sending notification
MESSAGETITLE: Title for the modmail message
SEARCHLIMIT: How many posts to scan (max 1000)

Installation & Usage

1. Python (Native)

Clone the repository:

git clone https://github.com/slfhstd/FlairTimerModMail.git
cd FlairTimerModMail

Install dependencies:
```
pip install -r requirements.txt
```
Copy example.env to .env and fill in your Reddit credentials and settings, or edit config/config.py directly.
Run the bot:
```
python flairtimermodmail.py
```

2. Docker Run

Copy example.env to .env and fill in your values.

Run the bot with Docker:

docker run --env-file .env -v $(pwd)/config:/app/config ghcr.io/slfhstd/flairtimermodmail:latest

3. Docker Compose