Skip to content

Commit

Permalink
Merge pull request #436 from Hari-Nagarajan/development
Browse files Browse the repository at this point in the history 
Release 0.5.0 to Master
  • Loading branch information
@DakkJaniels
DakkJaniels authored Dec 23, 2020
2 parents 5e0f60f + bf79e68 commit a81fc43
Show file tree
Hide file tree
Showing 13 changed files with 814 additions and 234 deletions.
4 changes: 2 additions & 2 deletions Pipfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pyinstaller = "*"
requests = "==2.24.0"
click = "*"
selenium = "*"
chromedriver-py = "==87.0.4280.20"
chromedriver-py = "==87.0.4280.88"
furl = "*"
twilio = "*"
discord-webhook = "*"
Expand All @@ -30,7 +30,7 @@ apprise = "*"
price-parser = "*"
pypresence = "==4.0.0"
pywin32 = {version = "*", sys_platform = "== 'win32'"}

psutil = "*"
stdiomask = "*"

[requires]
Expand Down
195 changes: 146 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,48 +42,65 @@ Options:
Commands:
amazon
bestbuy
```

## Current Functionality

| **Website** | **Auto Checkout** | **Open Cart Link** | **Test flag** |
|:---:|:---:|:---:|:---:|
| amazon.com |`✔`| | |
| bestbuy.com | |`✔`| |

| ~~bestbuy.com~~ | |`✔`| |
Best Buy has been deprecated, see details below.

## Usage

### Amazon
The following flags are specific to the Amazon scripts. They the `[OPTIONS]` to be passed on the command-line to control
the behavior of Amazon scanning and purchasing. These can be added at the command line or added to a batch file/shell
script (see `_Amazon.bat` in the root folder of the project).

**Amazon flags**

```
--no-image : prevents images from loading on amazon webdriver
--test : This will not finish the checkout
--delay : modify default delay between page refreshes (3 seconds), use --delay=x, where is is time in seconds (accepts decimals)
--checkshipping : Bot will consider shipping + sales price in reserve check. Without this flag, only free shipping items will be considered
--detailed : Take more screenshots.
--used : Show used items in search listings
--random-delay : Set delay to a random interval
--single-shot : Quit after 1 successful purchase
--disable-presence : Disable Discord Rich Presence functionallity
--no-screenshots : Disable screenshots from being taken
```
python app.py amazon --help
Make a copy of `amazon_config.template_json` and rename to `amazon_config.json`:
```json
{
"asin_groups": 2,
"asin_list_1": ["B07JH53M4T","B08HR7SV3M"],
"reserve_min_1": 800,
"reserve_max_1": 1000,
"asin_list_2": ["B07JH53M4T","B08HR7SV3M"],
"reserve_min_2": 700,
"reserve_max_2": 750,
"amazon_website": "smile.amazon.com"
}
Usage: app.py amazon [OPTIONS]
Options:
--no-image Do not load images
--headless Unsupported headless mode. GLHF
--test Run the checkout flow, but do not actually purchase the
item[s]
--delay FLOAT Time to wait between checks for item[s]
--checkshipping Factor shipping costs into reserve price and look for
items with a shipping price
--detailed Take more screenshots. !!!!!! This could cause you to
miss checkouts !!!!!!
--used Show used items in search listings.
--single-shot Quit after 1 successful purchase
--no-screenshots Take NO screenshots, do not bother asking for help if
you use this... Screenshots are the best tool we have
for troubleshooting
--disable-presence Disable Discord Rich Presence functionallity
--disable-sound Disable local sounds. Does not affect Apprise
notification sounds.
--slow-mode Uses normal page load strategy for selenium. Default is
none
--p TEXT Pass in encryption file password as argument
--help Show this message and exit.
```

**Configuration**

Make a copy of `amazon_config.template_json` and rename to `amazon_config.json`. Edit it according to the ASINs you
are interested in purchasing. [*What's an ASIN?*](https://www.datafeedwatch.com/blog/amazon-asin-number-what-is-it-and-how-do-you-get-it#how-to-find-asin)

* `asin_groups` indicates the number of ASIN groups you want to use.
* `asin_list_x` list of ASINs for products you want to purchase. You must locate these (see Discord or lookup the ASIN on product pages).
* The first time an item from list "x" is in stock and under its associated reserve, it will purchase it.
Expand All @@ -93,6 +110,55 @@ Make a copy of `amazon_config.template_json` and rename to `amazon_config.json`:
* `reserve_max_x` is the most amount you want to spend for a single item (i.e., ASIN) in `asin_list_x`. Does not include tax. If --checkshipping flag is active, this includes shipping listed on offer page.
* `amazon_website` amazon domain you want to use. smile subdomain appears to work better, if available in your country.

**Examples**

One unique product with one ASIN (e.g., Segway Ninebot S and GoKart Drift Kit Bundle) :

```json
{
"asin_groups": 1,
"asin_list_1": ["B07K7NLDGT"],
"reserve_min_1": 450,
"reserve_max_1": 500,
"amazon_website": "smile.amazon.com"
}
```

One general product with multiple ASINS (e.g 16 GB USB drive 2 pack)

```json
{
"asin_groups": 1,
"asin_list_1": ["B07JH53M4T", "B085M1SQ9S", "B00E9W1ULS"],
"reserve_min_1": 15,
"reserve_max_1": 20,
"amazon_website": "smile.amazon.com"
}
```

Two general products with multiple ASINS and different price points (e.g. 16 GB USB drive 2 pack and a statue of The Thinker)

```json
{
"asin_groups": 2,
"asin_list_1": ["B07JH53M4T", "B085M1SQ9S", "B00E9W1ULS"],
"reserve_min_1": 15,
"reserve_max_1": 20,
"asin_list_2": ["B006HPI2A2", "B00N54S1WW"],
"reserve_min_2": 50,
"reserve_max_2": 75,
"amazon_website": "smile.amazon.com"
}
```

If you wanted to watch another product, you'd add a third list (e.g. `asin_list_3`) and associated min/max pricing and
increase the `asin_groups` to 3. Add as many lists as are needed, keeping in mind that the main distinction between lists
is the min/max price boundaries. Once any ASIN is purchased from an ASIN list, that list is remove from the hunt
until FairGame is restarted.

To verify that your JSON is well formatted, paste and validate it at https://jsonlint.com/

**Start Up**

Previously your username and password were entered into the config file, this is no longer the case. On first launch the bot will prompt
you for your credentials. You will then be asked for a password to encrypt them. Once done, your encrypted credentials will be stored in
Expand Down Expand Up @@ -128,48 +194,77 @@ Example usage:
```
python app.py amazon --test
...
INFO: "2020-09-25 14:40:49,987 - Initializing notification handlers
INFO: "2020-09-25 14:40:49,988 - Enabled Handlers: ['Audio', 'Twilio', 'Pavlok']
INFO: "2020-09-25 14:40:54,141 - Already logged in
INFO: "2020-09-25 14:40:54,141 - Checking stock for items.
INFO: "2020-09-25 14:40:54,614 - One or more items in stock!
INFO: "2020-09-25 14:40:54,718 - Pavlok zaped
INFO: "2020-09-25 14:40:54,848 - SMS Sent: SM68afc07b580f45d1b2527ec4b668f2d8
INFO: "2020-09-25 14:40:58,771 - Clicking continue.
INFO: "2020-09-25 14:41:03,816 - Waiting for Cart Page
INFO: "2020-09-25 14:41:03,826 - On cart page.
INFO: "2020-09-25 14:41:03,826 - clicking checkout.
INFO: "2020-09-25 14:41:04,287 - Waiting for Place Your Order Page
INFO: "2020-09-25 14:41:04,332 - Finishing checkout
INFO: "2020-09-25 14:41:04,616 - Clicking Button: <selenium.webdriver.remote.webelement.WebElement (session="89f5bfa2d22cf963433ed241494d68c1", element="b3fb2797-383c-413d-8d79-1ddd63013394")>
INFO: "2020-09-25 14:41:04,617 - Waiting for Order completed page.
INFO: "2020-09-25 14:41:04,617 - This is a test, so we don't need to wait for the order completed page.
INFO: "2020-09-25 14:41:04,617 - Order Placed.
2020-12-23 13:07:38 INFO Initializing Apprise handler using: config/apprise.conf
2020-12-23 13:07:38 INFO Found Discord configuration
2020-12-23 13:07:38 INFO FairGame v0.5.0
2020-12-23 13:07:38 INFO Reading credentials from: config/amazon_credentials.json
2020-12-23 13:07:43 INFO ==================================================
2020-12-23 13:07:43 INFO Starting Amazon ASIN Hunt for 2 Products with:
2020-12-23 13:07:43 INFO --Delay of 3.0 seconds
2020-12-23 13:07:43 INFO --Free Shipping items only
2020-12-23 13:07:43 WARNING --Testing Mode. NO Purchases will be made.
2020-12-23 13:07:43 INFO --Looking for 1 ASINs between 5.00 and 30.00
2020-12-23 13:07:43 INFO --Looking for 2 ASINs between 650.00 and 850.00
2020-12-23 13:07:43 INFO ==================================================
2020-12-23 13:07:43 INFO Waiting for home page.
2020-12-23 13:07:44 INFO Already logged in
2020-12-23 13:07:45 INFO Checking stock for items.
2020-12-23 13:07:46 INFO Item in stock and in reserve range!
2020-12-23 13:07:46 INFO clicking add to cart
2020-12-23 13:07:47 INFO clicking checkout.
2020-12-23 13:07:47 INFO Email
2020-12-23 13:07:48 INFO Email not needed.
2020-12-23 13:07:48 INFO Remember me checkbox
2020-12-23 13:07:48 INFO Password
2020-12-23 13:07:49 INFO enter in your two-step verification code in browser
2020-12-23 13:08:05 INFO Logged in as [email protected]
2020-12-23 13:08:06 INFO Found button , but this is a test
2020-12-23 13:08:06 INFO will not try to complete order
2020-12-23 13:08:06 INFO test time took 19.061731576919556 to check out
```


## Best Buy
This is fairly basic right now. Just login to the best buy website in your default browser and then run the command as follows:
## ~~Best Buy~~

Best Buy is currently deprecated because we don't yet have an effective way to determine item availability
without scraping and processing the product pages individually. Future updates may see this functionality
return, but the current code isn't reliable for high demand items and checkout automation has become
increasingly hard due to anti-bot measures taken by Best Buy.

Original code still exists, but provides very little utility. A 3rd party stock notification service would
probably serve as a better solution at Best Buy.

~~This is fairly basic right now. Just login to the best buy website in your default browser and then run the command as follows:~~

```
python app.py bestbuy --sku [SKU]
```

Example:
~~Example:~~
```python
python app.py bestbuy --sku 6429440
```


### Notifications
## Notifications

### Sounds
Local sounds are provided as a means to give you audible cues to what is happening. The notification sound
plays for notable events (e.g., start up, product found for purchase) during the scans. An alarm notification
will play when user interaction is necessary. This is typically when all automated options have been exhausted.
Lastly, a purchase notification sound will play if the bot if successful. These local sounds can be disabled
via the command-line and [tested](#testing-notifications) along with other notification methods

### Apprise
Notifications are now handled by Apprise. Apprise lets you send notifications to a large number of supported notification services.
Check https://github.com/caronc/apprise/wiki for a detailed list.

To enable Apprise notifications, make a copy of `apprise.conf_template` in the `config` directory and name it
`apprise.conf`. Then add apprise formatted urls for your desired notification services as simple text entries
in the config file. Any recognized notification services will be reported on app start.

Apprise Example Config:
**Apprise Example Config:**
```
# Hash Tags denote comment lines and blank lines are allowed
# Discord (https://github.com/caronc/apprise/wiki/Notify_discord)
Expand Down Expand Up @@ -203,7 +298,9 @@ Once you have setup your `apprise_config.json ` you can test it by running `pyth

## Troubleshooting

I suggest joining the #tech-support channel in [Discord](https://discord.gg/qDY2QBtAW6) for personal assistance if these common fixes don't help.
Re-read this documentation. Verify your JSON.

I suggest joining the #tech-support channel in [Discord](https://discord.gg/qDY2QBtAW6) for help from the community if these common fixes don't help.

**Error: ```selenium.common.exceptions.WebDriverException: Message: unknown error: cannot find Chrome binary```**
The issue is that chrome is not installed in the expected location. See [Selenium Wiki](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver#requirements) and the section on [overriding the Chrome binary location .](https://sites.google.com/a/chromium.org/chromedriver/capabilities#TOC-Using-a-Chrome-executable-in-a-non-standard-location)
Expand Down
2 changes: 1 addition & 1 deletion _Amazon.bat
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pipenv run python app.py amazon
cmd /k pipenv run python app.py amazon --test
Loading

0 comments on commit a81fc43

Please sign in to comment.