bulk-downloader-for-reddit/README.md
2018-08-01 13:08:09 +03:00

6.0 KiB

Bulk Downloader for Reddit

Downloads media from reddit posts.

Download the latest release

What it can do

  • Can get posts from: frontpage, subreddits, multireddits, redditor's submissions, upvoted and saved posts; search results or just plain reddit links
  • Sorts posts by hot, top, new and so on
  • Downloads REDDIT images and videos, IMGUR images and albums, GFYCAT links, EROME images and albums, SELF POSTS and any link to a DIRECT IMAGE
  • Skips the existing ones
  • Puts post title and OP's name in file's name
  • Puts every post to its subreddit's folder
  • Saves a reusable copy of posts' details that are found so that they can be re-downloaded again
  • Logs failed ones in a file to so that you can try to download them later

How it works

Additional options

Script also accepts additional options via command-line arguments. Get further information from --help

Setting up the script

You need to create an imgur developer app in order API to work. Go to https://api.imgur.com/oauth2/addclient and fill the form (It does not really matter how you fill it). It should redirect you to a page where it shows your imgur_client_id and imgur_client_secret.

FAQ

What do the dots resemble when getting posts?

  • Each dot means that 100 posts are scanned.

Getting posts is taking too long.

  • You can press Ctrl+C to interrupt it and start downloading.

How are filenames formatted?

  • Self posts and images that are not belong to an album are formatted as [SUBMITTER NAME]_[POST TITLE]_[REDDIT ID]. You can use reddit id to go to post's reddit page by going to link reddit.com/[REDDIT ID]

  • An image in an imgur album is formatted as [ITEM NUMBER]_[IMAGE TITLE]_[IMGUR ID] Similarly, you can use imgur id to go to image's imgur page by going to link imgur.com/[IMGUR ID].

How do I open self post files?

  • Self posts are held at reddit as styled with markdown. So, the script downloads them as they are in order not to lose their stylings. However, there is a great Chrome extension for viewing Markdown files with its styling. Install it and open the files with Chrome.

    However, they are basically text files. You can also view them with any text editor such as Notepad on Windows, gedit on Linux or Text Editor on MacOS

How can I change my credentials?

  • All of the user data is held in config.json file which is in a folder named "Bulk Downloader for Reddit" in your Home directory. You can edit them, there.

Changes on master

30/07/2018

  • Now opens web browser and goes to Imgur when prompts for Imgur credentials

26/07/2018

  • Improved verbose mode
  • Minimalized the console output
  • Added quit option for auto quitting the program after process finishes

25/07/2018

  • Added verbose mode
  • Stylized the console output

24/07/2018

  • Added OP's name to file names (backwards compatible)
  • Deleted # char from file names (backwards compatible)
  • Improved exception handling

23/07/2018

  • Splited download() function
  • Added erome support
  • Removed exclude feature
  • Bug fixes

22/07/2018

  • Put log files in a folder named "LOG_FILES"
  • Fixed the bug that makes multireddit mode unusable

21/07/2018

  • Added exclude mode

20/07/2018

  • "0" input for no limit
  • Fixed the bug that recognizes none image direct links as image links

19/07/2018

  • Added v.redd.it support
  • Added custom exception descriptions to FAILED.json file
  • Fixed the bug that prevents downloading some gfycat URLs

13/07/2018

  • Changed config.json file's path to home directory

12/07/2018

  • Added binaries for Windows and Linux
  • Wait on KeyboardInterrupt
  • Accept multiple subreddit input
  • Fixed the bug that prevents choosing "[0] exit" with typing "exit"

11/07/2018

  • Improvements on UX and UI
  • Added logging errors to CONSOLE_LOG.txt
  • Using current directory if directory has not been given yet.

10/07/2018

  • Added support for self post
  • Now getting posts is quicker