update readme

This commit is contained in:
gowthaman 2023-06-17 23:59:02 +05:30
parent 20ff823972
commit 0fd1a5f79b

View File

@ -3,9 +3,10 @@ JSON to CSV
with support for nested structures (with auto schema)
Steps
## Install
* install required packages `pip install -r requirements.txt`
## Steps
* run `python3 main.py`
* required `--input <dir of input json>`
* required `--output <dir of output csvs>`
@ -14,6 +15,12 @@ Steps
* (optional) # of records to check records for all headers `--metadata <number or records>` defaults to 1000
* required `--join-column <column name from first level to use as merge column>`
* required `--name <base-name of data>`
* example
* `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id`
## examples
* default with | as delimiter
* `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id`
* use comma (,) as delimiter
* `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id --delimiter ","`
* use tab (\t) as delimiter
* `python main.py --input /var/tmp/input --output /var/tmp/output --single --metadata 1000 --join-column origin_id --name oopsy --delimiter "$(echo -en '\t')"`