0.1.0

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -13,6 +13,22 @@ body:
             This bug wasn't already reported.
             (I have checked every bug report on GitHub)
           required: true
+        - label: |
+            My code's up-to-date, i.e. I've ran `git pull`.
+          required: true
+        - label: |
+            I've tried the develop branch, `git checkout develop`
+          required: true
+        - label: |
+            I've cleared the sessions folder.
+          required: true
+        - label: |
+            I've tried running with the --visible flag to see what's causing the error.
+          required: true
+        - label: |
+            This bug wasn't already reported.
+            (I have checked every bug report on GitHub)
+          required: true
   - type: checkboxes
     id: title
     attributes:
@@ -25,7 +41,6 @@ body:
     id: branch
     attributes:
       label: Branch
-      description: Which branch?
       options:
         - master
         - develop
@@ -36,7 +51,6 @@ body:
     id: commit
     attributes:
       label: Commit
-      description: Which commit?
       placeholder: 5fd7d6c (get using `git rev-parse --short HEAD`)
     validations:
       required: true

.gitignore

@@ -184,3 +184,6 @@ sessions
 logs
 runbot.bat
 .DS_Store
+/google_trends.dat
+/google_trends.dir
+/google_trends.bak

CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Configurable retry strategies: exponential backoff and constant (the default)
+    - Configurable delay between attempt (default 60 seconds)
+    - Configurable max attempts before error (default 6)
+- Configurable Apprise summary: every run or on error if there's remaining searches after running
+    - Also configurable as a script parameter that takes precedence (useful for development)
+- Some useful JetBrains config
+- More logging
+- More type hints
+- Defaults when getting config
+
+### Changed
+
+- Simplified search logic and made more resilient
+    - Added assertion that terms were correctly typed
+- Persist and read Google trends from disk for a given day (helps get rid of duplicate searches even between different
+  runs)
+
+### Removed
+
+- Redundant calls to close Chrome
+- Calls to close all Chrome processes
+
+### Fixed
+
+- Error when executing script from .bat file #113 Reference paths independent of pwd
+- [BUG] AttributeError: 'Browser' object has no attribute 'giveMeProxy' #115 Comment out and todo give me proxy
+- When logger is set to debug, doesn't include library code now
+- [BUG] SessionNotCreatedException on Mobile Browser Creation #126 Sleep a bit after closing browser so ports are freed
+  up
+
+## [0.0.0] - 2023-03-05
+
+### Added
+
+- Farmer and lots of other things, but gotta start a changelog somewhere!

README.md

@@ -1,19 +1,17 @@
 ### A "simple" python application that uses Selenium to help with your M$ Rewards
 
----
-
 ![Static Badge](https://img.shields.io/badge/Made_in-python-violet?style=for-the-badge)
 ![MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)
 ![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)
 ![GitHub contributors](https://img.shields.io/github/contributors/klept0/MS-Rewards-Farmer?style=for-the-badge)
 ![GitHub issues](https://img.shields.io/github/issues/klept0/MS-Rewards-Farmer?style=for-the-badge)
 
----
+
 
 > [!IMPORTANT]
 > If you are multi-accounting and abusing the service for which this is intended - **_DO NOT COMPLAIN ABOUT BANS!!!_**
 
----
+
 
 > [!CAUTION]
 > Use it at your own risk, M$ may ban your account (and I would not be responsible for it)
@@ -24,16 +22,12 @@
 >
 > Do not redeem more than one reward per day.
 
----
-
 #### Group Chat - [Telegram](https://t.me/klept0_MS_Rewards_Farmer/) (pay attention to captchas - helps prevent spam)
 
 #### Original bot by [@charlesbel](https://github.com/charlesbel) - refactored/updated/maintained by [@klept0](https://github.com/klept0) and a community of volunteers.
 
 #### PULL REQUESTS ARE WELCOME AND APPRECIATED!
 
----
-
 ## Installation
 
 1. Install requirements with the following command :
@@ -47,13 +41,16 @@
 
 3. (Windows Only) Make sure Visual C++ redistributable DLLs are installed
 
-   If they're not, install the current "vc_redist.exe" from this [link](https://learn.microsoft.com/en-GB/cpp/windows/latest-supported-vc-redist?view=msvc-170) and reboot your computer
+   If they're not, install the current "vc_redist.exe" from
+   this [link](https://learn.microsoft.com/en-GB/cpp/windows/latest-supported-vc-redist?view=msvc-170) and reboot your
+   computer
 
 4. Edit the `accounts.json.sample` with your accounts credentials and rename it by removing `.sample` at the end.
 
-   The "proxy" field is not mandatory, you can omit it if you don't want to use proxy (don't keep it as an empty string, remove the line completely).
+   The "proxy" field is not mandatory, you can omit it if you don't want to use proxy (don't keep it as an empty string,
+   remove the line completely).
 
-   - If you want to add more than one account, the syntax is the following:
+    - If you want to add more than one account, the syntax is the following:
 
    ```json
    [
@@ -74,8 +71,6 @@
 
    `python main.py`
 
----
-
 ## Launch arguments
 
 - -v/--visible to disable headless
@@ -84,22 +79,16 @@
 
   `https://trends.google.com/trends/ for proper geolocation abbreviation for your choice. These MUST be uppercase!!!`
 
-- -p/--proxy to add a proxy to the whole program, supports http/https/socks4/socks5 (overrides per-account proxy in accounts.json)
+- -p/--proxy to add a proxy to the whole program, supports http/https/socks4/socks5 (overrides per-account proxy in
+  accounts.json)
 
   `(ex: http://user:pass@host:port)`
 
 - -cv/--chromeversion to use a specific version of chrome
 
   `(ex: 118)`
 
----
-
-> [!TIP]
-> If you are having issues first ask - did I make sure I have updated all of the files and cleared the sessions folder before running again?
-
-> [!TIP]
-> Have I tried to run it with -v so I could see what might be causing the error?
----
+[//]: # (todo update)
 
 ## Features
 
@@ -115,13 +104,17 @@
 - Proxy Support (3.0) - they need to be **high quality** proxies
 - Logs to CSV file for point tracking
 
----
+## Contributing
+
+Fork this repo and:
 
-> [!NOTE]
-> You may see [WARNING] in your logs - this is currently enabled for debugging and to provide in any issues you may need to open
+* if providing a bugfix, create a pull request into master.
+* if providing a new feature, please create a pull request into develop. Extra points if you update
+  the [CHANGELOG.md](CHANGELOG.md).
 
 ## To Do List (When time permits or someone makes a PR)
 
 - [x] Complete "Read To Earn" (30 pts)
 - [ ] Setup flags for mobile/desktop search only
 - [ ] Setup flags to load config / save data in working directory
+- [ ] Provide Windows Task Scheduler config

config.yaml

@@ -1,4 +1,10 @@
 # config.yaml
 apprise:
+  summary: on_error
   urls:
     - 'discord://WebhookID/WebhookToken'  # Replace with your actual Apprise service URLs
+attempts:
+retries:
+  base_delay_in_seconds: 14.0625 # base_delay_in_seconds * 2^max = 14.0625 * 2^6 = 900 = 15 minutes
+  max: 8
+  strategy: exponential