Add README.md

This commit is contained in:
Enrique Barcelli 2024-08-11 13:51:37 +08:00
parent 347d662f72
commit a357fad221
Signed by: kikobar
GPG key ID: 006C13A68E25D3B7

24
README.md Normal file
View file

@ -0,0 +1,24 @@
**Objective**
This Python script extracts data from .cvs files created by Revelup application into a Postres database.
**Requirements**
* Python installed on the machine running this application.
* Credentials with writing access to a Postgres database
**How to run this application**
* Copy the file `database.ini.sample` to `database.ini`.
* Edit `database.ini` with your credentials for the Postgres database.
* In Revelup run the following reports with output to `.csv` files:
* Order History - for a range of dates.
* Payment Summary - for a range of dates.
* Product Mix - for a SPECIFIC date, so if you need a range of dates you will need to run multiple reports.
* Hourly Sales - with the filters `Service Fees` and `Guests count` activated - for a SPECIFIC date, so if you need a range of dates you will need to run multiple reports.
* Copy all the `.csv` files generated by the Revelup reports to the `upload` folder.
* Run `python3 import_data.py`.
* The application will do the following:
* Read each line of data from the `.csv` files.
* Insert the data into the Postgres database.
* Move the `.csv` files to the `history` folder.