Merge pull request #23 from Xonshiz/dev

- Closes #22
- Updated "contribution instructions" in Readme.
- Added verbose logging for details debugging.

Changelog.md

@@ -1,3 +1,6 @@
+
 # Changelog
 - Re-did the entire codebase and implemented hulu API to scrap data.
 - Proxy support added.
+- Fix for #22
+- Added Verbose Logging.

ReadMe.md

@@ -1,4 +1,4 @@
-# Hulusubs_dl | [![Build Status](https://travis-ci.com/Xonshiz/Hulu-Subs-Downloader.svg?branch=master)](https://travis-ci.com/Xonshiz/Hulu-Subs-Downloader) | [![GitHub release](https://img.shields.io/github/release/xonshiz/Hulu-Subs-Downloader.svg?style=flat-square)](https://github.com/xonshiz/Hulu-Subs-Downloader/releases/latest) | [![Github All Releases](https://img.shields.io/github/downloads/xonshiz/Hulu-Subs-Downloader/total.svg?style=flat-square)](https://github.com/xonshiz/Hulu-Subs-Downloader/releases) [![Open Source Helpers](https://www.codetriage.com/xonshiz/hulu-subs-downloader/badges/users.svg)](https://www.codetriage.com/xonshiz/hulu-subs-downloader)
+# Hulusubs_dl | [![Build Status](https://travis-ci.com/Xonshiz/Hulusubs_dl.svg?branch=master)](https://travis-ci.com/github/Xonshiz/Hulusubs_dl) | [![GitHub release](https://img.shields.io/github/v/release/xonshiz/hulusubs_dl.svg?style=flat-square)](https://github.com/Xonshiz/Hulusubs_dl/releases/) | [![Github All Releases](https://img.shields.io/github/downloads/xonshiz/Hulusubs_dl/total.svg?style=flat-square)](https://github.com/xonshiz/Hulusubs_dl/releases) [![Open Source Helpers](https://www.codetriage.com/xonshiz/hulu-subs-downloader/badges/users.svg)](https://www.codetriage.com/xonshiz/hulu-subs-downloader)
 Hulusubs_dl is a command line tool to download subtitles from Hulu. Made for educational purposes.
 Since it's Python based, it can be easily deployed on every platform (Windows, macOS, Linux/Ubuntu etc.).
 You can find the installation instructions in #Installation Section of this readme.
@@ -103,7 +103,8 @@ Currently, the script supports these arguments :
 ```
 -h, --help                             Prints the basic help menu of the script and exits.
 -url,--hulu-url                        Url of the Hulu video or series to download subtitles from.
--V,--version                           Prints the VERSION and exits.
+--version                              Prints the VERSION and exits.
+-v,--verbose                           Enables Verbose logging.
 -dd,--download-directory               Specifies custom download location for the subtitles.
 -cookie, --set-cookie                  Saves/Updates Hulu Cookie
 -ext, --subtitle-extension             Specifies the format of final subtitle file. Default is SRT.
@@ -141,6 +142,7 @@ If you provide multiple proxies, the tool randomly chooses either of the proxies
 
 ## Opening Issues
 If you're opening a new Issue, please keep these points in your issue description:
+- Run the script with `-v` or `--verbose` option and upload the errorlog file that tool creates. (remove your login credentials from it).
 - Your operating system (Windows, MacOS, Ubuntu etc.)
 - Operating System version: Windows 10/MacOS Catalina/Ubuntu 16 etc.
 - Which version are you using: Python Script/Windows EXE Binary/MacOS Homebrew
@@ -152,9 +154,25 @@ If you're opening an issue to recommend some enhancements/changes, please be as
 - What you're about to write, does it explain the problem and solution properly? IS it enough for anyone to understand?
 
 ## How To Contribute
-If you can make this tool better or fix some edge case(s), please feel free to `fork` this repository and then raise a `PR` after your changes.
-Just make sure that the imports are proper, basic python naming conventions are followed.
-If it's just a typo in some file, please just open an issue about it. When I have multiple open issues with typo fixes, I'll make the necessary changes. Reason being that I want to avoid useless CI getting triggered and pushing useless updates across the channel.
+- If you can make this tool better or fix some edge case(s), please feel free to `fork` this repository and then raise a `PR` after your changes.
+- Send PRs to `dev` branch only (don't send direct to master).
+- Just make sure that the imports are proper, basic python naming conventions are followed.
+- Add the necessary information about the change in "changelog.md".
+- Remember to bump up the version in __version__.py. (Read how to name the version below).
+- If it's just a typo in some file, please just open an issue about it. When I have multiple open issues with typo fixes, I'll make the necessary changes. Reason being that I want to avoid useless CI getting triggered and pushing useless updates across the channel.
+
+### Version Convention
+You can find the version in `__verion__.py`. Just update the value according to these rules.
+
+Convention: Year.Month.Date
+
+So, if you're making that PR on 23rd June, 2020, version would be : 2020.06.23
+
+What if you've raised multiple PRs on same day? Simple, just append version for the day like:
+
+Convention: Year.Month.Date.RecurrenceCount
+
+Again, taking example of 23rd June, 2020, let's say you've made 3 different PRs, different versions would be: `2020.06.23.1`, `2020.06.23.2` and `2020.06.23.3`
 
 # Donations
 If you're feeling generous, you can donate some $$ via Paypal:

docs/Changelog.md

@@ -2,3 +2,5 @@
 # Changelog
 - Re-did the entire codebase and implemented hulu API to scrap data.
 - Proxy support added.
+- Fix for #22
+- Added Verbose Logging.