kikobar/dineconnect
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 2 Wiki Activity

Add README.md

Browse source
This commit is contained in:
Enrique Barcelli 2025-03-08 01:47:06 +08:00
parent 365e17029d
commit 1ce1256e5a
Signed by: kikobar
GPG key ID: 006C13A68E25D3B7
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md Normal file
View file

@ -0,0 +1,16 @@
**Objective**
These Python scripts allow to extract records from the DineConnect API and post them to a Mongo database.
**Requirements**
* Python installed on the machine running this application.
* Credentials for accessing the DineConnect API - you need to request to DineConnect for your credentials.
* Credentials for writing to a MongDB database - this database will be used for storing the data extracted from the DineConnect API.
**How to run this application**
* Copy the file `config-sample.py` to `config.py`.
* Edit `config.py` with your credentials and defaults.
* To extract the tickets records from the DineConnect API and post them to the Mongo database, run `python3 extract_tickets.py` and follow the instructions of the script.