makeup-comparator 1.0.0

CLI program look for cosmetic products within a various specialized websites and compare them
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# makeup-comparator
[![Rust](https://github.com/RubenRubioM/makeup-comparator/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/RubenRubioM/makeup-comparator/actions/workflows/rust.yml)

A CLI project made in Rust to compare different properties for makeup products from different websites.

## How to use via CLI
```bash
cargo run -- --help # To get information.
# Standard call
cargo run -- --product "Product name" --max-results=3  --min-similarity=0.20 --websites=sephora-spain --websites=maquillalia
```

## Run test locally
```bash
cargo test --workspace -- --include-ignored
```

## Run test coverage locally
The objective is to keep code coverage for files under `src/` above 95%.
```bash
./test_coverage.sh
```

## TODO

### Tier 1
- Format the output to show in terminal
- Create a server to receive petitions and translate them to command parameters. This way we could use the same logic to CLI and a future webpage.
- Add "on discount" parameter to retrieve products only that are on sale.
- Add a boolean in case the tone in a product exist but it is sold out.

### Tier 2
- There are intermittent bugs when searching some products.
- Option to save the results in a json/csv/yaml.

### Tier 3
- In SephoraSpain we only get the first 27 items (3 items * 9 rows). The search page has infinite scroll. Find a way to load all the results.