Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Shmakov committed May 25, 2020
1 parent e53565b commit 2bebced
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 5 deletions.
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,45 @@
Kroger CLI
==========

![Display Purchases Summary](images/Purchases-Summary.gif)

The idea of the project is to create a command line utility that can automate certain tasks on the Kroger's website.

At this moment in time the application can:
At this moment the application can:

* Display basic information from your account (name, address, rewards card number, etc)
* [Complete the Kroger’s Survey on your behalf](images/Kroger-Survey.gif) (to earn 50 points and enter the sweepstake)
* [Clip all Digital Coupons](#clip-digital-coupons) (first 150 coupons only, sorted by relevance)
* [Display Purchases Summary](#purchases-summary) (number of store visits and dollars spent)
* [Retrieve Points Balance](#fuel-points-balance)

* Display basic information from your account
* Clip all digital coupons
#### TODO

![Kroger CLI Screenshot](images/cli-screenshot.png)
* Command Line Arguments, to allow something like that: `kroger-cli --clip-digital-coupons`

#### Side Notes

The initial plan was to use the `requests` package, however I couldn't sign in to the Kroger's website using it. Possibly had to do with csrf token validation. Because of that I had to use `pyppeteer`, which is a python's port of `Puppeteer` (Headless Chrome).
The initial plan was to use the `requests` package, however I couldn't sign in to the Kroger's website using it. Possibly had to do with csrf token validation. Because of that I had to use `pyppeteer`, which is a python's port of `Puppeteer` (Headless Chrome).

Screenshots
-----------

### Main Interface

![Kroger CLI Screenshot](images/Home-Screen-Screenshot.png)

### Clip Digital Coupons

![Clip all Kroger's Digital Coupons](images/Clip-Digital-Coupons.png)

### Purchases Summary

![Display Purchases Summary](images/Purchases-Summary.gif)

### Fuel Points Balance

![Fuel Points Balance](images/Fuel-Points-Balance.png)

### Complete Kroger's Feedback Form

[Watch](images/Kroger-Survey.gif)
Binary file added images/Clip-Digital-Coupons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Fuel-Points-Balance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Home-Screen-Screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Kroger-Survey.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Purchases-Summary.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/cli-screenshot.png
Binary file not shown.

0 comments on commit 2bebced

Please sign in to comment.