RTID, an acronym for "Reddit Top Images Downloader", is a python script for downloading top images from Reddit's subreddits by using PRAW ("Python Reddit API Wrapper").
python3 src/main.py [options]
Install packages by running pip3 install -r .\requirements.txt
- PRAW: PRAW, an acronym for "Python Reddit API Wrapper", is a python package that allows for simple access to Reddit's API. PRAW aims to be easy to use and internally follows all of Reddit's API rules.
You need to have credentials to be able to use Reddit api. For instructions on setting Reddit to authenticate on non-reddit websites and applications, check Reddit OAuth2.
Set the following variables as environment variable in order to use RTID:
REDDIT_CLIENT_ID
REDDIT_CLIENT_SECRET
REDDIT_USERNAME
REDDIT_PASSWORD
REDDIT_USER_AGENT
[src/main.py] Main script for executing the program. Example run: Without parameters:
python3 main.py
With parameters:
python3 main.py --subreddit_name witcher --post_limit 60 --min_upvote 1500
Script will create folder named RTID_Downloads
and create folder with given subreddit name. Then download images to here.
When the script is completed, the images will be saved in ./RTID_Downloads/<SUBREDDIT_NAME>/<CURRENT_DATE>
-
--help
Print help message. -
--subreddit_name
Which subreddit to get images. Default is art subreddit. -
--post_limit
Number of post submissions to look up. Default is 10. -
--min_upvote
Minimum number of upvote to filter. Default is 1000 upvotes.