added background pyw, minor tweaks, dependency upgrade, readme and changelog update

Author: AnthonyZJiang

CHANGELOG.md

@@ -1,6 +1,14 @@
+**2021-03-26**
+
+    V2.2.0
+
+    - Telegram integration, thanks to @ashanrath.
+    - Dependency upgraded.
+    - Code cleanup and bug fixes.
+
 **2021-08-01**
 
-    V2.0.3
+    V2.1.0
 
     - Added '--exit-on-finish' command line option.
     - Fixed a bug in getting quiz links.

README.md

@@ -6,20 +6,19 @@ Microsoft Rewards (Bing Rewards) Bot - Completes searches and quizzes, written i
 
 This program will automatically complete search requests and quizzes on Microsoft Rewards! Search terms are the daily top searches retrieved using Google Trends' API. This bot runs selenium in headless mode for deployment on VPS and for increased performance on local machines. The bot also uses selenium's user agent options to fulfill points for all three platforms (pc, edge browser, mobile). 100% free to use and open source. Code critique/feedback and contributions welcome!
 
-## Development
-
-- Completes PC search, Edge search, Mobile search via user agents
-- Retrieves top daily searches via Google Trends' API
+## Features
+- Completes PC search, Edge search and Mobile search
 - Completes polls, all types of quizzes (multiple choice, click and drag and reorder), punch cards and explore dailies
-- Headless mode (Confirmed working on DigitalOcean linux droplet)
+- Retrieves top daily searches via Google Trends' API
+- Headless mode
 - Supports unlimited accounts via JSON.
 - Randomized search speeds
 - Logs errors and info by default, can log executed commands and search terms by changing the log level to DEBUG
-- Tested and confirmed working for U.K. (more to come!)
 
+## Requirements
 - Python          		[3.9](https://www.python.org/downloads/)
-- Requests        		2.25.1
-- Selenium        		3.141.0
+- Requests        		2.27.1
+- Selenium        		4.0.0b4
 - pyotp           		2.6.0
 - python-telegram-bot	13.7
 - Chrome Browser  		(Up-to-date)
@@ -31,36 +30,30 @@ This program will automatically complete search requests and quizzes on Microsof
     remove `.example` from filename.
 3.  If your account has 2-factor authentication (2FA) enabled, please follow [README-2FA](README-2FA.md).
 4.  Enter into cmd/terminal/shell: `python -m pip install -r requirements.txt`
-    - This installs dependencies (selenium, requests and pytop)
-5.  Enter into cmd/terminal/shell: `python ms_rewards.py --headless --mobile --pc --quiz`
+5.  Enter into cmd/terminal/shell: `python ms_rewards.py --headless --mobile --pc --quiz`.
     - enter `-h` or `--help` for more instructions
-    - `--headless` is for headless mode
-    - `--mobile` is for mobile search
-    - `--pc` is for pc search
-    - `--quiz` is for quiz search
-    - `-a` or `--all` is short for mobile, pc, and quiz search
-	- `--telegram` is to enable telegram updates. Please follow please follow [README-Telegram](README-Telegram.md).
-    - Script by default will execute mobile, pc, edge, searches, and complete quizzes for all accounts (can change this setting in the .py file)
-    - Script by default will run in interactive mode
-    - If python environment variable is not set, enter `/path/to/python/executable ms_rewards.py`
-6.  Crontab (Optional for automated script daily on linux)
+    - `--telegram` is to enable telegram integration. Please follow please follow [README-Telegram](README-Telegram.md).
+
+*Hint: Replace `ms_rewards.py` with `ms_rewards.quiet.pyw` to run the bot in the background without a command window.*
+### Optional
+- Crontab (automated script daily on linux)
     - Enter in terminal: `crontab -e`
     - Enter in terminal: `0 12 * * * /path/to/python /path/to/ms_rewards.py --headless --mobile --pc --quiz`
-      - Can change the time from 12am server time to whenever the MS daily searches reset (~12am PST)
-      - Change the paths to the json in the .py file to appropriate path
+
+
+## Troubleshooting
+
+If the bot had worked before but stopped working all of a sudden, this may because I added new dependency. In this case, try this to see if the problem is solved:
+
+- Enter into cmd/terminal/shell: `python -m pip install -r requirements.txt`
 
 ## To Do
 
 - High priority:
   - Better logging
-  - More type hint
   - Simplify exception handling
-  - Windows notification
 - Low priority:
-  - Proxy support
-  - Multithreaded mode or seleniumGrid
   - Support for other regions
-  - Telegram Intergration for reporting bot status/total points.
 
 ## License
 

ms_rewards.py

@@ -74,7 +74,7 @@ def parse_args():
         action='store_true',
         dest='telegram_message',
         default=False,
-        help='Activates telegram updates upon completion of searhes.')        
+        help='Sends an update to telegram upon completion.')
     _parser = arg_parser.parse_args()
     if _parser.all_mode:
         _parser.mobile_mode = True
@@ -88,14 +88,13 @@ def get_login_info():
         return json.load(f)
 
 def run_bot():
+    parser = parse_args()
+
     check_python_version()
     if os.path.exists("drivers/chromedriver.exe"):
         update_driver()
     try:
-        # argparse
-        parser = parse_args()
 
-        # start logging
         init_logging(log_level=parser.log_level)
         logging.info(msg='--------------------------------------------------')
         logging.info(msg='-----------------------New------------------------')

ms_rewards_quiet.pyw

@@ -0,0 +1,4 @@
+from ms_rewards import run_bot
+
+if __name__ == '__main__':
+    run_bot()

requirements.txt

@@ -1,4 +1,4 @@
-selenium==3.141.0
-requests==2.25.1
+selenium==4.0.0b4
+requests==2.27.1
 pyotp==2.6.0
 python-telegram-bot==13.7