🛍️ shopwise

A python package to get the best price on your shoplist.

⚠️ Disclaimer

This repository is under continuous development. Some supermarkets may not be fully implemented yet. The registry implemented address the task as scraping but actually it is not pure scraping. The naming will be changed.

📋 Features

[ ] Supermarket shoplist: Process your shoplist w.r.t several supermarkets to find the best price at the moment.
[ ] Similarity search: Take a photo of your product and look for similar objects in the market

⚙️ Installation

To install shopwise you can clone the repository and use pip.

Clone the repository.

git clone https://german36-del/shopwise.git
cd shopwise

Install the tool using pip.

Just use it (not recommended).
```
pip install .
```
Editable mode.
```
pip install -e .
```
🖥️ Usage

shopwise can be accessed through both the Command-Line Interface (CLI) and Python code. The default parameters are configured in the shopwise/cfg/default.yaml file, and overwritten by the specified arguments in the CLI or Python calls.

CLI

shopwise may be used directly in the Command Line Interface (CLI), with the following command format:

shopwise <task> <arg1=value2> <arg2=value2> ...

For example:

shopwise supermarket save_scrap=True

Python

Shopwise may also be used directly in a Python environment, and it accepts the same arguments as in the CLI example above:

from shopwise import shopwise

# Find the best price for your shoplist!!
shopwise(save_scrap=True, supermarkets=["mercadona", "alcampo"])

🛒 Supported Supermarkets

german36-del / Shopwise

readme