Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorder sections in README #201

Merged
merged 1 commit into from
Nov 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 59 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
- [Intro](#intro)
- [Contributing](#contributing)
- [Installation](#installation)
- [Delete data](#delete-data)
- [Scrape products](#scrape-products)
- [Add products](#add-products)
- [Websites to scrape from](#websites-to-scrape-from)
- [Scrape products](#scrape-products)
- [Delete data](#delete-data)
- [User settings](#user-settings)
- [Clean up data](#clean-up-data)
- [View the latest datapoint of product(s)](#view-the-latest-datapoint-of-products)
Expand Down Expand Up @@ -79,63 +79,6 @@ pip3 install -r requirements.txt
<br/>


## Delete data <a name="delete-data"></a>

If you want to start from scratch with no data in the records.json and products.csv files, then just run the following command:
```
python3 main.py --delete --all
```

You can also just delete some products or some categories:
```
python3 main.py --delete --id <id>
```
```
python3 main.py --delete --name <name>
```
```
python3 main.py --delete --category <category>
```


Then just add products like described [here](#add-products).

<br/>

If you just want to reset your data for every product, deleting all datapoints inside every product, then run this command:
```
python3 main.py --reset --all
```
This deletes the data inside each product, such as id, url and all datapoints.


You can also just reset some products or all products in some categories:
```
python3 main.py --reset --id <id>
```
```
python3 main.py --reset --name <name>
```
```
python3 main.py --reset --category <category>
```

<br/>


## Scrape products <a name="scrape-products"></a>
To scrape prices of products run this in the terminal:
```
python3 main.py -s
```
To scrape with threads run the same command but with the ```--threads``` argument:
```
python3 main.py -s --threads
```

<br/>


## Add products <a name="add-products"></a>
To add a single product, use the following command, where you replace ```<category>``` and ```<url>``` with your category and url:
```
Expand Down Expand Up @@ -191,6 +134,63 @@ If you find that some other Amazon domains works or some of the listed doesn't p
<br/>


## Scrape products <a name="scrape-products"></a>
To scrape prices of products run this in the terminal:
```
python3 main.py -s
```
To scrape with threads run the same command but with the ```--threads``` argument:
```
python3 main.py -s --threads
```

<br/>


## Delete data <a name="delete-data"></a>

If you want to start from scratch with no data in the records.json and products.csv files, then just run the following command:
```
python3 main.py --delete --all
```

You can also just delete some products or some categories:
```
python3 main.py --delete --id <id>
```
```
python3 main.py --delete --name <name>
```
```
python3 main.py --delete --category <category>
```


Then just add products like described [here](#add-products).

<br/>

If you just want to reset your data for every product, deleting all datapoints inside every product, then run this command:
```
python3 main.py --reset --all
```
This deletes the data inside each product, such as id, url and all datapoints.


You can also just reset some products or all products in some categories:
```
python3 main.py --reset --id <id>
```
```
python3 main.py --reset --name <name>
```
```
python3 main.py --reset --category <category>
```

<br/>


## User settings <a name="user-settings"></a>
User settings can be added and changed in the file settings.ini.

Expand Down