Merge pull request #186 from kellyjonbrazil/dev

Dev v1.17.5

.github/workflows/pythonapp.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -4,3 +4,5 @@ dist/
 build/
 *.egg-info/
 .github/
+.vscode/
+_config.yml

CHANGELOG

@@ -1,5 +1,32 @@
 jc changelog
 
+20211221 v1.17.5
+- Add zipinfo parser tested on linux and macOS
+
+20211207 v1.17.4
+- Add support for the NO_COLOR environment variable to set mono (http://no-color.org/)
+- Add -C option to force color output even when using pipes (overrides -m and NO_COLOR)
+
+20211202 v1.17.3
+- Update parsers to exit with error if non-string input is detected (raise TypeError)
+- Update streaming parsers to exit with error if non-iterable input is detected (raise TypeError)
+- Simplify quiet-checking in parsers
+- Add iostat parser tested on linux
+- Add iostat streaming parser tested on linux
+
+20211117 v1.17.2
+- Fix ping parser to add Alpine linux support
+- Fix netstat parser for older versions of netstat on linux
+- Fix df parser for cases where the filesystem field overflows the column length
+
+20211030 v1.17.1
+- Fix file parser for gzip files
+- Fix uname parser for cases where the 'processor' and/or 'hardware_platform' fields are missing on linux
+- Fix uname parser on FreeBSD
+- Add lsusb parser tested on linux
+- Add CSV file streaming parser
+- Add testing for Python 3.10.0
+
 20210923 v1.17.0
 - Note to Package Maintainers: please see note at 20210720 v1.16.0
 - Add wrapping of warning and error messages
@@ -23,7 +50,7 @@ jc changelog
 20210720 v1.16.0
 - Note to Package Maintainers:
     TL;DR: `/man/jc.1.gz` and `/jc/man/jc.1.gz` are deprecated and only `/man/jc.1` should be used.
-    
+
     The Man page in the PyPi source packages will be moving from `/jc/man/jc.1.gz` to `/man/jc.1`
     in version 1.17.0. For now the Man pages will be available in both locations, but be aware that
     the Man page at `/jc/man/jc.1.gz` is now considered deprecated.
@@ -38,7 +65,7 @@ jc changelog
 - Binaries and DEB/RPM/MSI packages now include Python 3.9.5 interpreter
 
 20210628 v1.15.6
-- Fix issue to only load local plugin parsers that have filenames that end in .py 
+- Fix issue to only load local plugin parsers that have filenames that end in .py
 
 20210520 v1.15.5
 - Fix issue where help and about information would not display if a 3rd party parser library was missing. (e.g. xmltodict)

EXAMPLES.md

@@ -1516,6 +1516,50 @@ cat example.ini | jc --ini -p
   }
 }
 ```
+### iostat
+```bash
+$ iostat | jc --iostat -p          # or:  jc -p iostat
+```
+```json
+[
+  {
+      "percent_user": 0.15,
+      "percent_nice": 0.0,
+      "percent_system": 0.18,
+      "percent_iowait": 0.0,
+      "percent_steal": 0.0,
+      "percent_idle": 99.67,
+      "type": "cpu"
+  },
+  {
+      "device": "sda",
+      "tps": 0.29,
+      "kb_read_s": 7.22,
+      "kb_wrtn_s": 1.25,
+      "kb_read": 194341,
+      "kb_wrtn": 33590,
+      "type": "device"
+  },
+  {
+      "device": "dm-0",
+      "tps": 0.29,
+      "kb_read_s": 5.99,
+      "kb_wrtn_s": 1.17,
+      "kb_read": 161361,
+      "kb_wrtn": 31522,
+      "type": "device"
+  },
+  {
+      "device": "dm-1",
+      "tps": 0.0,
+      "kb_read_s": 0.08,
+      "kb_wrtn_s": 0.0,
+      "kb_read": 2204,
+      "kb_wrtn": 0,
+      "type": "device"
+  }
+]
+```
 ### iptables
 ```bash
 iptables --line-numbers -v -L -t nat | jc --iptables -p          # or:  jc -p iptables --line-numbers -v -L -t nat
@@ -1917,6 +1961,128 @@ lsof | jc --lsof -p          # or:  jc -p lsof
   }
 ]
 ```
+### lsusb
+```bash
+lsusb -v | jc --lsusb -p          # or: jc -p lsusb -v
+```
+```json
+[
+  {
+    "bus": "002",
+    "device": "001",
+    "id": "1d6b:0001",
+    "description": "Linux Foundation 1.1 root hub",
+    "device_descriptor": {
+      "bLength": {
+        "value": "18"
+      },
+      "bDescriptorType": {
+        "value": "1"
+      },
+      "bcdUSB": {
+        "value": "1.10"
+      },
+      ...
+      "bNumConfigurations": {
+        "value": "1"
+      },
+      "configuration_descriptor": {
+        "bLength": {
+          "value": "9"
+        },
+        ...
+        "iConfiguration": {
+          "value": "0"
+        },
+        "bmAttributes": {
+          "value": "0xe0",
+          "attributes": [
+            "Self Powered",
+            "Remote Wakeup"
+          ]
+        },
+        "MaxPower": {
+          "description": "0mA"
+        },
+        "interface_descriptors": [
+          {
+            "bLength": {
+              "value": "9"
+            },
+            ...
+            "bInterfaceProtocol": {
+              "value": "0",
+              "description": "Full speed (or root) hub"
+            },
+            "iInterface": {
+              "value": "0"
+            },
+            "endpoint_descriptors": [
+              {
+                "bLength": {
+                  "value": "7"
+                },
+                ...
+                "bmAttributes": {
+                  "value": "3",
+                  "attributes": [
+                    "Transfer Type  Interrupt",
+                    "Synch Type  None",
+                    "Usage Type  Data"
+                  ]
+                },
+                "wMaxPacketSize": {
+                  "value": "0x0002",
+                  "description": "1x 2 bytes"
+                },
+                "bInterval": {
+                  "value": "255"
+                }
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "hub_descriptor": {
+      "bLength": {
+        "value": "9"
+      },
+      ...
+      "wHubCharacteristic": {
+        "value": "0x000a",
+        "attributes": [
+          "No power switching (usb 1.0)",
+          "Per-port overcurrent protection"
+        ]
+      },
+      ...
+      "hub_port_status": {
+        "Port 1": {
+          "value": "0000.0103",
+          "attributes": [
+            "power",
+            "enable",
+            "connect"
+          ]
+        },
+        "Port 2": {
+          "value": "0000.0103",
+          "attributes": [
+            "power",
+            "enable",
+            "connect"
+          ]
+        }
+      }
+    },
+    "device_status": {
+      "value": "0x0001",
+      "description": "Self Powered"
+    }
+  }
+]
+```
 ### mount
 ```bash
 mount | jc --mount -p          # or:  jc -p mount
@@ -3627,5 +3793,36 @@ cat istio.yaml | jc --yaml -p
   }
 ]
 ```
+### zipinfo
+```bash
+zipinfo file.zip | jc --zipinfo -p          # or:  jc -p zipinfo file.zip
+```
+```json
+[
+  {
+    "archive": "file.zip",
+    "size": 4116,
+    "size_unit": "bytes",
+    "number_entries": 1,
+    "number_files": 1,
+    "bytes_uncompressed": 11837,
+    "bytes_compressed": 3966,
+    "percent_compressed": 66.5,
+    "files": [
+      {
+        "flags": "-rw-r--r--",
+        "zipversion": "2.1",
+        "zipunder": "unx",
+        "filesize": 11837,
+        "type": "bX",
+        "method": "defN",
+        "date": "21-Dec-08",
+        "time": "20:50",
+        "filename": "compressed_file"
+      }
+    ]
+  }
+]
+```
 
 © 2019-2021 Kelly Brazil

README.md

@@ -3,7 +3,7 @@
 
 > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/)
 
-> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection! See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example.
+> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection. See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example.
 
 # JC
 JSON CLI output utility
@@ -115,6 +115,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--crontab` enables the `crontab` command and file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab))
 - `--crontab-u` enables the `crontab` file parser with user support ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab_u))
 - `--csv` enables the CSV file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/csv))
+- `--csv-s` enables the CSV file streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/csv_s))
 - `--date` enables the `date` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/date))
 - `--df` enables the `df` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/df))
 - `--dig` enables the `dig` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/dig))
@@ -137,6 +138,8 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--id` enables the `id` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/id))
 - `--ifconfig` enables the `ifconfig` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ifconfig))
 - `--ini` enables the INI file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ini))
+- `--iostat` enables the `iostat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat))
+- `--iostat-s` enables the `iostat` command streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat_s))
 - `--iptables` enables the `iptables` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iptables))
 - `--iw-scan` enables the `iw dev [device] scan` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iw_scan))
 - `--jobs` enables the `jobs` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs))
@@ -147,6 +150,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--lsblk` enables the `lsblk` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/lsblk))
 - `--lsmod` enables the `lsmod` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/lsmod))
 - `--lsof` enables the `lsof` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/lsof))
+- `--lsusb` enables the `lsusb` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/lsusb))
 - `--mount` enables the `mount` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/mount))
 - `--netstat` enables the `netstat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/netstat))
 - `--ntpq` enables the `ntpq -p` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq))
@@ -184,9 +188,11 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--who` enables the `who` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/who))
 - `--xml` enables the XML file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/xml))
 - `--yaml` enables the YAML file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/yaml))
+- `--zipinfo` enables the `zipinfo` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo))
 
 ### Options
 - `-a` about `jc`. Prints information about `jc` and the parsers (in JSON, of course!)
+- `-C` force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable)
 - `-d` debug mode. Prints trace messages if parsing issues are encountered (use `-dd` for verbose debugging)
 - `-h` help. Use `jc -h --parser_name` for parser documentation
 - `-m` monochrome JSON output
@@ -225,6 +231,9 @@ or
 JC_COLORS=default,default,default,default
 ```
 
+### Disable Colors via Environment Variable
+You can set the [`NO_COLOR`](http://no-color.org/) environment variable to any value to disable color output in `jc`. Note that using the `-C` option to force color output will override both the `NO_COLOR` environment variable and the `-m` option.
+
 ### Streaming Parsers
 Most parsers load all of the data from STDIN, parse it, then output the entire JSON document serially. There are some streaming parsers (e.g. `ls-s` and `ping-s`) that immediately start processing and outputing the data line-by-line as [JSON Lines](https://jsonlines.org/) (aka [NDJSON](http://ndjson.org/)) while it is being received from STDIN. This can significantly reduce the amount of memory required to parse large amounts of command output (e.g. `ls -lR /`) and can sometimes process the data more quickly. Streaming parsers have slightly different behavior than standard parsers as outlined below.
 
@@ -290,7 +299,7 @@ Custom local parser plugins may be placed in a `jc/jcparsers` folder in your loc
 - macOS: `$HOME/Library/Application Support/jc/jcparsers`
 - Windows: `$LOCALAPPDATA\jc\jc\jcparsers`
 
-Local parser plugins are standard python module files. Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder.
+Local parser plugins are standard python module files. Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder.
 
 Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default parsers.
 

docs/parsers/acpi.md

@@ -252,4 +252,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport.md

@@ -105,4 +105,4 @@ Returns:
 ## Parser Information
 Compatibility:  darwin
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport_s.md

@@ -133,4 +133,4 @@ Returns:
 ## Parser Information
 Compatibility:  darwin
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/arp.md

@@ -142,4 +142,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/blkid.md

@@ -145,4 +145,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cksum.md

@@ -79,4 +79,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab.md

@@ -22,8 +22,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -195,4 +197,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab_u.md

@@ -18,8 +18,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -191,4 +193,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv.md

@@ -99,4 +99,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv_s.md

@@ -0,0 +1,85 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.csv_s
+jc - JSON CLI output utility `csv` file streaming parser
+
+> This streaming parser outputs JSON Lines
+
+The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. The first row of the file must be a header row.
+
+Note: The first 100 rows are read into memory to enable delimiter detection, then the rest of the rows are loaded lazily.
+
+Usage (cli):
+
+    $ cat file.csv | jc --csv-s
+
+Usage (module):
+
+    import jc.parsers.csv_s
+    result = jc.parsers.csv_s.parse(csv_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+Schema:
+
+    csv file converted to a Dictionary: https://docs.python.org/3/library/csv.html
+
+    {
+      "column_name1":     string,
+      "column_name2":     string,
+      "_jc_meta":                      # This object only exists if using -qq or ignore_exceptions=True
+        {
+          "success":      boolean,     # true if successfully parsed, false if error
+          "error":        string,      # exists if "success" is false
+          "line":         string       # exists if "success" is false
+        }
+    }
+
+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-s
+    {"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()
+```
+Provides parser metadata (version, author, etc.)
+
+## parse
+```python
+parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterator object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
+    raw:               (boolean)   output preprocessed JSON if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Yields:
+
+    Dictionary. Raw or processed structured data.
+
+Returns:
+
+    Iterator object
+
+## Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/date.md

@@ -96,4 +96,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 2.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/df.md

@@ -122,4 +122,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dig.md

@@ -341,4 +341,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
 
-Version 2.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dir.md

@@ -143,4 +143,4 @@ Returns:
 ## Parser Information
 Compatibility:  win32
 
-Version 1.3 by Rasheed Elsaleh (rasheed@rebelliondefense.com)
+Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

docs/parsers/dmidecode.md

@@ -150,4 +150,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dpkg_l.md

@@ -155,4 +155,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/du.md

@@ -112,4 +112,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/env.md

@@ -95,4 +95,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/file.md

@@ -87,4 +87,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/finger.md

@@ -115,4 +115,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/free.md

@@ -97,4 +97,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/fstab.md

@@ -110,4 +110,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/group.md

@@ -134,4 +134,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/gshadow.md

@@ -102,4 +102,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hash.md

@@ -62,4 +62,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hashsum.md

@@ -93,4 +93,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hciconfig.md

@@ -342,4 +342,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/history.md

@@ -85,4 +85,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hosts.md

@@ -99,4 +99,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/id.md

@@ -130,4 +130,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ifconfig.md

@@ -211,4 +211,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
-Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini.md

@@ -90,4 +90,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat.md

@@ -0,0 +1,187 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.iostat
+jc - JSON CLI output utility `iostat` command output parser
+
+Note: `iostat` version 11 and higher include a JSON output option
+
+Usage (cli):
+
+    $ iostat | jc --iostat
+
+    or
+
+    $ jc iostat
+
+Usage (module):
+
+    import jc.parsers.iostat
+    result = jc.parsers.iostat.parse(iostat_command_output)
+
+Schema:
+
+    [
+      {
+        "type":             string,
+        "percent_user":     float,
+        "percent_nice":     float,
+        "percent_system":   float,
+        "percent_iowait":   float,
+        "percent_steal":    float,
+        "percent_idle":     float,
+        "device":           string,
+        "tps":              float,
+        "kb_read_s":        float,
+        "mb_read_s":        float,
+        "kb_wrtn_s":        float,
+        "mb_wrtn_s":        float,
+        "kb_read":          integer,
+        "mb_read":          integer,
+        "kb_wrtn":          integer,
+        "mb_wrtn":          integer,
+        'kb_dscd':          integer,
+        'mb_dscd':          integer,
+        "rrqm_s":           float,
+        "wrqm_s":           float,
+        "r_s":              float,
+        "w_s":              float,
+        "rmb_s":            float,
+        "rkb_s":            float,
+        "wmb_s":            float,
+        "wkb_s":            float,
+        "avgrq_sz":         float,
+        "avgqu_sz":         float,
+        "await":            float,
+        "r_await":          float,
+        "w_await":          float,
+        "svctm":            float,
+        "aqu_sz":           float,
+        "rareq_sz":         float,
+        "wareq_sz":         float,
+        "d_s":              float,
+        "dkb_s":            float,
+        "dmb_s":            float,
+        "drqm_s":           float,
+        "percent_drqm":     float,
+        "d_await":          float,
+        "dareq_sz":         float,
+        "f_s":              float,
+        "f_await":          float,
+        "kb_dscd_s":        float,
+        "mb_dscd_s":        float,
+        "percent_util":     float,
+        "percent_rrqm":     float,
+        "percent_wrqm":     float
+      }
+    ]
+
+Examples:
+
+    $ iostat | jc --iostat -p
+    [
+      {
+          "percent_user": 0.15,
+          "percent_nice": 0.0,
+          "percent_system": 0.18,
+          "percent_iowait": 0.0,
+          "percent_steal": 0.0,
+          "percent_idle": 99.67,
+          "type": "cpu"
+      },
+      {
+          "device": "sda",
+          "tps": 0.29,
+          "kb_read_s": 7.22,
+          "kb_wrtn_s": 1.25,
+          "kb_read": 194341,
+          "kb_wrtn": 33590,
+          "type": "device"
+      },
+      {
+          "device": "dm-0",
+          "tps": 0.29,
+          "kb_read_s": 5.99,
+          "kb_wrtn_s": 1.17,
+          "kb_read": 161361,
+          "kb_wrtn": 31522,
+          "type": "device"
+      },
+      {
+          "device": "dm-1",
+          "tps": 0.0,
+          "kb_read_s": 0.08,
+          "kb_wrtn_s": 0.0,
+          "kb_read": 2204,
+          "kb_wrtn": 0,
+          "type": "device"
+      }
+    ]
+
+    $ iostat | jc --iostat -p -r
+    [
+      {
+        "percent_user": "0.15",
+        "percent_nice": "0.00",
+        "percent_system": "0.18",
+        "percent_iowait": "0.00",
+        "percent_steal": "0.00",
+        "percent_idle": "99.67",
+        "type": "cpu"
+      },
+      {
+        "device": "sda",
+        "tps": "0.29",
+        "kb_read_s": "7.22",
+        "kb_wrtn_s": "1.25",
+        "kb_read": "194341",
+        "kb_wrtn": "33590",
+        "type": "device"
+      },
+      {
+        "device": "dm-0",
+        "tps": "0.29",
+        "kb_read_s": "5.99",
+        "kb_wrtn_s": "1.17",
+        "kb_read": "161361",
+        "kb_wrtn": "31522",
+        "type": "device"
+      },
+      {
+        "device": "dm-1",
+        "tps": "0.00",
+        "kb_read_s": "0.08",
+        "kb_wrtn_s": "0.00",
+        "kb_read": "2204",
+        "kb_wrtn": "0",
+        "type": "device"
+      }
+    ]
+
+
+## info
+```python
+info()
+```
+Provides parser metadata (version, author, etc.)
+
+## 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.
+
+## Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat_s.md

@@ -0,0 +1,126 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.iostat_s
+jc - JSON CLI output utility `iostat` command output streaming parser
+
+> This streaming parser outputs JSON Lines
+
+Note: `iostat` version 11 and higher include a JSON output option
+
+Usage (cli):
+
+    $ iostat | jc --iostat-s
+
+Usage (module):
+
+    import jc.parsers.iostat_s
+    result = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "type":             string,
+      "percent_user":     float,
+      "percent_nice":     float,
+      "percent_system":   float,
+      "percent_iowait":   float,
+      "percent_steal":    float,
+      "percent_idle":     float,
+      "device":           string,
+      "tps":              float,
+      "kb_read_s":        float,
+      "mb_read_s":        float,
+      "kb_wrtn_s":        float,
+      "mb_wrtn_s":        float,
+      "kb_read":          integer,
+      "mb_read":          integer,
+      "kb_wrtn":          integer,
+      "mb_wrtn":          integer,
+      'kb_dscd':          integer,
+      'mb_dscd':          integer,
+      "rrqm_s":           float,
+      "wrqm_s":           float,
+      "r_s":              float,
+      "w_s":              float,
+      "rmb_s":            float,
+      "rkb_s":            float,
+      "wmb_s":            float,
+      "wkb_s":            float,
+      "avgrq_sz":         float,
+      "avgqu_sz":         float,
+      "await":            float,
+      "r_await":          float,
+      "w_await":          float,
+      "svctm":            float,
+      "aqu_sz":           float,
+      "rareq_sz":         float,
+      "wareq_sz":         float,
+      "d_s":              float,
+      "dkb_s":            float,
+      "dmb_s":            float,
+      "drqm_s":           float,
+      "percent_drqm":     float,
+      "d_await":          float,
+      "dareq_sz":         float,
+      "f_s":              float,
+      "f_await":          float,
+      "kb_dscd_s":        float,
+      "mb_dscd_s":        float,
+      "percent_util":     float,
+      "percent_rrqm":     float,
+      "percent_wrqm":     float,
+      "_jc_meta":                      # This object only exists if using -qq or ignore_exceptions=True
+        {
+          "success":      boolean,     # true if successfully parsed, false if error
+          "error":        string,      # exists if "success" is false
+          "line":         string       # exists if "success" is false
+        }
+    }
+
+Examples:
+
+    $ iostat | jc --iostat-s
+    {"percent_user":0.14,"percent_nice":0.0,"percent_system":0.16,"percent_iowait":0.0,"percent_steal":0.0,"percent_idle":99.7,"type":"cpu"}
+    {"device":"sda","tps":0.24,"kb_read_s":5.28,"kb_wrtn_s":1.1,"kb_read":203305,"kb_wrtn":42368,"type":"device"}
+    ...
+
+    $ iostat | jc --iostat-s -r
+    {"percent_user":"0.14","percent_nice":"0.00","percent_system":"0.16","percent_iowait":"0.00","percent_steal":"0.00","percent_idle":"99.70","type":"cpu"}
+    {"device":"sda","tps":"0.24","kb_read_s":"5.28","kb_wrtn_s":"1.10","kb_read":"203305","kb_wrtn":"42368","type":"device"}
+    ...
+
+
+## info
+```python
+info()
+```
+Provides parser metadata (version, author, etc.)
+
+## parse
+```python
+parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterator object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
+    raw:               (boolean)   output preprocessed JSON if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Yields:
+
+    Dictionary. Raw or processed structured data.
+
+Returns:
+
+    Iterator object
+
+## Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iptables.md

@@ -188,4 +188,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iw_scan.md

@@ -145,4 +145,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 0.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/jobs.md

@@ -117,4 +117,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/last.md

@@ -128,4 +128,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls.md

@@ -131,4 +131,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls_s.md

@@ -3,9 +3,11 @@
 # jc.parsers.ls_s
 jc - JSON CLI output utility `ls` and `vdir` command output streaming parser
 
-This streaming parser requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
+> This streaming parser outputs JSON Lines
 
-The `jc` `-q` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used)
+Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`.
+
+The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used)
 
 The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
 
@@ -37,7 +39,7 @@ Schema:
       "epoch_utc":      integer,     # timezone aware timestamp if date field is in UTC and can be converted
       "_jc_meta":                    # This object only exists if using -qq or ignore_exceptions=True
         {
-          "success":    booean,      # true if successfully parsed, false if error
+          "success":    boolean,     # true if successfully parsed, false if error
           "error":      string,      # exists if "success" is false
           "line":       string       # exists if "success" is false
         }
@@ -89,4 +91,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsblk.md

@@ -293,4 +293,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsmod.md

@@ -150,4 +150,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsof.md

@@ -144,4 +144,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsusb.md

@@ -0,0 +1,288 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.lsusb
+jc - JSON CLI output utility `lsusb` command output parser
+
+Supports the `-v` option or no options.
+
+Usage (cli):
+
+    $ lsusb -v | jc --lsusb
+
+    or
+
+    $ jc lsusb -v
+
+Usage (module):
+
+    import jc.parsers.lsusb
+    result = jc.parsers.lsusb.parse(lsusb_command_output)
+
+Schema:
+
+    Note: <item> object keynames are assigned directly from the lsusb output.
+          If there are duplicate <item> names in a section, only the last one is converted.
+
+    [
+      {
+        "bus":                                string,
+        "device":                             string,
+        "id":                                 string,
+        "description":                        string,
+        "device_descriptor": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string,
+            "attributes": [
+                                              string
+            ]
+          },
+          "configuration_descriptor": {
+            "<item>": {
+              "value":                        string,
+              "description":                  string,
+              "attributes": [
+                                              string
+              ]
+            },
+            "interface_association": {
+              "<item>": {
+                "value":                      string,
+                "description":                string,
+                "attributes": [
+                                              string
+                ]
+              }
+            },
+            "interface_descriptors": [
+              {
+                "<item>": {
+                  "value":                    string,
+                  "description":              string,
+                  "attributes": [
+                                              string
+                  ]
+                },
+                "cdc_header": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_call_management": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_acm": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_union": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "endpoint_descriptors": [
+                  {
+                    "<item>": {
+                      "value":                string,
+                      "description":          string,
+                      "attributes": [
+                                              string
+                      ]
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "hub_descriptor": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string,
+            "attributes": [
+                                              string,
+            ]
+          },
+          "hub_port_status": {
+            "<item>": {
+              "value":                        string,
+              "attributes": [
+                                              string
+              ]
+            }
+          }
+        },
+        "device_status": {
+          "value":                            string,
+          "description":                      string
+        }
+      }
+    ]
+
+Examples:
+
+    $ lsusb -v | jc --lsusb -p
+    [
+      {
+        "bus": "002",
+        "device": "001",
+        "id": "1d6b:0001",
+        "description": "Linux Foundation 1.1 root hub",
+        "device_descriptor": {
+          "bLength": {
+            "value": "18"
+          },
+          "bDescriptorType": {
+            "value": "1"
+          },
+          "bcdUSB": {
+            "value": "1.10"
+          },
+          ...
+          "bNumConfigurations": {
+            "value": "1"
+          },
+          "configuration_descriptor": {
+            "bLength": {
+              "value": "9"
+            },
+            ...
+            "iConfiguration": {
+              "value": "0"
+            },
+            "bmAttributes": {
+              "value": "0xe0",
+              "attributes": [
+                "Self Powered",
+                "Remote Wakeup"
+              ]
+            },
+            "MaxPower": {
+              "description": "0mA"
+            },
+            "interface_descriptors": [
+              {
+                "bLength": {
+                  "value": "9"
+                },
+                ...
+                "bInterfaceProtocol": {
+                  "value": "0",
+                  "description": "Full speed (or root) hub"
+                },
+                "iInterface": {
+                  "value": "0"
+                },
+                "endpoint_descriptors": [
+                  {
+                    "bLength": {
+                      "value": "7"
+                    },
+                    ...
+                    "bmAttributes": {
+                      "value": "3",
+                      "attributes": [
+                        "Transfer Type  Interrupt",
+                        "Synch Type  None",
+                        "Usage Type  Data"
+                      ]
+                    },
+                    "wMaxPacketSize": {
+                      "value": "0x0002",
+                      "description": "1x 2 bytes"
+                    },
+                    "bInterval": {
+                      "value": "255"
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "hub_descriptor": {
+          "bLength": {
+            "value": "9"
+          },
+          ...
+          "wHubCharacteristic": {
+            "value": "0x000a",
+            "attributes": [
+              "No power switching (usb 1.0)",
+              "Per-port overcurrent protection"
+            ]
+          },
+          ...
+          "hub_port_status": {
+            "Port 1": {
+              "value": "0000.0103",
+              "attributes": [
+                "power",
+                "enable",
+                "connect"
+              ]
+            },
+            "Port 2": {
+              "value": "0000.0103",
+              "attributes": [
+                "power",
+                "enable",
+                "connect"
+              ]
+            }
+          }
+        },
+        "device_status": {
+          "value": "0x0001",
+          "description": "Self Powered"
+        }
+      }
+    ]
+
+
+## info
+```python
+info()
+```
+Provides parser metadata (version, author, etc.)
+
+## 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.
+
+## Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mount.md

@@ -100,4 +100,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/netstat.md

@@ -379,4 +379,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ntpq.md

@@ -231,4 +231,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/passwd.md

@@ -119,4 +119,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping.md

@@ -181,4 +181,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping_s.md

@@ -3,13 +3,15 @@
 # jc.parsers.ping_s
 jc - JSON CLI output utility `ping` command output streaming parser
 
+> This streaming parser outputs JSON Lines
+
 Supports `ping` and `ping6` output.
 
 Usage (cli):
 
     $ ping | jc --ping-s
 
-> Note: When piping `jc` converted ping output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information.
+> Note: When piping `jc` converted `ping` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) for more information.
 
 Usage (module):
 
@@ -44,7 +46,7 @@ Schema:
       "round_trip_ms_stddev":        float,
       "_jc_meta":                                  # This object only exists if using -qq or ignore_exceptions=True
         {
-          "success":                 booean,       # true if successfully parsed, false if error
+          "success":                 boolean,      # true if successfully parsed, false if error
           "error":                   string,       # exists if "success" is false
           "line":                    string        # exists if "success" is false
         }
@@ -96,4 +98,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_list.md

@@ -72,4 +72,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_show.md

@@ -90,4 +90,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ps.md

@@ -231,4 +231,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/route.md

@@ -133,4 +133,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/rpm_qi.md

@@ -181,4 +181,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/sfdisk.md

@@ -225,4 +225,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/shadow.md

@@ -126,4 +126,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ss.md

@@ -303,4 +303,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/stat.md

@@ -193,4 +193,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/sysctl.md

@@ -79,4 +79,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl.md

@@ -83,4 +83,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_lj.md

@@ -100,4 +100,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_ls.md

@@ -75,4 +75,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_luf.md

@@ -71,4 +71,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systeminfo.md

@@ -229,4 +229,4 @@ Returns:
 ## Parser Information
 Compatibility:  win32
 
-Version 1.0 by Jon Smith (jon@rebelliondefense.com)
+Version 1.1 by Jon Smith (jon@rebelliondefense.com)

docs/parsers/time.md

@@ -148,4 +148,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/timedatectl.md

@@ -88,4 +88,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/tracepath.md

@@ -156,4 +156,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/traceroute.md

@@ -142,4 +142,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ufw.md

@@ -222,4 +222,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ufw_appinfo.md

@@ -155,4 +155,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/uname.md

@@ -72,4 +72,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/upower.md

@@ -219,4 +219,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/uptime.md

@@ -90,4 +90,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/vmstat.md

@@ -146,4 +146,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/vmstat_s.md

@@ -3,6 +3,8 @@
 # jc.parsers.vmstat_s
 jc - JSON CLI output utility `vmstat` command output streaming parser
 
+> This streaming parser outputs JSON Lines
+
 Options supported: `-a`, `-w`, `-d`, `-t`
 
 The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
@@ -13,6 +15,8 @@ Usage (cli):
 
     $ vmstat | jc --vmstat-s
 
+> Note: When piping `jc` converted `vmstat` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `vmstat` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) for more information.
+
 Usage (module):
 
     import jc.parsers.vmstat_s
@@ -59,7 +63,7 @@ Schema:
       "epoch_utc":                         integer      # aware timestamp if -t flag is used and UTC TZ
       "_jc_meta":                                       # This object only exists if using -qq or ignore_exceptions=True
         {
-          "success":                       booean,      # true if successfully parsed, false if error
+          "success":                       boolean,     # true if successfully parsed, false if error
           "error":                         string,      # exists if "success" is false
           "line":                          string       # exists if "success" is false
         }
@@ -107,4 +111,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux
 
-Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/w.md

@@ -128,4 +128,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/wc.md

@@ -79,4 +79,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/who.md

@@ -157,4 +157,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/xml.md

@@ -95,4 +95,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/yaml.md

@@ -109,4 +109,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/zipinfo.md

@@ -0,0 +1,106 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.zipinfo
+jc - JSON CLI output utility `zipinfo` command output parser
+
+Options supported:
+- none
+
+Note: The default listing format.
+
+Usage (cli):
+
+    $ zipinfo <archive> | jc --zipinfo
+
+    or
+
+    $ jc zipinfo
+
+Usage (module):
+
+    import jc.parsers.zipinfo
+    result = jc.parsers.zipinfo.parse(zipinfo_command_output)
+
+Schema:
+    [
+      {
+        "archive":              string,
+        "size":                 integer,
+        "size_unit":            string,
+        "number_entries":       integer,
+        "number_files":         integer,
+        "bytes_uncompressed":   integer,
+        "bytes_compressed":     integer,
+        "percent_compressed":   float,
+        "files": [
+          {
+            "flags":            string,
+            "zipversion":       string,
+            "zipunder":         string
+            "filesize":         integer,
+            "type":             string,
+            "method":           string,
+            "date":             string,
+            "time":             string,
+            "filename":         string
+          }
+        ]
+      }
+    ]
+
+Examples:
+
+    $ zipinfo log4j-core-2.16.0.jar | jc --zipinfo -p
+
+    [
+      {
+        "archive": "log4j-core-2.16.0.jar",
+        "size": 1789565,
+        "size_unit": "bytes",
+        "number_entries": 1218,
+        "number_files": 1218,
+        "bytes_uncompressed": 3974141,
+        "bytes_compressed": 1515455,
+        "percent_compressed": 61.9,
+        "files": [
+          {
+            "flags": "-rw-r--r--",
+            "zipversion": "2.0",
+            "zipunder": "unx",
+            "filesize": 19810,
+            "type": "bl",
+            "method": "defN",
+            "date": "21-Dec-12",
+            "time": "23:35",
+            "filename": "META-INF/MANIFEST.MF"
+          },
+    ...
+
+
+## info
+```python
+info()
+```
+Provides parser metadata (version, author, etc.)
+
+## 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.
+
+## Parser Information
+Compatibility:  linux, darwin
+
+Version 0.01 by Matt J (https://github.com/listuser)

docs/utils.md

@@ -40,7 +40,7 @@ Returns:
 
 ## compatibility
 ```python
-compatibility(mod_name, compatible)
+compatibility(mod_name, compatible, quiet=False)
 ```
 Checks for the parser's compatibility with the running OS platform.
 
@@ -52,6 +52,8 @@ Parameters:
                     compatible options:
                     linux, darwin, cygwin, win32, aix, freebsd
 
+    quiet:          (bool) supress compatibility message if True
+
 Returns:
 
     None - just prints output to STDERR
@@ -135,6 +137,24 @@ Reraise the stream exception with annotation or print an error `_jc_meta`
 field if `ignore_exceptions=True`
 
 
+## input_type_check
+```python
+input_type_check(data)
+```
+Ensure input data is a string
+
+## streaming_input_type_check
+```python
+streaming_input_type_check(data)
+```
+Ensure input data is an iterable, but not a string or bytes
+
+## streaming_line_input_type_check
+```python
+streaming_line_input_type_check(line)
+```
+Ensure each line is a string
+
 ## timestamp
 ```python
 timestamp(datetime_string)

jc/__init__.py

@@ -73,4 +73,4 @@ Module Example:
 """
 
 name = 'jc'
-__version__ = '1.17.0'
+__version__ = '1.17.5'

jc/cli.py

@@ -53,6 +53,7 @@ parsers = [
     'crontab',
     'crontab-u',
     'csv',
+    'csv-s',
     'date',
     'df',
     'dig',
@@ -75,6 +76,8 @@ parsers = [
     'id',
     'ifconfig',
     'ini',
+    'iostat',
+    'iostat-s',
     'iptables',
     'iw-scan',
     'jobs',
@@ -85,6 +88,7 @@ parsers = [
     'lsblk',
     'lsmod',
     'lsof',
+    'lsusb',
     'mount',
     'netstat',
     'ntpq',
@@ -121,7 +125,8 @@ parsers = [
     'wc',
     'who',
     'xml',
-    'yaml'
+    'yaml',
+    'zipinfo'
 ]
 
 JC_ERROR_EXIT = 100
@@ -231,9 +236,11 @@ def set_env_colors(env_colors=None):
     }
 
 
-def piped_output():
-    """Return False if stdout is a TTY. True if output is being piped to another program"""
-    return not sys.stdout.isatty()
+def piped_output(force_color):
+    """Return False if stdout is a TTY. True if output is being piped to another program
+       and foce_color is True. This allows forcing of ANSI color codes even when using pipes.
+    """
+    return not sys.stdout.isatty() and not force_color
 
 
 def ctrlc(signum, frame):
@@ -331,6 +338,7 @@ def helptext():
 {parsers_string}
     Options:
             -a    about jc
+            -C    force color output even when using pipes (overrides -m)
             -d    debug (-dd for verbose debug)
             -h    help (-h --parser_name for parser documentation)
             -m    monochrome output
@@ -522,7 +530,8 @@ def main():
     about = 'a' in options
     debug = 'd' in options
     verbose_debug = options.count('d') > 1
-    mono = 'm' in options
+    force_color = 'C' in options
+    mono = ('m' in options or bool(os.getenv('NO_COLOR'))) and not force_color
     help_me = 'h' in options
     pretty = 'p' in options
     quiet = 'q' in options
@@ -538,7 +547,11 @@ def main():
         mono = True
 
     if about:
-        print(json_out(about_jc(), pretty=pretty, env_colors=jc_colors, mono=mono, piped_out=piped_output()))
+        print(json_out(about_jc(),
+              pretty=pretty,
+              env_colors=jc_colors,
+              mono=mono,
+              piped_out=piped_output(force_color)))
         sys.exit(0)
 
     if help_me:
@@ -628,7 +641,7 @@ def main():
                                pretty=pretty,
                                env_colors=jc_colors,
                                mono=mono,
-                               piped_out=piped_output()),
+                               piped_out=piped_output(force_color)),
                       flush=unbuffer)
 
             sys.exit(combined_exit_code(magic_exit_code, 0))
@@ -641,7 +654,7 @@ def main():
                            pretty=pretty,
                            env_colors=jc_colors,
                            mono=mono,
-                           piped_out=piped_output()),
+                           piped_out=piped_output(force_color)),
                   flush=unbuffer)
 
         sys.exit(combined_exit_code(magic_exit_code, 0))

jc/parsers/acpi.py

@@ -227,7 +227,7 @@ import jc.utils
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.2'
+    version = '1.3'
     description = '`acpi` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -302,8 +302,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
     output_line = {}

jc/parsers/airport.py

@@ -80,7 +80,7 @@ import jc.utils
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.3'
+    version = '1.4'
     description = '`airport -I` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -130,8 +130,8 @@ def parse(data, raw=False, quiet=False):
 
         Dictionary. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = {}
 

jc/parsers/airport_s.py

@@ -109,7 +109,7 @@ import jc.parsers.universal
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.4'
+    version = '1.5'
     description = '`airport -s` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -166,8 +166,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
     cleandata = list(filter(None, data.splitlines()))

jc/parsers/arp.py

@@ -118,7 +118,7 @@ import jc.parsers.universal
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.7'
+    version = '1.8'
     description = '`arp` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -171,8 +171,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
     cleandata = list(filter(None, data.splitlines()))

jc/parsers/blkid.py

@@ -121,7 +121,7 @@ import jc.utils
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.4'
+    version = '1.5'
     description = '`blkid` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -176,8 +176,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
 

jc/parsers/cksum.py

@@ -54,7 +54,7 @@ import jc.utils
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.2'
+    version = '1.3'
     description = '`cksum` and `sum` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -103,8 +103,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
 

jc/parsers/crontab.py

@@ -19,8 +19,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -171,7 +173,7 @@ import jc.parsers.universal
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.5'
+    version = '1.6'
     description = '`crontab` command and file parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -225,8 +227,8 @@ def parse(data, raw=False, quiet=False):
 
         Dictionary. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = {}
     cleandata = data.splitlines()

jc/parsers/crontab_u.py

@@ -15,8 +15,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -167,7 +169,7 @@ import jc.parsers.universal
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.6'
+    version = '1.7'
     description = '`crontab` file parser with user support'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -220,8 +222,8 @@ def parse(data, raw=False, quiet=False):
 
         Dictionary. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = {}
     cleandata = data.splitlines()

jc/parsers/csv.py

@@ -75,7 +75,7 @@ import csv
 
 class info():
     """Provides parser metadata (version, author, etc.)"""
-    version = '1.2'
+    version = '1.3'
     description = 'CSV file parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -119,8 +119,8 @@ def parse(data, raw=False, quiet=False):
 
         List of Dictionaries. Raw or processed structured data.
     """
-    if not quiet:
-        jc.utils.compatibility(__name__, info.compatible)
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
 
     raw_output = []
     cleandata = data.splitlines()

jc/parsers/csv_s.py

@@ -0,0 +1,139 @@
+"""jc - JSON CLI output utility `csv` file streaming parser
+
+> This streaming parser outputs JSON Lines
+
+The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. The first row of the file must be a header row.
+
+Note: The first 100 rows are read into memory to enable delimiter detection, then the rest of the rows are loaded lazily.
+
+Usage (cli):
+
+    $ cat file.csv | jc --csv-s
+
+Usage (module):
+
+    import jc.parsers.csv_s
+    result = jc.parsers.csv_s.parse(csv_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+Schema:
+
+    csv file converted to a Dictionary: https://docs.python.org/3/library/csv.html
+
+    {
+      "column_name1":     string,
+      "column_name2":     string,
+      "_jc_meta":                      # This object only exists if using -qq or ignore_exceptions=True
+        {
+          "success":      boolean,     # true if successfully parsed, false if error
+          "error":        string,      # exists if "success" is false
+          "line":         string       # exists if "success" is false
+        }
+    }
+
+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-s
+    {"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"}
+    ...
+"""
+import itertools
+import csv
+import jc.utils
+from jc.utils import stream_success, stream_error
+from jc.exceptions import ParseError
+
+
+class info():
+    """Provides parser metadata (version, author, etc.)"""
+    version = '1.1'
+    description = 'CSV file streaming parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    details = 'Using the python standard csv library'
+    compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']
+    streaming = True
+
+
+__version__ = info.version
+
+
+def _process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (List of Dictionaries) raw structured data to process
+
+    Returns:
+
+        List of Dictionaries. Each Dictionary represents a row in the csv file.
+    """
+    # No further processing
+    return proc_data
+
+
+def parse(data, raw=False, quiet=False, ignore_exceptions=False):
+    """
+    Main text parsing generator function. Returns an iterator object.
+
+    Parameters:
+
+        data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
+        raw:               (boolean)   output preprocessed JSON if True
+        quiet:             (boolean)   suppress warning messages if True
+        ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+    Yields:
+
+        Dictionary. Raw or processed structured data.
+
+    Returns:
+
+        Iterator object
+    """
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.streaming_input_type_check(data)
+
+    # convert data to an iterable in case a sequence like a list is used as input.
+    # this allows the exhaustion of the input so we don't double-process later.
+    data = iter(data)
+    temp_list = []
+
+    # first, load the first 100 lines into a list to detect the CSV dialect
+    for line in itertools.islice(data, 100):
+        temp_list.append(line)
+
+    # check for Python bug that does not split on `\r` newlines from sys.stdin correctly
+    # https://bugs.python.org/issue45617
+    if len(temp_list) == 1:
+        raise ParseError('Unable to detect line endings. Please try the non-streaming CSV parser instead.')
+
+    sniffdata = '\n'.join(temp_list)
+
+    dialect = None
+    try:
+        dialect = csv.Sniffer().sniff(sniffdata)
+    except Exception:
+        pass
+
+    # chain `temp_list` and `data` together to lazy load the rest of the CSV data
+    new_data = itertools.chain(temp_list, data)
+    reader = csv.DictReader(new_data, dialect=dialect)
+
+    for row in reader:
+        try:
+            yield stream_success(row, ignore_exceptions) if raw else stream_success(_process(row), ignore_exceptions)
+        except Exception as e:
+            yield stream_error(e, ignore_exceptions, row)