Merge issue #20 fix, other improvements, for v2.3.5

README.md

@@ -1,16 +1,13 @@
-What is **e621dl**?
-===============
+### What is **e621dl**?
 **e621dl** is an automated downloader for e621.net that keeps your favorite tags, artists, or searches up-to-date.
 
-How does **e621dl** work?
-===============
+### How does **e621dl** work?
 The behavior of e621dl is dependent on two files that tell it two crucial things:
 
-1. ***e621dl*** **has to know what tags, artists, or searches you'd like to track.**  To determine this, it will look for a file called `tags.txt`.  Don't worry about creating this file, **e621dl** will create a blank one with instructions the first time you run it.
+1. ***e621dl*** **has to know what tags, artists, or searches you'd like to track.**  To determine this, it will look for a *tag file*.  Don't worry about creating this file, **e621dl** will create a blank one (called `tags.txt`) with instructions the first time you run it.
 2. ***e621dl*** **has to know the last time you ran it.**  To find this, it will look in a file called `config.txt`.  Again, don't create this file yourself, instead just run **e621dl** and it will create a config file for you with default settings.  One of these settings, `"last_run"` tells **e621dl** when the last time it ran was. 
 
-Getting Started
-===============
+### Getting Started
 **e621dl** requires Python 2.7, so download and install that first.  Once you have Python installed:
 
 - [Download the latest release] (https://github.com/wwyaiykycnf/e621dl/releases/latest) and unzip it.
@@ -25,42 +22,48 @@ e621dl      ERROR    error(s) encountered during initialization, see above
 ```
 It's not as bad as it looks.  **e621dl** is telling you that it couldn't find a config file or tags file, so it created these files.  Most users will not need to modify `config.txt` but feel free to look at it and see what settings you can change. 
 
-- Add tags or artists you wish to download to `tags.txt`.  There should already be instructions in the `tags.txt` that was created for you.  All lines starting with a `#` are ignored by **e621dl**, so feel free to leave the instructions in the file after adding your tags, if you wish. 
+- Add tags or artists you wish to download to the newly-created tag file.  There should already be instructions in the `tags.txt` that was created for you.  All lines starting with a `#` are ignored by **e621dl**, so feel free to leave the instructions in the file after adding your tags, if you wish. 
 
-Once you've added a few lines to `tags.txt` and reviewed `config.txt`, you're ready to run **e621dl**!
+Once you've added a few lines to the tag file and reviewed `config.txt`, you're ready to run **e621dl**!
 
 
-Running **e621dl**
-===============
-
+### Running **e621dl**
 When you run **e621dl**, it will determine the time it was last run, and then:
-- read a line from `tags.txt` 
+- read a line from the tag file
 - perform a search on e621.net using that line
 - download all new files matching that search (files uploaded AFTER the last time **e621dl** was run)
 
-This process will be repeated for each line in `tags.txt` until the file has been completely processed.  The last run date will then be set to yesterday's date, and **e621dl** will report the number of total downloads. 
+This process will be repeated for each line in the tag file, until every line has been checked.  The last run date will then be set to yesterday's date, and **e621dl** will report the number of total downloads. 
 
-### I did that and not much happened 
-The first time you run **e621dl**, its possible that not too much will happen.  Remember when `config.txt` was created and you opened it and saw that the `"last_run"` date was set to yesterday?  **e621dl** does that automatically, and it's set that way intentionally.  **e621dl** might check some old uploads to make sure it didn't miss anything, but it will never re-download old files. 
+**Example Output:**
+```
+> ./e621dl.py
+e621dl      INFO     e621dl was last run on 2014-06-18
+e621dl      INFO     Checking for new uploads tagged: cat
+e621dl      INFO     10 new uploads for: cat
+e621dl      INFO     	will download 10	(cached: 0, existing: 0)
 
-Anyway, if that's not what you wanted for your very first update, you'll need to:  
+e621dl      INFO     starting download of 10 files
 
-### Change the last run date
-You can set the last run date to any date that follows the format `YYYY-MM-DD`.  So if you'd like to download EVERYTHING of a given tag from the beginning of time (Ok, the beginning of e621.net) until today, change the `"last_run"` variable in `config.txt` to something old:
+Downloading:        [###################################] 100.00% Done...
+
+e621dl      INFO     successfully downloaded 10 files
+e621dl      INFO     last run updated to 2014-06-18
+```
 
-    "last_run": "1986-01-01",
+### Configuring **e621dl**
+Please see [How Do Config File](docs/config_readme.md) to learn more about **e621dl**'s settings and how to change them. 
 
-Bugs, New Features, and Feedback
-=================
-If you find something broken or have any ideas about features you'd like to see in the future, please contact me at [[email protected]].  I read every single email, so even if you think your idea is off-the-wall, or your bug is super-rare, please let me know and I'll see what I can do. 
+### Frequently Asked Questions
 
-Donations
-===============
-If you've benefitted from this *free* project, please consider donating something!  Your support enables bug fixes, new features, and future development!  
+##### Very few or no downloads
+The first time you run **e621dl**, its possible that not too much will happen.  **e621dl** picks yesterday as the `"last_run"` date when it is first run, so if that's not what you wanted, you'll need to manually change the last run date.  Look in [How Do Config File](docs/config_readme.md) for `"last_run"`. 
 
-[![Wishlist browse button](http://img.shields.io/amazon/wishlist.png?color=blue)](http://amzn.com/w/2F4EC3BPU9JON "Support me by buying something for me on Amazon")
-[![BitCoin donate button](http://img.shields.io/bitcoin/donate.png?color=brightgreen)](https://coinbase.com/checkouts/1FZR3iP9zHRqQZeG8zg8Tmx471jP1c8eYe "Make a donation to this project using BitCoin")
-[![DogeCoin donate button](http://img.shields.io/dogecoin/donate.png?color=yellow)](README.md#note-dogecoin-donations-may-be-sent-to-dkfycmjxndgaqhq5wdyjlneoqd3xbdygdr "Many donate.  So Project.  Wow.  Very DogeCoin.")
+### Bugs
+If you experience a crash or other unexpected results, please use [the reporting instructions](docs/reporting_bugs.md) for the quickest response.
 
-#######Note: *[Dogecoin](http://dogecoin.com) donations may be sent to:* `DKfycmjXNDgaqhQ5wdyJLNEoqd3XBDyGdr`
+## Feedback and Feature Requests
+If you have any ideas for how things might work better, or about features you'd like to see in the future, please send an email to [email protected].  I read every single email, so even if you think your idea is off-the-wall, please let me know and I'll see what I can do. 
 
+### Donations
+If you've benefitted from this *free* project, please consider [buying me something on Amazon](http://amzn.com/w/20RZIUHXLO6R4)!  Your support enables bug fixes, new features, and future development.  Thanks for thinking of me!

docs/config_readme.md

@@ -30,8 +30,8 @@ Note that for the `cache_size`, `create_subdirectories`, and `parallel_downloads
 
 | Option Name           | Quotes? | Acceptable Range            | Description                                                |
 | --------------------- | ------- | --------------------------- |----------------------------------------------------------- |
-| download_directory    | Yes     | anything                 | path where **e621dl** puts downloads (must end with `/`)    | 
-| create_subdirectories | No      | `true` or `false`           | create a subfolder for each line in tag file if true    |
+| download_directory    | Yes     | anything                    | path where **e621dl** puts downloads (must end with `/`)   | 
+| create_subdirectories | No      | `true` or `false`           | create a subfolder for each line in tag file if true       |
 | last_run              | Yes     | date (format: `YYYY-MM-DD`) | the last day **e621dl** was last run                       |
 
 

docs/reporting_bugs.md

@@ -0,0 +1,33 @@
+## So bug. Much Broken. Wow.  Very crash. 
+
+Well... shit.  I'm sorry that you're here.  Unfortunately its impossible to test everything, but if you're willing to follow the steps below, I'll do my best to fix the problem for you and anyone else who has it.
+
+This system is a little clunky, but bear with me for now until I get something more formal in place.
+
+
+### Windows Users
+1. navigate to the folder where e621dl.py is located on your computer
+2. [click on the address bar of windows explorer and type: cmd](http://lifehacker.com/5989434/quickly-open-a-command-prompt-from-the-windows-explorer-address-bar)
+3. a command prompt should open in the folder where e621dl.py is located. 
+4. type/paste the following, one line at a time: 
+
+  ```Batchfile
+  echo %PROCESSOR_ARCHITECTURE% >> output.txt
+  systeminfo | findstr /C:"OS" >> output.txt
+  python.exe --version >> output.txt 2>&1
+  python.exe e621dl.py -v >> output.txt 2>&1
+  ```
+5. This will send your processor architecture, version of windows, version to python, and **debug output of e621dl** to a file called output.txt.    
+
+6. Send an email to [email protected], and attach output.txt, config.txt, and tags.txt to the email. 
+
+### OSX/Linux/Unix
+1. open a terminal and navigate to where e621dl.py is located on your computer
+2. run the following:
+
+  ```Shell
+  uname -a >> output.txt; python --version >> output.txt 2>&1; ./e621dl.py -v >> output.txt 2>&1
+  ```
+3. Send an email to [email protected], and attach output.txt, config.txt, and tags.txt to the email. 
+
+##### Thanks for reporting bugs, so I can fix them!