add csv file parser

2026-06-19 22:28:17 +02:00 · 2020-03-02 14:03:58 -08:00
parent 0c42db38b1
commit d9c4e2ed4c
4 changed files with 241 additions and 0 deletions
@@ -0,0 +1,104 @@
+# jc.parsers.csv
+jc - JSON CLI output utility csv Parser
+
+Usage:
+
+    specify --csv as the first argument if the piped input is coming from a csv file.
+    the csv parser will attempt to automatically detect the delimter character.
+    the first row of the file must be a header row.
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+
+Examples:
+
+    $ cat homes.csv
+    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres", "Taxes"
+    142, 160, 28, 10, 5, 3,  60, 0.28,  3167
+    175, 180, 18,  8, 4, 1,  12, 0.43,  4033
+    129, 132, 13,  6, 3, 1,  41, 0.33,  1471
+    ...
+
+    $ cat homes.csv | jc --csv -p
+    [
+      {
+        "Sell": "142",
+        "List": "160",
+        "Living": "28",
+        "Rooms": "10",
+        "Beds": "5",
+        "Baths": "3",
+        "Age": "60",
+        "Acres": "0.28",
+        "Taxes": "3167"
+      },
+      {
+        "Sell": "175",
+        "List": "180",
+        "Living": "18",
+        "Rooms": "8",
+        "Beds": "4",
+        "Baths": "1",
+        "Age": "12",
+        "Acres": "0.43",
+        "Taxes": "4033"
+      },
+      {
+        "Sell": "129",
+        "List": "132",
+        "Living": "13",
+        "Rooms": "6",
+        "Beds": "3",
+        "Baths": "1",
+        "Age": "41",
+        "Acres": "0.33",
+        "Taxes": "1471"
+      },
+      ...
+    ]
+
+## info
+```python
+info(self, /, *args, **kwargs)
+```
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Each dictionary represents a row in the csv file:
+
+    [
+      {
+        csv file converted to a Dictionary
+        https://docs.python.org/3/library/csv.html
+      }
+    ]
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+