From 1ce1256e5a16b2936aad1905f1ff54bdb2bfce87 Mon Sep 17 00:00:00 2001 From: Enrique Barcelli Date: Sat, 8 Mar 2025 01:47:06 +0800 Subject: [PATCH] Add README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc9f8b9 --- /dev/null +++ b/README.md @@ -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. +