Welcome to RedditImageDownloader, a simple Python module for effortlessly batch downloading media from Reddit! ๐
This tool leverages the Reddit API and the PRAW library to seamlessly fetch post information and download the corresponding images in async/await method. The script uses built-in md5-based duplicate removal for initial data cleaning purpose to avoid downloading the same image that was posted to multiple subreddits.
- clone the repository
git clone https://github.com/kaledgar/RedditImageDownloader
- Create
authorized reddit application
, read aboutReddit API
and obtain the necessary credentials, such as the client ID, client secret, username, password, and user agent. Store these credentials in a JSON filecredentials.json
in your local repository that you cloned.
{
"username": "your reddit username",
"password": "pw to your reddit account",
"user_agent": "anything here",
"client_secret": "client secret of reddit app you create",
"client_id": "app id, see below for details"
}
- Customize the constants.py file if needed, adjusting default file paths or other constants according to your preferences.
- Install the required dependencies:
# Install requirements
pip install -r requirements.txt
# Check possible arguments
python3 -m reddit_image_downloader -h
# Run module with your custom arguments
python3 -m reddit_image_downloader -u example_user -d 'mnt/d/Downloads'
The last command runs the script and downloads media from users given in list and saves it in separate directories.
To use the "Reddit Image Downloader" with Docker, follow these steps:
- Adjust the Dockerfile up to your preferences
# build docker image
docker build -t reddit-image-downloader .
# run
docker run -v /your/local/directory:/app/downloads reddit-image-downloader
To use pre-commit
during the development run:
python3 -m venv .vev
source .venv/bin/activate
pip install pre-commit
pre-commit install
.pre-commit-config.yaml
stores the pre-commit
configuration.
In authorized reddit application
settings:
- WIN - Run the script in Powershell Admin session
- Linux - run script with sudo