forked from SEProjGrp5/slash
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from TommasU/readme-jv
- Loading branch information
Showing
1 changed file
with
26 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| <p align="center"><img width="500" src="./assets/slash.png"></p> | ||
|
|
||
|  | ||
| [](https://zenodo.org/badge/latestdoi/423285546) | ||
| [](https://doi.org/10.5281/zenodo.5717428) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| [](https://codecov.io/gh/sskarra1234/slash) | ||
| [](https://github.com/SEProjGrp5/slash/actions/workflows/pylint.yml) | ||
| [](https://github.com/SEProjGrp5/slash/actions/workflows/style_checker.yml) | ||
|
|
@@ -47,7 +47,7 @@ Slash is a command line tool that scrapes the most popular e-commerce websites t | |
| --- | ||
| 1. Clone the Github repository to a desired location on your computer. You will need [git](https://git-scm.com/) to be preinstalled on your machine. Once the repository is cloned, you will then ```cd``` into the local repository. | ||
| ``` | ||
| git clone https://github.com/secheaper/slash.git | ||
| git clone https://github.com/TommasU/slash.git | ||
| cd slash | ||
| ``` | ||
| 2. This project uses Python 3, so make sure that [Python](https://www.python.org/downloads/) and [Pip](https://pip.pypa.io/en/stable/installation/) are preinstalled. All requirements of the project are listed in the ```requirements.txt``` file. Use pip to install all of those. | ||
|
|
@@ -184,35 +184,24 @@ python slash.py --search "socks" --num 5 | |
| 14 04/11/2021 13:13:37 Customized Dog Socks - Put Your Cute... $8.99 www.Etsy.comhttps://www.etsy.com/lis... Etsy 5 | ||
| ``` | ||
|
|
||
| :dizzy: What's new in Phase 2? | ||
| :dizzy: What's new in Phase 3? | ||
| --- | ||
| #### 1. Sort by Rating | ||
| ```--sort``` accepts the argument "ra" that determine how the tool sorts and filters the requested products | ||
| after scraping on the basis of ratings of the product . | ||
| Example: | ||
| ``` | ||
| For Mac | ||
| python3 slash.py --search "philips hue" --sort ra | ||
| For Windows | ||
| python slash.py --search "philips hue" --sort ra | ||
| #### 1. Multiple Wishlist | ||
| Multiple wishlists are now avaiable per user account featuring ``` 2. Manage Wishlists``` | ||
| Feature includes: | ||
|
|
||
| Display of current wishlists | ||
| ``` | ||
|
|
||
| ----------Wishlists--------- | ||
| 0 boxes | ||
| 1 socks | ||
| ``` | ||
|
|
||
| timestamp title price website rating | ||
| 0 03/11/2021 21:42:53 Hanes Women's Cool Comfort Ankle Socks, ... $10.97 walmart 4.2 | ||
| 1 03/11/2021 21:42:53 Hanes Women's Cool Comfort Crew Socks, 1... $10.97 walmart 4.2 | ||
| 2 03/11/2021 21:42:53 Hanes Mens FreshIQ Ankle Cushion Socks, ... $13.46 walmart 4.2 | ||
| 3 03/11/2021 21:42:51 10 Pairs Ankle Socks No Show Sock Low-Cu... $11.95 amazon 4.3 | ||
| 4 03/11/2021 21:42:50 Mens Cushioned Work Socks 10 Pairs $12.10 amazon 4.5 | ||
| 5 03/11/2021 21:42:50 Women's 6-Pack Performance Cotton Cushio... $17.70 amazon 4.5 | ||
| 6 03/11/2021 21:42:54 PDF Crikey Crocodile Socks Knit Animal S... 7.50 Etsy 4.5 | ||
| 7 03/11/2021 21:42:54 5socks /set - Cotton Women's Socks 16.00 Etsy 5 | ||
| 8 03/11/2021 21:42:54 Follkee Women's Alpaca Wool Socks Perfec... 18.49 Etsy 5 | ||
| Multiple operations for wishlist handling | ||
| ``` | ||
| 1. Open Wishlist | ||
| 2. Create new Wishlist | ||
| 3. Delete Wishlist | ||
| ``` | ||
|
|
||
| #### 2.Currency | ||
|
|
@@ -413,7 +402,7 @@ File Name: C:\Anant\NCSU\slash_test_csv\socks211104_1223.csv | |
|
|
||
|
|
||
|
|
||
| :muscle: What's next for Phase 3? | ||
| :muscle: What's next for Phase 4? | ||
| --- | ||
| - Creating ordering and payment functionality for customers to directly order from command line | ||
| - Scrape more e-commerce websites for wider range of options | ||
|
|
@@ -440,19 +429,13 @@ File Name: C:\Anant\NCSU\slash_test_csv\socks211104_1223.csv | |
|
|
||
|
|
||
| :sparkles: Contributors | ||
| --- | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/antgad"><img src="https://avatars.githubusercontent.com/u/37169203?v=4" width="75px;" alt=""/><br /><sub><b>Anant Gadodia</b></sub></a></td> | ||
| <td align="center"><a href="https://github.com/AnmolikaGoyal"><img src="https://avatars.githubusercontent.com/u/68813421?v=4" width="75px;" alt=""/><br /><sub><b>Anmolika Goyal</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/shubhangij12"><img src="https://avatars.githubusercontent.com/u/48826459?v=4" width="75px;" alt=""/><br /><sub><b>Shubhangi Jain</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/shreyakarra"><img src="https://avatars0.githubusercontent.com/u/89954066?v=4" width="75px;" alt=""/><br /><sub><b>Shreya Karra</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/srujanarao"><img src="https://avatars.githubusercontent.com/u/6882921?v=4" width="75px;" alt=""/><br /><sub><b>Srujana Rao</b></sub></a><br /></td> | ||
| </tr> | ||
| </table> | ||
| - [Jessica Vargas(jrvargas)]([email protected]) <br> | ||
| - [Parth Parikh(pmparikh)]([email protected]) <br> | ||
| - [Radhika Toravi(rtoravi)]([email protected]) <br> | ||
| - [Rushikesh Deodhar(rdeodha)]([email protected]) <br> | ||
| - [Saurabh Nanda(snanda)]([email protected]) <br> | ||
|
|
||
| :email: Support | ||
| --- | ||
| [email protected]. | ||
|
|
||
| For any queries and help, please reach out to us at: [email protected] | ||