Update version

Added Verbose mode

README.md

@@ -23,7 +23,8 @@ This program downloads imgur, gfycat and direct image and video links of saved p
   
 - **MacOS** users have to **[compile it from source code](docs/COMPILE_FROM_SOURCE.md)**.
 
-Script also accepts **command-line arguments**, get further information from **[`--help`](docs/COMMAND_LINE_ARGUMENTS.md)**
+### Additional options
+Script also accepts additional options via command-line arguments, get further information from **[`--help`](docs/COMMAND_LINE_ARGUMENTS.md)**
 
 ## Setting up the script
 Because this is not a commercial app, you need to create an imgur developer app in order API to work.
@@ -36,11 +37,24 @@ Because this is not a commercial app, you need to create an imgur developer app
 * Correct CHAPTCHA
 * Click **submit** button  
   
-It should redirect to a page which shows your **imgur_client_id** and **imgur_client_secret**
+It should redirect you to a page which shows your **imgur_client_id** and **imgur_client_secret**
   
-\* Select **OAuth 2 authorization without a callback URL** first then select **Anonymous usage without user authorization** if it says *Authorization callback URL: required*
+\* Select **OAuth 2 authorization without a callback URL** first then select **Anonymous usage without user authorization** if it says *Authorization callback URL: required*. If this does not work, it is safe to proceed with **OAuth 2 authorization without a callback URL**.
 
 ## 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 downloaded files' names are 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](https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk) for viewing Markdown files with its styling. Install it and open the files with [Chrome](https://www.google.com/intl/tr/chrome/).  
@@ -52,25 +66,34 @@ It should redirect to a page which shows your **imgur_client_id** and **imgur_cl
   them, there.
 
 ## Changes on *master*
+### [26/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/1623722138bad80ae39ffcd5fb38baf80680deac)
+- Improved verbose mode
+- Minimalized the console output
+- Added quit option for auto quitting the program after process finished
+
+### [25/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/1623722138bad80ae39ffcd5fb38baf80680deac)
+- Added verbose mode
+- Stylized the console output
+
 ### [24/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/7a68ff3efac9939f9574c2cef6184b92edb135f4)
 - Added OP's name to file names (backwards compatible)
 - Deleted # char from file names (backwards compatible)
 - Improved exception handling
 
 ### [23/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/7314e17125aa78fd4e6b28e26fda7ec7db7e0147)
-- Split download() function
+- Splited download() function
 - Added erome support
-- Remove exclude feature
+- Removed exclude feature
-- Bug fix
+- Bug fixes
 
-### [22/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/a67da461d2fcd70672effcb20c8179e3224091bb)
+### [22/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/6e7463005051026ad64006a8580b0b5dc9536b8c)
 - Put log files in a folder named "LOG_FILES"
 - Fixed the bug that makes multireddit mode unusable
 
 ### [21/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/4a8c2377f9fb4d60ed7eeb8d50aaf9a26492462a)
 - Added exclude mode
 
-### [20/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/commit/7548a010198fb693841ca03654d2c9bdf5742139)
+### [20/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/7548a010198fb693841ca03654d2c9bdf5742139)
 - "0" input for no limit
 - Fixed the bug that recognizes none image direct links as image links
 
@@ -80,7 +103,7 @@ It should redirect to a page which shows your **imgur_client_id** and **imgur_cl
 - Fixed the bug that prevents downloading some gfycat URLs
 
 ### [13/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/9f831e1b784a770c82252e909462871401a05c11)
-- Change config.json file's path to home directory
+- Changed config.json file's path to home directory
 
 ### [12/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/50a77f6ba54c24f5647d5ea4e177400b71ff04a7)
 - Added binaries for Windows and Linux

docs/COMMAND_LINE_ARGUMENTS.md

@@ -5,20 +5,24 @@ See **[compiling from source](COMPILE_FROM_SOURCE.md)** page first unless you ar
 ***Use*** `.\bulk-downloader-for-reddit.exe` ***or*** `./bulk-downloader-for-reddit` ***if you are using the executable***.
 ```console
 $ python script.py --help
-usage: script.py [-h] [--directory DIRECTORY] [--link link] [--saved]
+usage: script.py [-h] [--directory DIRECTORY] [--NoDownload] [--verbose]
-                 [--submitted] [--upvoted] [--log LOG FILE]
+                 [--quit] [--link link] [--saved] [--submitted] [--upvoted]
-                 [--subreddit SUBREDDIT [SUBREDDIT ...]]
+                 [--log LOG FILE] [--subreddit SUBREDDIT [SUBREDDIT ...]]
                  [--multireddit MULTIREDDIT] [--user redditor]
                  [--search query] [--sort SORT TYPE] [--limit Limit]
-                 [--time TIME_LIMIT] [--NoDownload]
+                 [--time TIME_LIMIT]
 
 This program downloads media from reddit posts
 
 optional arguments:
   -h, --help            show this help message and exit
-  --directory DIRECTORY
+  --directory DIRECTORY, -d DIRECTORY
                         Specifies the directory where posts will be downloaded
                         to
+  --NoDownload          Just gets the posts and stores them in a file for
+                        downloading later
+  --verbose, -v         Verbose Mode
+  --quit, -q            Auto quit afer the process finishes
   --link link, -l link  Get posts from link
   --saved               Triggers saved mode
   --submitted           Gets posts of --user
@@ -38,8 +42,6 @@ optional arguments:
   --limit Limit         default: unlimited
   --time TIME_LIMIT     Either hour, day, week, month, year or all. default:
                         all
-  --NoDownload          Just gets the posts and store them in a file for
-                        downloading later
 ```
 
 # Examples

docs/COMPILE_FROM_SOURCE.md

@@ -1,16 +1,14 @@
 # Compiling from source code
 ## Requirements
 ### Python 3 Interpreter
-Latest* version of **Python 3** is needed. See if it is already installed [here](#finding-the-correct-keyword-for-python). If not, download the matching release for your platform [here](https://www.python.org/downloads/) and install it. If you are a *Windows* user, selecting **Add Python 3 to PATH** option is mandatory.   
+Latest* version of **Python 3** is needed. See if it is already installed [here](#finding-the-correct-keyword-for-python). If not, download the matching release for your platform [here](https://www.python.org/downloads/) and install it. If you are a *Windows* user, selecting **Add Python 3 to PATH** option when installing the software is mandatory.   
   
 \* *Use Python 3.6.5 if you encounter an issue*
 ## Using terminal
 ### To open it...
-- **On Windows 8/8.1/10**: Press the File tab on **Windows Explorer**, click on **Open Windows PowerShell** or **Open Windows Command Prompt** or look for *Command Prompt* or *PowerShell* in *Start Menu*.
+-  **On Windows**: Press **Shift+Right Click**, select **Open Powershell window here** or **Open Command Prompt window here**
   
-- **On Windows 7**: Press **WindowsKey+R**, type **cmd** and hit Enter or look for *Command Prompt* or *PowerShell* in *Start Menu*.
+- **On Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T**.
-  
-- **On Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T** or look for **Terminal** in the programs.
   
 - **On MacOS**: Look for an app called **Terminal**.
   
@@ -39,4 +37,4 @@ python -m pip install -r requirements.txt
   
 ---
   
-Now, you can go to [Using command-line arguments](COMMAND_LINE_ARGUMENTS.md)
+Now, you can go to [Using command-line arguments](COMMAND_LINE_ARGUMENTS.md)

script.py

@@ -22,7 +22,7 @@ from src.tools import (GLOBAL, createLogFile, jsonFile, nameCorrector,
 
 __author__ = "Ali Parlakci"
 __license__ = "GPL"
-__version__ = "1.5.0"
+__version__ = "1.6.0"
 __maintainer__ = "Ali Parlakci"
 __email__ = "parlakciali@gmail.com"
 
@@ -62,10 +62,26 @@ def parseArguments(arguments=[]):
                                      description="This program downloads " \
                                                  "media from reddit " \
                                                  "posts")
-    parser.add_argument("--directory",
+    parser.add_argument("--directory","-d",
                         help="Specifies the directory where posts will be " \
                         "downloaded to",
                         metavar="DIRECTORY")
+        
+    parser.add_argument("--NoDownload",
+                        help="Just gets the posts and stores them in a file" \
+                             " for downloading later",
+                        action="store_true",
+                        default=False)
+    
+    parser.add_argument("--verbose","-v",
+                        help="Verbose Mode",
+                        action="store_true",
+                        default=False)
+    
+    parser.add_argument("--quit","-q",
+                        help="Auto quit afer the process finishes",
+                        action="store_true",
+                        default=False)
 
     parser.add_argument("--link","-l",
                         help="Get posts from link",
@@ -137,13 +153,6 @@ def parseArguments(arguments=[]):
                         choices=["all","hour","day","week","month","year"],
                         metavar="TIME_LIMIT",
                         type=str)
-    
-    parser.add_argument("--NoDownload",
-                        help="Just gets the posts and store them in a file" \
-                             " for downloading later",
-                        action="store_true",
-                        default=False)
-    
 
     if arguments == []:
         return parser.parse_args()
@@ -465,13 +474,12 @@ def downloadPost(SUBMISSION):
         "imgur":Imgur,"gfycat":Gfycat,"erome":Erome,"direct":Direct,"self":Self
     }
 
+    print()
     if SUBMISSION['postType'] in downloaders:
 
-        print(SUBMISSION['postType'].upper())
-
         if SUBMISSION['postType'] == "imgur":
             
-            if int(time.time() - lastRequestTime) <= 2:
+            while int(time.time() - lastRequestTime) <= 2:
                 pass
 
             credit = Imgur.get_credits()
@@ -482,13 +490,18 @@ def downloadPost(SUBMISSION):
                             + " Minutes " \
                             + str(int(IMGUR_RESET_TIME%60)) \
                             + " Seconds") 
+            
+            if credit['ClientRemaining'] < 25 or credit['UserRemaining'] < 25:
+                printCredit = {"noPrint":False}
+            else:
+                printCredit = {"noPrint":True}
 
             print(
-                "Client: {} - User: {} - Reset {}".format(
+                "==> Client: {} - User: {} - Reset {}\n".format(
                     credit['ClientRemaining'],
                     credit['UserRemaining'],
                     USER_RESET
-                )
+                ),end="",**printCredit
             )
 
             if not (credit['UserRemaining'] == 0 or \
@@ -496,7 +509,7 @@ def downloadPost(SUBMISSION):
 
                 """This block of code is needed
                 """
-                if int(time.time() - lastRequestTime) <= 2:
+                while int(time.time() - lastRequestTime) <= 2:
                     pass
 
                 lastRequestTime = time.time()
@@ -530,17 +543,13 @@ def download(submissions):
     FAILED_FILE = createLogFile("FAILED")
 
     for i in range(subsLenght):
-        print("\n({}/{})".format(i+1,subsLenght))
         print(
-            "https://reddit.com/r/{subreddit}/comments/{id}".format(
+            f"\n({i+1}/{subsLenght}) – {submissions[i]['postType'].upper()} " \
-                subreddit=submissions[i]['postSubreddit'],
+            f"– r/{submissions[i]['postSubreddit']}",end=""
-                id=submissions[i]['postId']
-            )
         )
 
         if isPostExists(submissions[i]):
-            print(submissions[i]['postType'].upper())
+            print("\nIt already exists")
-            print("It already exists")
             duplicates += 1
             downloadedCount -= 1
             continue
@@ -619,7 +628,7 @@ def main():
     else:
         GLOBAL.directory = Path(input("download directory: "))
 
-    print("\n"," ".join(sys.argv),"\n")
+    print("\n"," ".join(sys.argv),"\n",noPrint=True)
 
     try:
         checkConflicts()
@@ -683,7 +692,6 @@ if __name__ == "__main__":
     except KeyboardInterrupt:
         if GLOBAL.directory is None:
             GLOBAL.directory = Path(".\\")
-        print("\nQUITTING...")
         
     except Exception as exception:
         if GLOBAL.directory is None:
@@ -692,4 +700,4 @@ if __name__ == "__main__":
                       exc_info=full_exc_info(sys.exc_info()))
         print(log_stream.getvalue())
 
-    input("\nPress enter to quit\n")
+    if not GLOBAL.arguments.quit: input("\nPress enter to quit\n")

src/downloader.py

@@ -61,13 +61,14 @@ def getFile(fileDir,tempDir,imageURL,indent=0):
                                            tempDir,
                                            reporthook=dlProgress)
                 os.rename(tempDir,fileDir)
-                print(" "*indent+"Downloaded"+" "*10)
-                break
             except ConnectionResetError as exception:
                 print(" "*indent + str(exception))
                 print(" "*indent + "Trying again\n")
             except FileNotFoundError:
                 raise FileNameTooLong
+            else:
+                print(" "*indent+"Downloaded"+" "*10)
+                break
     else:
         raise FileAlreadyExistsError
 
@@ -90,10 +91,10 @@ class Erome:
             print(post["postSubmitter"]+"_"+title+"_"+post['postId']+extension)
 
             fileDir = directory / (
-                POST["postSubmitter"]+"_"+title+"_"+POST['postId']+extension
+                post["postSubmitter"]+"_"+title+"_"+post['postId']+extension
             )
             tempDir = directory / (
-                POST["postSubmitter"]+"_"+title+"_"+POST['postId']+".tmp"
+                post["postSubmitter"]+"_"+title+"_"+post['postId']+".tmp"
             )
 
             imageURL = "https:" + IMAGES[0]

src/searcher.py

@@ -1,4 +1,5 @@
 import os
+import sys
 import random
 import socket
 import webbrowser
@@ -125,8 +126,6 @@ def getPosts(args):
         if args["user"] == "me":
             args["user"] = str(reddit.user.me())
 
-    print("\nGETTING POSTS\n.\n.\n.\n")
-
     if not "search" in args:
         if args["sort"] == "top" or args["sort"] == "controversial":
             keyword_params = {
@@ -158,7 +157,7 @@ def getPosts(args):
                     sort=args["sort"],
                     subreddit=args["subreddit"],
                     time=args["time"]
-                ).upper()
+                ).upper(),noPrint=True
             )            
             return redditSearcher(
                 reddit.subreddit(args["subreddit"]).search(
@@ -186,7 +185,7 @@ def getPosts(args):
             "saved posts\nuser:{username}\nlimit={limit}\n".format(
                 username=reddit.user.me(),
                 limit=args["limit"]
-            ).upper()
+            ).upper(),noPrint=True
         )
         return redditSearcher(reddit.user.me().saved(limit=args["limit"]))
 
@@ -201,7 +200,7 @@ def getPosts(args):
                     sort=args["sort"],
                     subreddit=args["subreddit"],
                     time=args["time"]
-                ).upper()
+                ).upper(),noPrint=True
             )
             return redditSearcher(
                 getattr(reddit.front,args["sort"]) (**keyword_params)
@@ -215,7 +214,7 @@ def getPosts(args):
                     sort=args["sort"],
                     subreddit=args["subreddit"],
                     time=args["time"]
-                ).upper()
+                ).upper(),noPrint=True
             )
             return redditSearcher(
                 getattr(
@@ -233,7 +232,7 @@ def getPosts(args):
                 sort=args["sort"],
                 multireddit=args["multireddit"],
                 time=args["time"]
-            ).upper()
+            ).upper(),noPrint=True
         )
         try:
             return redditSearcher(
@@ -254,7 +253,7 @@ def getPosts(args):
                 sort=args["sort"],
                 user=args["user"],
                 time=args["time"]
-            ).upper()
+            ).upper(),noPrint=True
         )
         return redditSearcher(
             getattr(
@@ -267,7 +266,7 @@ def getPosts(args):
             "upvoted posts of {user}\nlimit: {limit}\n".format(
                 user=args["user"],
                 limit=args["limit"]
-            ).upper()
+            ).upper(),noPrint=True
         )
         try:
             return redditSearcher(
@@ -277,7 +276,7 @@ def getPosts(args):
             raise InsufficientPermission
 
     elif "post" in args:
-        print("post: {post}\n".format(post=args["post"]).upper())
+        print("post: {post}\n".format(post=args["post"]).upper(),noPrint=True)
         return redditSearcher(
             reddit.submission(url=args["post"]),SINGLE_POST=True
         )
@@ -306,6 +305,8 @@ def redditSearcher(posts,SINGLE_POST=False):
 
     allPosts = {}
 
+    print("\nGETTING POSTS")
+    if GLOBAL.arguments.verbose: print("\n")
     postsFile = createLogFile("POSTS")
 
     if SINGLE_POST:
@@ -326,50 +327,62 @@ def redditSearcher(posts,SINGLE_POST=False):
         if result is not None:
             details = result
             orderCount += 1
-            printSubmission(submission,subCount,orderCount)
+            if GLOBAL.arguments.verbose:
+                printSubmission(submission,subCount,orderCount)
             subList.append(details)
 
         postsFile.add({subCount:[details]})
 
     else:
-        for submission in posts:
+        try:
-            subCount += 1
+            for submission in posts:
+                subCount += 1
 
-            try:
+                if subCount % 100 == 0 and not GLOBAL.arguments.verbose:
-                details = {'postId':submission.id,
+                    sys.stdout.write("• ")
-                           'postTitle':submission.title,
+                    sys.stdout.flush()
-                           'postSubmitter':str(submission.author),
-                           'postType':None,
-                           'postURL':submission.url,
-                           'postSubreddit':submission.subreddit.display_name}
-            except AttributeError:
-                continue
 
-            result = checkIfMatching(submission)
+                if subCount % 1000 == 0:
+                    sys.stdout.write("\n"+" "*14)
+                    sys.stdout.flush()
 
-            if result is not None:
+                try:
-                details = result
+                    details = {'postId':submission.id,
-                orderCount += 1
+                            'postTitle':submission.title,
-                printSubmission(submission,subCount,orderCount)
+                            'postSubmitter':str(submission.author),
-                subList.append(details)
+                            'postType':None,
+                            'postURL':submission.url,
+                            'postSubreddit':submission.subreddit.display_name}
+                except AttributeError:
+                    continue
 
-            allPosts[subCount] = [details]
+                result = checkIfMatching(submission)
+
+                if result is not None:
+                    details = result
+                    orderCount += 1
+                    if GLOBAL.arguments.verbose:
+                        printSubmission(submission,subCount,orderCount)
+                    subList.append(details)
+
+                allPosts[subCount] = [details]
+        except KeyboardInterrupt:
+            print("\nKeyboardInterrupt",end="")
         
         postsFile.add(allPosts)
 
-    if not len(subList) == 0:    
+    if not len(subList) == 0:
-        print(
+        if GLOBAL.arguments.NoDownload or GLOBAL.arguments.verbose:
-            "\nTotal of {} submissions found!\n"\
+            print(
-            "{} GFYCATs, {} IMGURs, {} EROMEs, {} DIRECTs and {} SELF POSTS\n"
+                f"\n\nTotal of {len(subList)} submissions found!"
-            .format(
-                len(subList),
-                gfycatCount,
-                imgurCount,
-                eromeCount,
-                directCount,
-                selfCount
             )
-        )
+            print(
+                f"{gfycatCount} GFYCATs, {imgurCount} IMGURs, " \
+                f"{eromeCount} EROMEs, {directCount} DIRECTs " \
+                f"and {selfCount} SELF POSTS",noPrint=True
+            )
+        else:
+            print()
         return subList
     else:
         raise NoMatchingSubmissionFound

src/tools.py

@@ -90,7 +90,7 @@ def createLogFile(TITLE):
 
     return FILE
 
-def printToFile(*args, **kwargs):
+def printToFile(*args, noPrint=False,**kwargs):
     """Print to both CONSOLE and 
     CONSOLE LOG file in a folder time stampt in the name
     """
@@ -98,15 +98,21 @@ def printToFile(*args, **kwargs):
     TIME = str(time.strftime("%d-%m-%Y_%H-%M-%S",
                              time.localtime(GLOBAL.RUN_TIME)))
     folderDirectory = GLOBAL.directory / "LOG_FILES" / TIME
-    print(*args,**kwargs)
+
+    if not noPrint or \
+       GLOBAL.arguments.verbose or \
+       "file" in kwargs:
+       
+       print(*args,**kwargs)
 
     if not path.exists(folderDirectory):
         makedirs(folderDirectory)
-        
+    
-    with io.open(
+    if not "file" in kwargs:
-        folderDirectory / "CONSOLE_LOG.txt","a",encoding="utf-8"
+        with io.open(
-    ) as FILE:
+            folderDirectory / "CONSOLE_LOG.txt","a",encoding="utf-8"
-        print(*args, file=FILE, **kwargs) 
+        ) as FILE:
+            print(*args, file=FILE, **kwargs) 
 
 def nameCorrector(string):
     """Swap strange characters from given string