Tools for scraping and analyzing Reddit and for messaging Redditors. The tools help messages (as of 2022-10-27) are below.
reddit-search.py
❯ reddit-search.py -h
usage: reddit-search.py [-h] [-r] [-c COLUMN] [-L] [-V] [--version] FILE
Facilitate a search of phrases appearing in a spreadsheet column
(default: 'phrase') by generating queries against search engines and
opening the results in browser tabs. Search engines include Google,
Reddit, and RedditSearch/Pushshift.
> reddit-search.py demo-phrases.csv -c phrase
If you wish to test the efficacy of a disguised/spun phrase, also
include a column of the spun phrase and the 'url' of the source. This
will automatically check the results for that URL.
> reddit-search.py demo-phrases.csv -c weakspins
positional arguments:
FILE
options:
-h, --help show this help message and exit
-r, --recheck recheck non-NULL values in 'found' column
-c COLUMN, --column COLUMN
sheet column to query [default: 'phrase']
-L, --log-to-file log to file reddit-search.py.log
-V, --verbose Increase verbosity (specify multiple times for more)
--version show program's version number and exit
reddit-query.py
usage: reddit-query.py [-h] [-a AFTER] [-b BEFORE] [-l LIMIT]
[-c COMMENTS_NUM] [-r SUBREDDIT]
[--sample] [--skip] [-t] [-L] [-V] [--version]
Query Pushshift and Reddit APIs.
options:
-h, --help show this help message and exit
-a AFTER, --after AFTER
submissions after: epoch, integer[s|m|h|d],
or Y-m-d (pendulum). Using it without before
starts in 1970!
-b BEFORE, --before BEFORE
submissions before: epoch, integer[s|m|h|d], or
Y-m-d (pendulum).
-l LIMIT, --limit LIMIT
limit to (default: 5) results
-c COMMENTS_NUM, --comments_num COMMENTS_NUM
number of comments threshold '[<>]\d+]'
(default: False). Note: this is
updated as Pushshift ingests, `score` is not.
-r SUBREDDIT, --subreddit SUBREDDIT
subreddit to query (default: AmItheAsshole)
--sample sample complete date range up to limit,
rather than first submissions
within limit
--skip skip all Reddit fetches; pushshift only
-t, --throwaway-only only throwaway accounts ('throw' and 'away')
and get fetched from Reddit
-L, --log-to-file log to file reddit-query.py.log
-V, --verbose increase logging verbosity (specify multiple
times for more)
--version show program's version number and exit
reddit-watch.py
usage: reddit-watch.py [-h] [-i INIT] [--hours HOURS] [-L] [-V] [--version]
Watch the deletion/removal status of Reddit messages. Initialize subreddits to
be watched first (e.g., 'Advice+AmItheAsshole). Schedule using cron or launchd
options:
-h, --help show this help message and exit
-i INIT, --init INIT INITIALIZE `+` delimited subreddits to watch
--hours HOURS previous HOURS to fetch
-L, --log-to-file log to file reddit-watch.py.log
-V, --verbose increase logging verbosity (specify multiple
times for more)
--version show program's version number and exit
reddit-message.py
usage: reddit-message.py [-h] -i FILENAME [-a FILENAME] [-g FILENAME]
[-d] [-e] [-p] [-t] [-r RATE_LIMIT] [-s]
[-D] [-L] [-V] [--version]
Message Redditors using usernames in CSV files from reddit-query.py
or reddit-watch.py .
options:
-h, --help show this help message and exit
-i FILENAME, --input-fn FILENAME
CSV filename, with usernames, created by reddit-query.py
-a FILENAME, --archive-fn FILENAME
CSV filename of previously messaged users to skip;
created if doesn't exist
(default: reddit-message-users-past.csv)
-g FILENAME, --greeting-fn FILENAME
greeting message filename (default: greeting.txt)
-d, --only-deleted select deleted users only
-e, --only-existent select existent (NOT deleted) users only
-p, --only-pseudonym select pseudonyms only (NOT throwaway)
-t, --only-throwaway select throwaway accounts only ('throw' and 'away')
-r RATE_LIMIT, --rate-limit RATE_LIMIT
rate-limit in seconds between messages (default: 40)
-s, --show-csv-users also show all users from input CSV on terminal
-D, --dry-run list greeting and users but don't message
-L, --log-to-file log to file reddit-message.py.log
-V, --verbose increase logging verbosity (specify multiple
times for more)
--version show program's version number and exit