il-supermarket-parser 1.0.2

python package that process the data dumped by the israeli supermarket

Israel Supermarket Parsers: Clients to parser the data published by the supermarkets.

This is a parser for ALL the supermarket chains listed in the GOV.IL site.

שקיפות מחירים (השוואת מחירים) - https://www.gov.il/he/departments/legalInfo/cpfta_prices_regulations הגדרת הקבצים שהיו צריכים להיות זמינים באתרים - https://www.nevo.co.il/law_html/law01/501_131.htm

Daily Automatic Testing

The test suite is scheduled to run daily, so you can see if the supermarket chains have changed something in their interface and the package will not work properly.

Status:

🤗 Want to support my work?

Got a question?

You can email me at [e-mail]

If you think you've found a bug:

• Create issue in issue tracker to see if it's already been reported
• Please consider solving the issue by yourself and creating a pull request.

What is il_supermarket_parsers?

A simple access layer to the data the supermarkets publish. You can download the data using https://github.com/OpenIsraeliSupermarkets/israeli-supermarket-scarpers.

You only need to run the following code to parse all the data currently shared by the supermarkets and was downloaded using the package above.

from il_supermarket_parsers import ConvertingTask

task = ConvertingTask(
    source_configuration={"folder": "dumps"},
    output_configuration=[{"output_mode": "csv", "output_folder": "outputs"}],
    status_configuration={"database_type": "json", "base_path": "outputs"},
)
task.start()
task.join()

Optional filters (same names as Docker): enabled_parsers, files_types, and multiprocessing. Pass a maximum number of files with task.start(limit=10).

Quick start

il_supermarket_parsers can be installed using pip:

python3 pip install il_supermarket_parsers

If you want to run the latest version of the code, you can install it from the repo directly:

python3 -m pip install -U git+https://github.com/OpenIsraeliSupermarkets/israeli-supermarket-parsers.git
# or if you don't have 'git' installed
python3 -m pip install -U https://github.com/OpenIsraeliSupermarkets/israeli-supermarket-parsers/main

Running Docker

Build yourself:

docker build -t erlichsefi/israeli-supermarket-parsers --target prod .

or pull the existing image from docker hub:

docker pull erlichsefi/israeli-supermarket-parsers:latest

Then running it using:

docker run  -v "./dumps:/usr/src/app/dumps" \
            -v "./outputs:/usr/src/app/outputs" \
            -e ENABLED_PARSERS="BAREKET,YAYNO_BITAN_AND_CARREFOUR" \
            -e ENABLED_FILE_TYPES="STORE_FILE" \
            -e NUMBER_OF_PROCESSES=4 \
            -e LIMIT=1 \
            erlichsefi/israeli-supermarket-parsers

Optional paths (defaults match the volumes above): DATA_FOLDER (input), OUTPUT_FOLDER (CSV output), STATUS_FOLDER (JSON status; defaults to OUTPUT_FOLDER). Optional tuning: NUMBER_OF_PROCESSES, ENABLED_PARSERS, and ENABLED_FILE_TYPES (comma-separated enum names), LIMIT.

Contributing

Help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels.

If you need help getting started, don't hesitate to contact me.

Development status

IL SuperMarket Parser is beta software, as far as i see devlopment stoped until new issues will be found.