minor fix for macOS binary

Dev v1.18.0

.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,109 @@
 jc changelog
 
+20220121 v1.18.1
+- Minor fix for MacOS binary
+
+20220121 v1.18.0
+- Add high-level parse API for built-in and plugin parsers
+- Add python module developer documentation
+- Enhance magic syntax exception messages
+- Enhance documentation formatting
+
+20220106 v1.17.7
+- Add stat command streaming parser tested on linux and macOS
+
+20220103 v1.17.6
+- Add jar-manifest file parser (for MANIFEST.MF files)
+- Fix CSV parsers for some files that include doublequotes
+
+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
+- Add vmstat parser tested on linux
+- Add support for streaming parsers
+- Add ls command streaming parser tested on linux, macOS, and freeBSD
+- Add ping command streaming parser tested on linux, macOS, and freeBSD
+- Add vmstat command streaming parser tested on linux
+- Add -u option to allow unbuffered output
+
+20210830 v1.16.2
+- Note to Package Maintainers: please see note at 20210720 v1.16.0
+- Update sfdisk parser to support the -F option and newer versions of sfdisk
+
+20210813 v1.16.1
+- Note to Package Maintainers: please see note at 20210720 v1.16.0
+- Fix issue with process substitution with the magic syntax
+- Fix issue with globs not including filenames with spaces with magic syntax
+- Fix stat parser to properly handle filenames with spaces on macOS/BSD
+
+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.
+
+    Also, starting in v1.17.0, the Man page will no longer be compressed in the source package,
+    therefore `/man/jc.1.gz` should also be considered deprecated and will no longer be available
+    after v1.17.0. Please use `/man/jc.1` and compress downstream if you would like.
+- Include CHANGELOG in source distribution
+- Fix Man page location in source packages
+- Add sfdisk command parser tested on linux
+- Update unit test files to change the timezone when needed (POSIX only)
+- 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
+
+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)
+- Add more error message detail when encountering ParseError and LibraryNotFound exceptions
+
+20210517 v1.15.4
+- Update ping parser to support error responses in OSX and BSD
+- Update ping parser to be more resilient against parsing errors for unknown error types
+- Update dig parser to support `+noall +answer` use case
+- Update dig parser compatibility to all platforms
+- Fix colors in Windows terminals (cmd.exe and PowerShell)
+- Fix epoch calculations when UTC is referenced as "Coordinated Universal Time"
+- Add Windows time format for systeminfo output
+- Add exceptions module to standardize parser exceptions
+- JC no longer swallows exit codes when using the "magic" syntax. See the Exit Codes section of the README and man page for details
+
+20210426 v1.15.3
+- Add ufw status command parser tested on linux
+- Add ufw-appinfo command parser tested on linux
+- Fix deb package name to conform to standard
+- Add Caveats section to readme and manpage
+
 20210418 v1.15.2
 - Add systeminfo parser tested on Windows
 - Update dig parser to fix an issue with IPv6 addresses in the server field

CONTRIBUTING.md

@@ -15,11 +15,12 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 
 1. Open an issue to discuss the new feature, bug fix, or parser before opening a pull request. For new parsers, it is important to agree upon a schema before developing the parser.
 2. Fork the repo and create your branch from `dev`, if available, otherwise `master`.
-3. If you've added code that should be tested, add tests. All new parsers should have several sample outputs and tests.
-4. Documentation is auto-generated from docstrings, so ensure they are clear and accurate.
-5. Ensure the test suite passes.
-6. Make sure your code lints.
-7. Issue that pull request!
+3. For new parsers: 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) parsers as a template to get started. You can even place a new parser python module file in the [parser plugin directory](https://github.com/kellyjonbrazil/jc#custom-parsers) to get started right away with just a standard `jc` installation.
+4. If you've added code that should be tested, add tests. All new parsers should have several sample outputs and tests.
+5. Documentation is auto-generated from docstrings, so ensure they are clear and accurate.
+6. Ensure the test suite passes. (Note: "**America/Los_Angeles**" timezone should be configured on the test system)
+7. Make sure your code lints.
+8. Issue that pull request!
 
 ## Parser Schema Guidelines
 - Try to keep the schema as flat as possible - typically a list of flat dictionaries
@@ -31,36 +32,41 @@ This will make it easier to use tools like `jq` without requiring escaping of sp
 **Examples**
 
 Bad:
-```
+```json
 {
   "Interface 1": [
-    192.168.1.1,
-    172.16.1.1
+    "192.168.1.1",
+    "172.16.1.1"
   ],
   "Wifi Interface 1": [
-    10.1.1.1
+    "10.1.1.1"
   ]
 }
 ```
 Good:
-```
+```json
 [
   {
     "interface": "Interface 1",
     "ip_addresses": [
-      192.168.1.1,
-      172.16.1.1
+      "192.168.1.1",
+      "172.16.1.1"
     ]
   },
   {
     "interface": "Wifi Interface 1",
     "ip_addresses": [
-      10.1.1.1
+      "10.1.1.1"
     ]
   }
 ]
 ```
 
+## Tests
+It is essential to have good command output sample coverage and tests to keep the `jc` parser quality high.
+
+Many parsers include calculated timestamp fields using the `jc.utils.timestamp` class. Naive timestamps created with this class should be generated on a system configured with the "**America/Los_Angeles**" timezone on linux/macOS/unix and "**Pacific Standard Time**" timezone on Windows for tests to pass on the Github Actions CI tests. This timezone should be configured on your local system before running the tests locally, as well.
+
 ## Any contributions you make will be under the MIT Software License
 In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
 

EXAMPLES.md

@@ -732,7 +732,7 @@ dig -x 1.1.1.1 | jc --dig -p          # or:  jc -p dig -x 1.1.1.1
 ```
 ### dir
 ```bash
-dir | jc --dir -p          # or:  jc -p dir
+dir | jc --dir -p
 ```
 ```json
 [
@@ -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
@@ -1669,9 +1713,30 @@ iw dev wlan0 scan | jc --iw-scan -p          # or:  jc -p iw dev wlan0 scan
   }
 ]
 ```
+### jar-manifest
+```bash
+cat MANIFEST.MF | jc --jar-manifest -p
+```
+```json
+[
+  {
+    "Import_Package": "com.conversantmedia.util.concurrent;resolution:=optional,com.fasterxml.jackson.annotation;version=\"[2.12,3)\";resolution:=optional,com.fasterxml.jackson.core;version=\"[2.12,3)\";resolution:=optional,com.fasterxml.jackson.core.type;version=\"[2.12,3)\";resolution:=optional,com.fasterxml.jackson.cor...",
+    "Export_Package": "org.apache.logging.log4j.core;uses:=\"org.apache.logging.log4j,org.apache.logging.log4j.core.config,org.apache.logging.log4j.core.impl,org.apache.logging.log4j.core.layout,org.apache.logging.log4j.core.time,org.apache.logging.log4j.message,org.apache.logging.log4j.spi,org.apache.logging.log4j.status...",
+    "Manifest_Version": "1.0",
+    "Bundle_License": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+    "Bundle_SymbolicName": "org.apache.logging.log4j.core",
+    "Built_By": "matt",
+    "Bnd_LastModified": "1639373735804",
+    "Implementation_Vendor_Id": "org.apache.logging.log4j",
+    "Specification_Title": "Apache Log4j Core",
+    "Log4jReleaseManager": "Matt Sicker",
+    ...
+  }
+]
+```
 ### jobs
 ```bash
-jobs -l | jc --jobs -p          # or:  jc -p jobs
+jobs -l | jc --jobs -p
 ```
 ```json
 [
@@ -1917,6 +1982,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
@@ -2556,6 +2743,75 @@ rpm_qia | jc --rpm_qi -p          # or:  jc -p rpm -qia
   }
 ]
 ```
+### sfdisk
+```bash
+sfdisk -l | jc --sfdisk -p          # or jc -p sfdisk -l
+```
+```json
+[
+  {
+    "disk": "/dev/sda",
+    "cylinders": 2610,
+    "heads": 255,
+    "sectors_per_track": 63,
+    "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0",
+    "partitions": [
+      {
+        "device": "/dev/sda1",
+        "boot": true,
+        "start": 0,
+        "end": 130,
+        "cyls": 131,
+        "blocks": 1048576,
+        "id": "83",
+        "system": "Linux"
+      },
+      {
+        "device": "/dev/sda2",
+        "boot": false,
+        "start": 130,
+        "end": 2610,
+        "cyls": 2481,
+        "blocks": 19921920,
+        "id": "8e",
+        "system": "Linux LVM"
+      },
+      {
+        "device": "/dev/sda3",
+        "boot": false,
+        "start": 0,
+        "end": null,
+        "cyls": 0,
+        "blocks": 0,
+        "id": "0",
+        "system": "Empty"
+      },
+      {
+        "device": "/dev/sda4",
+        "boot": false,
+        "start": 0,
+        "end": null,
+        "cyls": 0,
+        "blocks": 0,
+        "id": "0",
+        "system": "Empty"
+      }
+    ]
+  },
+  {
+    "disk": "/dev/mapper/centos-root",
+    "cylinders": 2218,
+    "heads": 255,
+    "sectors_per_track": 63
+  },
+  {
+    "disk": "/dev/mapper/centos-swap",
+    "cylinders": 261,
+    "heads": 255,
+    "sectors_per_track": 63
+  }
+]
+```
 ### /etc/shadow file
 ```bash
 cat /etc/shadow | jc --shadow -p
@@ -3126,6 +3382,115 @@ traceroute -m 3 8.8.8.8 | jc --traceroute -p          # or:  jc -p traceroute -m
   ]
 }
 ```
+### ufw status
+```bash
+ufw status verbose  | jc --ufw -p          # or jc -p ufw status verbose
+```
+```json
+{
+  "status": "active",
+  "logging": "on",
+  "logging_level": "low",
+  "default": "deny (incoming), allow (outgoing), disabled (routed)",
+  "new_profiles": "skip",
+  "rules": [
+    {
+      "action": "ALLOW",
+      "action_direction": "IN",
+      "index": null,
+      "network_protocol": "ipv4",
+      "to_interface": "any",
+      "to_transport": "any",
+      "to_service": null,
+      "to_ports": [
+        22
+      ],
+      "to_ip": "0.0.0.0",
+      "to_ip_prefix": 0,
+      "comment": null,
+      "from_ip": "0.0.0.0",
+      "from_ip_prefix": 0,
+      "from_interface": "any",
+      "from_transport": "any",
+      "from_port_ranges": [
+        {
+          "start": 0,
+          "end": 65535
+        }
+      ],
+      "from_service": null
+    },
+    {
+      "action": "ALLOW",
+      "action_direction": "IN",
+      "index": null,
+      "network_protocol": "ipv4",
+      "to_interface": "any",
+      "to_transport": "tcp",
+      "to_service": null,
+      "to_ports": [
+        80,
+        443
+      ],
+      "to_ip": "0.0.0.0",
+      "to_ip_prefix": 0,
+      "comment": null,
+      "from_ip": "0.0.0.0",
+      "from_ip_prefix": 0,
+      "from_interface": "any",
+      "from_transport": "any",
+      "from_port_ranges": [
+        {
+          "start": 0,
+          "end": 65535
+        }
+      ],
+      "from_service": null
+    }
+  ]
+}
+```
+### ufw app info [application]
+```bash
+ufw app info MSN | jc --ufw-appinfo -p          # or:  jc -p ufw app info MSN
+```
+```json
+[
+  {
+    "profile": "MSN",
+    "title": "MSN Chat",
+    "description": "MSN chat protocol (with file transfer and voice)",
+    "tcp_list": [
+      1863,
+      6901
+    ],
+    "udp_list": [
+      1863,
+      6901
+    ],
+    "tcp_ranges": [
+      {
+        "start": 6891,
+        "end": 6900
+      }
+    ],
+    "normalized_tcp_list": [
+      1863,
+      6901
+    ],
+    "normalized_tcp_ranges": [
+      {
+        "start": 6891,
+        "end": 6900
+      }
+    ],
+    "normalized_udp_list": [
+      1863,
+      6901
+    ]
+  }
+]
+```
 ### uname -a
 ```bash
 uname -a | jc --uname -p          # or:  jc -p uname -a
@@ -3449,5 +3814,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

MANIFEST.in

@@ -1 +1,3 @@
 include jc/man/jc.1.gz
+include man/jc.1
+include CHANGELOG

README.md

@@ -1,9 +1,9 @@
 ![Tests](https://github.com/kellyjonbrazil/jc/workflows/Tests/badge.svg?branch=master)
 ![Pypi](https://img.shields.io/pypi/v/jc.svg)
 
-> Try the new `jc` [web demo](https://jc-web-demo.herokuapp.com/)!
+> 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
@@ -19,7 +19,7 @@ dig example.com | jc --dig
 39049,"data":"93.184.216.34"}],"query_time":49,"server":"2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)","when":
 "Fri Apr 16 16:09:00 PDT 2021","rcvd":56,"when_epoch":1618614540,"when_epoch_utc":null}]
 ```
-This allows further command-line processing of output with tools like `jq` by piping commands:
+This allows further command-line processing of output with tools like `jq` or [`jello`](https://github.com/kellyjonbrazil/jello) by piping commands:
 ```bash
 $ dig example.com | jc --dig | jq -r '.[].answer[].data'
 93.184.216.34
@@ -31,28 +31,13 @@ $ jc dig example.com | jq -r '.[].answer[].data'
 ```
 The `jc` parsers can also be used as python modules. In this case the output will be a python dictionary, or list of dictionaries, instead of JSON:
 ```python
->>> import jc.parsers.dig
->>> 
->>> data = '''; <<>> DiG 9.10.6 <<>> example.com
-... ;; global options: +cmd
-... ;; Got answer:
-... ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 64612
-... ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
-... 
-... ;; OPT PSEUDOSECTION:
-... ; EDNS: version: 0, flags:; udp: 4096
-... ;; QUESTION SECTION:
-... ;example.com.           IN  A
-... 
-... ;; ANSWER SECTION:
-... example.com.        29658   IN  A   93.184.216.34
-... 
-... ;; Query time: 52 msec
-... ;; SERVER: 2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)
-... ;; WHEN: Fri Apr 16 16:13:00 PDT 2021
-... ;; MSG SIZE  rcvd: 56'''
+>>> import subprocess
+>>> import jc
 >>>
->>> jc.parsers.dig.parse(data)
+>>> cmd_output = subprocess.check_output(['dig', 'example.com'], text=True)
+>>> data = jc.parse('dig', cmd_output)
+>>>
+>>> data
 [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', 'flags': ['qr', 'rd', 'ra'], 'query_num': 1, 'answer_num':
 1, 'authority_num': 0, 'additional_num': 1, 'opt_pseudosection': {'edns': {'version': 0, 'flags': [], 'udp':
 4096}}, 'question': {'name': 'example.com.', 'class': 'IN', 'type': 'A'}, 'answer': [{'name': 'example.com.',
@@ -60,28 +45,35 @@ The `jc` parsers can also be used as python modules. In this case the output wil
 '2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when': 'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56,
 'when_epoch': 1618614780, 'when_epoch_utc': None}]
 ```
-Two representations of the data are possible. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of `None` are converted to JSON `null`, known boolean values are converted, and, in some cases, additional semantic context fields are added.
 
-> Note: Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a `_utc` suffix it is considered naive. (i.e. based on the local timezone of the system the `jc` parser was run on). 
->
-> If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a `_utc` suffix on the key name. (e.g. `epoch_utc`) No other timezones are supported for aware timestamps.
+> For `jc` Python package documentation, use `help('jc')`, `help('jc.lib')`, or see the [online documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs).
+
+Two representations of the data are available. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of `None` are converted to JSON `null`, known boolean values are converted, and, in some cases, additional semantic context fields are added.
 
 To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`.
 
-Schemas for each parser can be found at the documentation link beside each parser below.
+Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below.
 
 Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/).
 
 ## Why Would Anyone Do This!?
-For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/).
+For more information on the motivations for this project, please see my blog post on [Bringing the Unix Philosophy to the 21st Century](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/).
 
 See also:
 - [libxo on FreeBSD](http://juniper.github.io/libxo/libxo-manual.html)
 - [powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7)
 - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag)
+- [Hacker News discussion](https://news.ycombinator.com/item?id=28266193)
+- [Reddit discussion](https://www.reddit.com/r/programming/comments/pa4cbb/bringing_the_unix_philosophy_to_the_21st_century/)
+
+Use Cases:
+- [Bash scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/)
+- [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/)
+- [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/)
+- [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/)
 
 ## Installation
-There are several ways to get `jc`. You can install via `pip`; other OS package repositories like `apt-get`, `dnf`, `zypper`, `pacman`, `nix-env`, `guix`, `brew`, or `portsnap`; via DEB/RPM packages; or by downloading the correct binary for your architecture and running it anywhere on your filesystem.
+There are several ways to get `jc`. You can install via `pip`, OS package repositories, via DEB/RPM/MSI packaged binaries for linux and Windows, or by downloading the correct binary for your architecture and running it anywhere on your filesystem.
 
 ### Pip (macOS, linux, unix, Windows)
 ```bash
@@ -98,11 +90,14 @@ pip3 install jc
 | Arch linux            | `pacman -S jc`                                                                |
 | NixOS linux           | `nix-env -iA nixpkgs.jc` or `nix-env -iA nixos.jc`                            |
 | Guix System linux     | `guix install jc`                                                             |
-| MacOS                 | `brew install jc`                                                             |
+| macOS                 | `brew install jc`                                                             |
 | FreeBSD               | `portsnap fetch update && cd /usr/ports/textproc/py-jc && make install clean` |
 | Ansible filter plugin | `ansible-galaxy collection install community.general`                         |
 
-> For more packages and binaries, see https://kellyjonbrazil.github.io/jc-packaging/.
+> For more OS Packages, see https://repology.org/project/jc/versions.
+
+### Binaries and Packages
+For precompiled binaries and packages, see [Releases](https://github.com/kellyjonbrazil/jc/releases) on Github.
 
 ## Usage
 `jc` accepts piped input from `STDIN` and outputs a JSON representation of the previous command's output to `STDOUT`.
@@ -115,8 +110,6 @@ jc [OPTIONS] COMMAND
 ```
 The JSON output can be compact (default) or pretty formatted with the `-p` option.
 
-> Note: For best results set the `LANG` locale environment variable to `C`. For example, either by setting directly on the command-line: `$ LANG=C date | jc --date`, or by exporting to the environment before running commands: `$ export LANG=C`.
-
 ### Parsers
 
 - `--acpi` enables the `acpi` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/acpi))
@@ -128,6 +121,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))
@@ -150,28 +144,36 @@ 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))
+- `--jar-manifest` enables the MANIFEST.MF file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/jar_manifest))
 - `--jobs` enables the `jobs` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs))
 - `--kv` enables the Key/Value file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/kv))
 - `--last` enables the `last` and `lastb` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/last))
 - `--ls` enables the `ls` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ls))
+- `--ls-s` enables the `ls` command streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ls_s))
 - `--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))
 - `--passwd` enables the `/etc/passwd` file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd))
 - `--ping` enables the `ping` and `ping6` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ping))
+- `--ping-s` enables the `ping` and `ping6` command streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s))
 - `--pip-list` enables the `pip list` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list))
 - `--pip-show` enables the `pip show` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_show))
 - `--ps` enables the `ps` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ps))
 - `--route` enables the `route` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/route))
 - `--rpm-qi` enables the `rpm -qi` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/rpm_qi))
+- `--sfdisk` enables the `sfdisk` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/sfdisk))
 - `--shadow` enables the `/etc/shadow` file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/shadow))
 - `--ss` enables the `ss` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ss))
 - `--stat` enables the `stat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/stat))
+- `--stat-s` enables the `stat` command streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/stat_s))
 - `--sysctl` enables the `sysctl` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/sysctl))
 - `--systemctl` enables the `systemctl` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl))
 - `--systemctl-lj` enables the `systemctl list-jobs` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_lj))
@@ -182,25 +184,45 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--timedatectl` enables the `timedatectl status` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/timedatectl))
 - `--tracepath` enables the `tracepath` and `tracepath6` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/tracepath))
 - `--traceroute` enables the `traceroute` and `traceroute6` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/traceroute))
+- `--ufw` enables the `ufw status` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw))
+- `--ufw-appinfo` enables the `ufw app info [application]` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw_appinfo))
 - `--uname` enables the `uname -a` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/uname))
 - `--upower` enables the `upower` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/upower))
 - `--uptime` enables the `uptime` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/uptime))
+- `--vmstat` enables the `vmstat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat))
+- `--vmstat-s` enables the `vmstat` command streaming parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat_s))
 - `--w` enables the `w` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/w))
 - `--wc` enables the `wc` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/wc))
 - `--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` `jc` help. Use `jc -h --parser_name` for parser documentation
+- `-h` help. Use `jc -h --parser_name` for parser documentation
 - `-m` monochrome JSON output
 - `-p` pretty format the JSON output
-- `-q` quiet mode. Suppresses parser warning messages
+- `-q` quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors)
 - `-r` raw output. Provides a more literal JSON output, typically with string values and no additional semantic processing
+- `-u` unbuffer output
 - `-v` version information
 
+### Exit Codes
+Any fatal errors within `jc` will generate an exit code of `100`, otherwise the exit code will be `0`. When using the "magic" syntax (e.g. `jc ifconfig eth0`), `jc` will store the exit code of the program being parsed and add it to the `jc` exit code. This way it is easier to determine if an error was from the parsed program or `jc`.
+
+Consider the following examples using `ifconfig`:
+
+| `ifconfig` exit code | `jc` exit code | Combined exit code | Interpretation                     | 
+|----------------------|----------------|--------------------|------------------------------------|
+| `0`                  | `0`            | `0`                | No errors                          |
+| `1`                  | `0`            | `1`                | Error in  `ifconfig`               |
+| `0`                  | `100`          | `100`              | Error in  `jc`                     |
+| `1`                  | `100`          | `101`              | Error in  both `ifconfig` and `jc` |
+
+
 ### Setting Custom Colors via Environment Variable
 You can specify custom colors via the `JC_COLORS` environment variable. The `JC_COLORS` environment variable takes four comma separated string values in the following format:
 ```bash
@@ -217,6 +239,67 @@ 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.
+
+> Note: Streaming parsers cannot be used with the "magic" syntax
+
+#### Ignoring Errors
+
+You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-qq` cli option or the `ignore_exceptions=True` argument with the `parse()` function. This will add a `_jc_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively:
+
+Successfully parsed line with `-qq` option:
+```json
+{
+  "command_data": "data",
+  "_jc_meta": {
+    "success": true
+  }
+}
+```
+Unsuccessfully parsed line with `-qq` option:
+```json
+{
+  "_jc_meta": {
+    "success": false,
+    "error": "error message",
+    "line": "original line data"
+  }
+}
+```
+
+#### Unbuffering Output
+
+Most operating systems will buffer output that is being piped from process to process. The buffer is usually around 4KB. When viewing the output in the terminal the OS buffer is not engaged so output is immediately displayed on the screen. When piping multiple processes together, though, it may seem as if the output is hanging when the input data is very slow (e.g. `ping`):
+```
+$ ping 1.1.1.1 | jc --ping-s | jq
+<slow output>
+```
+This is because the OS engages the 4KB buffer between `jc` and `jq` in this example. To display the data on the terminal in realtime, you can disable the buffer with the `-u` (unbuffer) cli option:
+```
+$ ping 1.1.1.1 | jc --ping-s -u | jq
+{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","response_ip":"1.1.1.1","icmp_seq":"1","ttl":"128","time_ms":"24.6","duplicate":false}
+{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","response_ip":"1.1.1.1","icmp_seq":"2","ttl":"128","time_ms":"26.8","duplicate":false}
+...
+```
+> Note: Unbuffered output can be slower for large data streams.
+
+#### Using Streaming Parsers as Python Modules
+
+Streaming parsers accept any iterable object and return a generator iterator object allowing lazy processing of the data. The input data should iterate on lines of string data. Examples of good input data are `sys.stdin` or `str.splitlines()`.
+
+To use the generator object in your code, simply loop through it or use the [next()](https://docs.python.org/3/library/functions.html#next) builtin function:
+```python
+import jc
+
+result = jc.parse('ls_s', ls_command_output.splitlines())
+for item in result:
+    print(item["filename"])
+```
+
 ### Custom Parsers
 Custom local parser plugins may be placed in a `jc/jcparsers` folder in your local **"App data directory"**:
 
@@ -224,20 +307,44 @@ 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 plugins.
+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.
 
 > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
 
+### Caveats
+
+#### Locale
+
+For best results set the `LANG` locale environment variable to `C` or `en_US.UTF-8`. For example, either by setting directly on the command-line:
+```
+$ LANG=C date | jc --date
+```
+or by exporting to the environment before running commands:
+```
+$ export LANG=C
+```
+
+#### Timezones
+
+Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a `_utc` suffix it is considered naive. (i.e. based on the local timezone of the system the `jc` parser was run on).
+
+If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a `_utc` suffix on the key name. (e.g. `epoch_utc`) No other timezones are supported for aware timestamps.
+
 ## Compatibility
-Some parsers like `ls`, `ps`, `dig`, etc. will work on any platform. Other parsers that are platform-specific will generate a warning message if they are used on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`.
+Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other parsers that convert platform-specific output will generate a warning message if they are run on an unsupported platform. To see all parser information, including compatibility, run `jc -ap`.
 
-You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an macOS laptop. In that case you can suppress the warning message with the `-q` cli option or the `quiet=True` function parameter in `parse()`:
+You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an macOS or Windows laptop. In that case you can suppress the warning message with the `-q` cli option or the `quiet=True` function parameter in `parse()`:
 
+macOS:
 ```bash
 cat lsof.out | jc --lsof -q
 ```
+or Windows:
+```bash
+type lsof.out | jc --lsof -q
+```
 
 Tested on:
 - Centos 7.7
@@ -249,9 +356,11 @@ Tested on:
 - NixOS
 - FreeBSD12
 - Windows 10
+- Windows 2016 Server
+- Windows 2019 Server
 
 ## Contributions
-Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request.
+Feel free to add/improve code or parsers! You can 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) parsers as a template and submit your parser with a pull request.
 
 Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information.
 
@@ -905,4 +1014,4 @@ cat istio.yaml | jc --yaml -p
 ]
 ```
 
-© 2019-2021 Kelly Brazil
+© 2019-2022 Kelly Brazil

docgen.sh

@@ -5,9 +5,16 @@
 cd jc
 echo Building docs for: package
 pydocmd simple jc+ > ../docs/readme.md
+
+echo Building docs for: lib
+pydocmd simple lib+ > ../docs/lib.md
+
 echo Building docs for: utils
 pydocmd simple utils+ > ../docs/utils.md
 
+echo Building docs for: universal parser
+pydocmd simple jc.parsers.universal+ > ../docs/parsers/universal.md
+
 # a bit of inception here... jc is being used to help
 # automate the generation of its own documentation. :)
 

docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-cayman

docs/lib.md

@@ -0,0 +1,90 @@
+
+# lib
+jc - JSON CLI output utility
+JC lib module
+
+
+## parse
+```python
+parse(parser_mod_name,
+      data,
+      quiet=False,
+      raw=False,
+      ignore_exceptions=None,
+      **kwargs)
+```
+
+Parse the string data using the supplied parser module.
+
+This function provides a high-level API to simplify parser use. This
+function will call built-in parsers and custom plugin parsers.
+
+Example:
+
+    >>> import jc
+    >>> jc.parse('date', 'Tue Jan 18 10:23:07 PST 2022')
+    {'year': 2022, 'month': 'Jan', 'month_num': 1, 'day'...}
+
+To get a list of available parser module names, use `parser_mod_list()`
+or `plugin_parser_mod_list()`. `plugin_parser_mod_list()` is a subset
+of `parser_mod_list()`.
+
+You can also use the lower-level parser modules directly:
+
+    >>> import jc.parsers.date
+    >>> jc.parsers.date.parse('Tue Jan 18 10:23:07 PST 2022')
+
+Though, accessing plugin parsers directly is a bit more cumbersome, so
+this higher-level API is recommended. Here is how you can access plugin
+parsers without this API:
+
+    >>> import os
+    >>> import sys
+    >>> import jc.appdirs
+    >>> data_dir = jc.appdirs.user_data_dir('jc', 'jc')
+    >>> local_parsers_dir = os.path.join(data_dir, 'jcparsers')
+    >>> sys.path.append(local_parsers_dir)
+    >>> import my_custom_parser
+    >>> my_custom_parser.parse('command_data')
+
+Parameters:
+
+    parser_mod_name:    (string)     name of the parser module
+
+    data:               (string or   data to parse (string for normal
+                        iterator)    parsers, iterator of strings for
+                                     streaming parsers)
+
+    raw:                (boolean)    output preprocessed JSON if True
+
+    quiet:              (boolean)    suppress warning messages if True
+
+    ignore_exceptions:  (boolean)    ignore parsing exceptions if True
+                                     (streaming parsers only)
+
+Returns:
+
+    Standard Parsers:   Dictionary or List of Dictionaries
+    Streaming Parsers:  Generator Object containing Dictionaries
+
+
+## parser_mod_list
+```python
+parser_mod_list()
+```
+Returns a list of all available parser module names.
+
+## plugin_parser_mod_list
+```python
+plugin_parser_mod_list()
+```
+
+Returns a list of plugin parser module names. This function is a
+subset of `parser_mod_list()`.
+
+
+## get_help
+```python
+get_help(parser_mod_name)
+```
+Show help screen for the selected parser.

docs/parsers/acpi.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('acpi', acpi_command_output)
+
+    or
+
     import jc.parsers.acpi
     result = jc.parsers.acpi.parse(acpi_command_output)
 
@@ -242,7 +247,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -252,4 +257,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('airport', airport_command_output)
+
+    or
+
     import jc.parsers.airport
     result = jc.parsers.airport.parse(airport_command_output)
 
@@ -95,7 +100,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -105,4 +110,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('airport_s', airport_s_command_output)
+
+    or
+
     import jc.parsers.airport_s
     result = jc.parsers.airport_s.parse(airport_s_command_output)
 
@@ -123,7 +128,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -133,4 +138,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('arp', arp_command_output)
+
+    or
+
     import jc.parsers.arp
     result = jc.parsers.arp.parse(arp_command_output)
 
@@ -132,7 +137,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -142,4 +147,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('blkid', blkid_command_output)
+
+    or
+
     import jc.parsers.blkid
     result = jc.parsers.blkid.parse(blkid_command_output)
 
@@ -135,7 +140,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -145,4 +150,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

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('cksum', cksum_command_output)
+
+    or
+
     import jc.parsers.cksum
     result = jc.parsers.cksum.parse(cksum_command_output)
 
@@ -69,7 +74,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -79,4 +84,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

@@ -1,7 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.crontab
-jc - JSON CLI output utility `crontab -l` command output and crontab file parser
+jc - JSON CLI output utility `crontab -l` command output and crontab
+file parser
 
 Supports `crontab -l` command output and crontab files.
 
@@ -15,6 +16,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('crontab', crontab_output)
+
+    or
+
     import jc.parsers.crontab
     result = jc.parsers.crontab.parse(crontab_output)
 
@@ -22,8 +28,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -185,7 +193,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -195,4 +203,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

@@ -1,9 +1,11 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.crontab_u
-jc - JSON CLI output utility `crontab -l` command output and crontab file parser
+jc - JSON CLI output utility `crontab -l` command output and crontab
+file parser
 
-This version of the `crontab -l` parser supports output that contains user information for processes.
+This version of the `crontab -l` parser supports output that contains user
+information for processes.
 
 Usage (cli):
 
@@ -11,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('crontab_u', crontab_u_output)
+
+    or
+
     import jc.parsers.crontab_u
     result = jc.parsers.crontab_u.parse(crontab_u_output)
 
@@ -18,8 +25,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -53,7 +62,7 @@ Examples:
       "variables": [
         {
           "name": "PATH",
-          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
+          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sb..."
         },
         {
           "name": "SHELL",
@@ -78,7 +87,7 @@ Examples:
             "*"
           ],
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         },
         {
           "minute": [
@@ -97,7 +106,7 @@ Examples:
             "7"
           ],
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         },
         {
           "minute": [
@@ -116,7 +125,7 @@ Examples:
             "*"
           ],
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         }
       ]
     }
@@ -126,7 +135,7 @@ Examples:
       "variables": [
         {
           "name": "PATH",
-          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
+          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/..."
         },
         {
           "name": "SHELL",
@@ -141,7 +150,7 @@ Examples:
           "month": "*",
           "day_of_week": "*",
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         },
         {
           "minute": "47",
@@ -150,7 +159,7 @@ Examples:
           "month": "*",
           "day_of_week": "7",
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         },
         {
           "minute": "52",
@@ -159,7 +168,7 @@ Examples:
           "month": "*",
           "day_of_week": "*",
           "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )"
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
         }
       ]
     }
@@ -181,7 +190,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -191,4 +200,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

@@ -3,7 +3,9 @@
 # jc.parsers.csv
 jc - JSON CLI output utility `csv` file parser
 
-The `csv` 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.
+The `csv` 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.
 
 Usage (cli):
 
@@ -11,12 +13,18 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('csv', csv_output)
+
+    or
+
     import jc.parsers.csv
     result = jc.parsers.csv.parse(csv_output)
 
 Schema:
 
-    csv file converted to a Dictionary: https://docs.python.org/3/library/csv.html
+    csv file converted to a Dictionary:
+    https://docs.python.org/3/library/csv.html
 
     [
       {
@@ -28,7 +36,7 @@ Schema:
 Examples:
 
     $ cat homes.csv
-    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres", "Taxes"
+    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres"...
     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
@@ -89,7 +97,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -99,4 +107,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv_s.md

@@ -0,0 +1,103 @@
+[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
+    # result is an iterable object (generator)
+    result = jc.parse('csv_s', csv_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.csv_s
+    # result is an iterable object (generator)
+    result = jc.parsers.csv_s.parse(csv_output.splitlines())
+    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,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":      boolean,     # false if error parsing
+          "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"...
+    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"...}
+    {"Sell":"175","List":"180","Living":"18","Rooms":"8","Beds":"4"...}
+    {"Sell":"129","List":"132","Living":"13","Rooms":"6","Beds":"3"...}
+    ...
+
+
+## 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)   unprocessed output 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.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/date.md

@@ -3,9 +3,11 @@
 # jc.parsers.date
 jc - JSON CLI output utility `date` command output parser
 
-The `epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on)
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
-The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC.
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -17,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('date', date_command_output)
+
+    or
+
     import jc.parsers.date
     result = jc.parsers.date.parse(date_command_output)
 
@@ -35,15 +42,19 @@ Schema:
       "second":             integer,
       "period":             string,
       "timezone":           string,
-      "utc_offset":         string,       # null if timezone field is not UTC
+      "utc_offset":         string,      # null if timezone field is not UTC
       "day_of_year":        integer,
       "week_of_year":       integer,
       "iso":                string,
-      "epoch":              integer,      # naive timestamp
-      "epoch_utc":          integer,      # timezone-aware timestamp. Only available if timezone field is UTC
-      "timezone_aware":     boolean       # if true, all fields are correctly based on UTC
+      "epoch":              integer,     # [0]
+      "epoch_utc":          integer,     # [1]
+      "timezone_aware":     boolean      # [2]
     }
 
+    [0] naive timestamp
+    [1] timezone-aware timestamp. Only available if timezone field is UTC
+    [2] if true, all fields are correctly based on UTC
+
 Examples:
 
     $ date | jc --date -p
@@ -86,7 +97,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -96,4 +107,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('df', df_command_output)
+
+    or
+
     import jc.parsers.df
     result = jc.parsers.df.parse(df_command_output)
 
@@ -112,7 +117,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -122,4 +127,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

@@ -3,9 +3,16 @@
 # jc.parsers.dig
 jc - JSON CLI output utility `dig` command output parser
 
-The `when_epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
+Options supported:
+- `+noall +answer` options are supported in cases where only the answer
+  information is desired.
+- `+axfr` option is supported on its own
 
-The `when_epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC.
+The `when_epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
+
+The `when_epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -17,6 +24,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('dig', dig_command_output)
+
+    or
+
     import jc.parsers.dig
     result = jc.parsers.dig.parse(dig_command_output)
 
@@ -89,13 +101,16 @@ Schema:
         "query_time":           integer,   # in msec
         "server":               string,
         "when":                 string,
-        "when_epoch":           integer,   # naive timestamp if when field is parsable, else null
-        "when_epoch_utc":       integer,   # timezone aware timestamp availabe for UTC, else null
+        "when_epoch":           integer,   # [0]
+        "when_epoch_utc":       integer,   # [1]
         "rcvd":                 integer
         "size":                 string
       }
     ]
 
+    [0] naive timestamp if "when" field is parsable, else null
+    [1] timezone aware timestamp availabe for UTC, else null
+
 Examples:
 
     $ dig example.com | jc --dig -p
@@ -274,6 +289,42 @@ Examples:
       }
     ]
 
+    $ dig +noall +answer cnn.com | jc --dig -p
+    [
+      {
+        "answer": [
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.193.67"
+          },
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.65.67"
+          },
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.1.67"
+          },
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.129.67"
+          }
+        ]
+      }
+    ]
+
 
 ## info
 ```python
@@ -291,7 +342,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -299,6 +350,6 @@ Returns:
     List of Dictionaries. Raw or processed structured data.
 
 ## Parser Information
-Compatibility:  linux, aix, freebsd, darwin
+Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
 
-Version 2.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dir.md

@@ -9,18 +9,23 @@ Options supported:
 - `/C, /-C`
 - `/S`
 
-The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
+The "Magic" syntax is not supported since the `dir` command is a shell
+builtin.
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
 Usage (cli):
 
     C:> dir | jc --dir
 
-    or
-
-    C:> jc dir
-
 Usage (module):
 
+    import jc
+    result = jc.parse('dir', dir_command_output)
+
+    or
+
     import jc.parsers.dir
     result = jc.parsers.dir.parse(dir_command_output)
 
@@ -135,7 +140,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -145,4 +150,4 @@ Returns:
 ## Parser Information
 Compatibility:  win32
 
-Version 1.2 by Rasheed Elsaleh (rasheed@rebelliondefense.com)
+Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

docs/parsers/dmidecode.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('dmidecode', dmidecode_command_output)
+
+    or
+
     import jc.parsers.dmidecode
     result = jc.parsers.dmidecode.parse(dmidecode_command_output)
 
@@ -24,7 +29,7 @@ Schema:
         "type":                        integer,
         "bytes":                       integer,
         "description":                 string,
-        "values": {                               (null if empty)
+        "values": {                                 # null if empty
           "lowercase_no_spaces_keys":  string,
           "multiline_key_values": [
                                        string,
@@ -140,7 +145,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -150,4 +155,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

@@ -3,7 +3,8 @@
 # jc.parsers.dpkg_l
 jc - JSON CLI output utility `dpkg -l` command output parser
 
-Set the `COLUMNS` environment variable to a large value to avoid field truncation. For example:
+Set the `COLUMNS` environment variable to a large value to avoid field
+truncation. For example:
 
     $ COLUMNS=500 dpkg -l | jc --dpkg-l
 
@@ -17,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('dpkg_l', dpkg_command_output)
+
+    or
+
     import jc.parsers.dpkg_l
     result = jc.parsers.dpkg_l.parse(dpkg_command_output)
 
@@ -72,7 +78,7 @@ Examples:
         "name": "acpid",
         "version": "1:2.0.28-1ubuntu1",
         "architecture": "amd64",
-        "description": "Advanced Configuration and Power Interface event daemon",
+        "description": "Advanced Configuration and Power Interface...",
         "desired": "remove",
         "status": "half installed"
       },
@@ -116,7 +122,7 @@ Examples:
         "name": "acpid",
         "version": "1:2.0.28-1ubuntu1",
         "architecture": "amd64",
-        "description": "Advanced Configuration and Power Interface event daemon"
+        "description": "Advanced Configuration and Power Interface..."
       },
       {
         "codes": "pn",
@@ -145,7 +151,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -155,4 +161,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('du', du_command_output)
+
+    or
+
     import jc.parsers.du
     result = jc.parsers.du.parse(du_command_output)
 
@@ -35,23 +40,23 @@ Examples:
       },
       {
         "size": 56,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/_CodeSignature"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local/standalone"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 1008,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/dfu"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       ...
     ]
@@ -64,23 +69,23 @@ Examples:
       },
       {
         "size": "56",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/_CodeSignature"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local/standalone"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "1008",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/dfu"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       ...
     ]
@@ -102,7 +107,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -112,4 +117,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

@@ -3,7 +3,10 @@
 # jc.parsers.env
 jc - JSON CLI output utility `env` and `printenv` command output parser
 
-This parser will output a list of dictionaries each containing `name` and `value` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function.
+This parser will output a list of dictionaries each containing `name` and
+`value` keys. If you would like a simple dictionary output, then use the
+`-r` command-line option or the `raw=True` argument in the `parse()`
+function.
 
 Usage (cli):
 
@@ -15,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('env', env_command_output)
+
+    or
+
     import jc.parsers.env
     result = jc.parsers.env.parse(env_command_output)
 
@@ -84,7 +92,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -95,4 +103,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('file', file_command_output)
+
+    or
+
     import jc.parsers.file
     result = jc.parsers.file.parse(file_command_output)
 
@@ -21,7 +26,7 @@ Schema:
     [
       {
         "filename":   string,
-        "type   ":    string
+        "type":       string
       }
     ]
 
@@ -51,11 +56,11 @@ Examples:
       },
       {
         "filename": "cd_catalog.xml",
-        "type": "XML 1.0 document text, ASCII text, with CRLF line terminators"
+        "type": "XML 1.0 document text, ASCII text, with CRLF line ..."
       },
       {
         "filename": "centosserial.sh",
-        "type": "Bourne-Again shell script text executable, UTF-8 Unicode text"
+        "type": "Bourne-Again shell script text executable, UTF-8 ..."
       },
       ...
     ]
@@ -77,7 +82,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -87,4 +92,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('finger', finger_command_output)
+
+    or
+
     import jc.parsers.finger
     result = jc.parsers.finger.parse(finger_command_output)
 
@@ -105,7 +110,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -115,4 +120,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('free', free_command_output)
+
+    or
+
     import jc.parsers.free
     result = jc.parsers.free.parse(free_command_output)
 
@@ -87,7 +92,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -97,4 +102,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('fstab', fstab_command_output)
+
+    or
+
     import jc.parsers.fstab
     result = jc.parsers.fstab.parse(fstab_command_output)
 
@@ -100,7 +105,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -110,4 +115,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('group', group_file_output)
+
+    or
+
     import jc.parsers.group
     result = jc.parsers.group.parse(group_file_output)
 
@@ -124,7 +129,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -134,4 +139,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('gshadow', gshadow_file_output)
+
+    or
+
     import jc.parsers.gshadow
     result = jc.parsers.gshadow.parse(gshadow_file_output)
 
@@ -92,7 +97,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -102,4 +107,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hash', hash_command_output)
+
+    or
+
     import jc.parsers.hash
     result = jc.parsers.hash.parse(hash_command_output)
 
@@ -52,7 +57,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -62,4 +67,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

@@ -23,6 +23,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hashsum', md5sum_command_output)
+
+    or
+
     import jc.parsers.hashsum
     result = jc.parsers.hashsum.parse(md5sum_command_output)
 
@@ -83,7 +88,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -93,4 +98,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hciconfig', hciconfig_command_output)
+
+    or
+
     import jc.parsers.hciconfig
     result = jc.parsers.hciconfig.parse(hciconfig_command_output)
 
@@ -332,7 +337,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -342,4 +347,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

@@ -3,7 +3,13 @@
 # jc.parsers.history
 jc - JSON CLI output utility `history` command output parser
 
-This parser will output a list of dictionaries each containing `line` and `command` keys. If you would like a simple dictionary output, then use the `-r` command-line option or the `raw=True` argument in the `parse()` function.
+This parser will output a list of dictionaries each containing `line` and
+`command` keys. If you would like a simple dictionary output, then use the
+`-r` command-line option or the `raw=True` argument in the `parse()`
+function.
+
+The "Magic" syntax is not supported since the `history` command is a shell
+builtin.
 
 Usage (cli):
 
@@ -11,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('history', history_command_output)
+
+    or
+
     import jc.parsers.history
     result = jc.parsers.history.parse(history_command_output)
 
@@ -72,7 +83,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -83,4 +94,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hosts', hosts_file_output)
+
+    or
+
     import jc.parsers.hosts
     result = jc.parsers.hosts.parse(hosts_file_output)
 
@@ -89,7 +94,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -99,4 +104,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('id', id_command_output)
+
+    or
+
     import jc.parsers.id
     result = jc.parsers.id.parse(id_command_output)
 
@@ -120,7 +125,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -130,4 +135,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ifconfig', ifconfig_command_output)
+
+    or
+
     import jc.parsers.ifconfig
     result = jc.parsers.ifconfig.parse(ifconfig_command_output)
 
@@ -201,7 +206,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -211,4 +216,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

@@ -3,9 +3,13 @@
 # jc.parsers.ini
 jc - JSON CLI output utility `INI` file parser
 
-Parses standard `INI` files and files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix can be `#` or `;`. Comments must be on their own line.
+Parses standard `INI` files and files containing simple key/value pairs.
+Delimiter can be `=` or `:`. Missing values are supported. Comment prefix
+can be `#` or `;`. Comments must be on their own line.
 
-Note: Values starting and ending with quotation marks will have the marks removed. If you would like to keep the quotation marks, use the `-r` command-line argument or the `raw=True` argument in `parse()`.
+Note: Values starting and ending with quotation marks will have the marks
+removed. If you would like to keep the quotation marks, use the `-r`
+command-line argument or the `raw=True` argument in `parse()`.
 
 Usage (cli):
 
@@ -13,16 +17,18 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ini', ini_file_output)
+
+    or
+
     import jc.parsers.ini
     result = jc.parsers.ini.parse(ini_file_output)
 
 Schema:
 
-    ini or key/value document converted to a dictionary - see configparser standard
-          library documentation for more details.
-
-    Note: Values starting and ending with quotation marks will have the marks removed.
-          If you would like to keep the quotation marks, use the -r or raw=True argument.
+    ini or key/value document converted to a dictionary - see the
+    configparser standard library documentation for more details.
 
     {
       "key1":       string,
@@ -80,7 +86,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -90,4 +96,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,192 @@
+[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
+    result = jc.parse('iostat', iostat_command_output)
+
+    or
+
+    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) unprocessed output 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,140 @@
+[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
+    # result is an iterable object (generator)
+    result = jc.parse('iostat_s', iostat_command_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.iostat_s
+    # result is an iterable object (generator)
+    result = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())
+    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,
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":      boolean,     # false if error parsing
+          "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,...}
+    {"device":"sda","tps":0.24,"kb_read_s":5.28,"kb_wrtn_s":1.1...}
+    ...
+
+    $ iostat | jc --iostat-s -r
+    {"percent_user":"0.14","percent_nice":"0.00","percent_system":"0.16"...}
+    {"device":"sda","tps":"0.24","kb_read_s":"5.28","kb_wrtn_s":"1.10"...}
+    ...
+
+
+## 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)   unprocessed output 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

@@ -1,7 +1,7 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.iptables
-jc - JSON CLI output utility `ipables` command output parser
+jc - JSON CLI output utility `iptables` command output parser
 
 Supports `-vLn` and `--line-numbers` for all tables.
 
@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iptables', iptables_command_output)
+
+    or
+
     import jc.parsers.iptables
     result = jc.parsers.iptables.parse(iptables_command_output)
 
@@ -178,7 +183,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -188,4 +193,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

@@ -3,7 +3,8 @@
 # jc.parsers.iw_scan
 jc - JSON CLI output utility `iw dev <device> scan` command output parser
 
-This parser is considered beta quality. Not all fields are parsed and there are not enough samples to test.
+This parser is considered beta quality. Not all fields are parsed and there
+are not enough samples to test.
 
 Usage (cli):
 
@@ -15,14 +16,19 @@ Usage (cli):
 
 Usage (module):
 
-    import jc.parsers.iw-scan
-    result = jc.parsers.iw-scan.parse(iw-scan_command_output)
+    import jc
+    result = jc.parse('iw_scan', iw_scan_command_output)
+
+    or
+
+    import jc.parsers.iw_scan
+    result = jc.parsers.iw_scan.parse(iw_scan_command_output)
 
 Schema:
 
     [
       {
-        "foo":     string/integer/float,         # best guess based on value
+        "foo":     string/integer/float,      # best guess based on value
         "bar":     string/integer/float,
         "baz":     string/integer/float
       }
@@ -135,7 +141,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -145,4 +151,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/jar_manifest.md

@@ -0,0 +1,110 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.jar_manifest
+jc - JSON CLI output utility `MANIFEST.MF` file parser
+
+Usage (cli):
+
+    $ cat MANIFEST.MF | jc --jar-manifest
+
+Usage (module):
+
+    import jc
+    result = jc.parse('jar_manifest', jar_manifest_file_output)
+
+    or
+
+    import jc.parsers.jar_manifest
+    result = jc.parsers.jar_manifest.parse(jar_manifest_file_output)
+
+Schema:
+
+    [
+      {
+        "key1":     string,
+        "key2":     string
+      }
+    ]
+
+Examples:
+
+    $ cat MANIFEST.MF | jc --jar-manifest -p
+    $ unzip -c log4j-core-2.16.0.jar META-INF/MANIFEST.MF | \
+      jc --jar-manifest -p
+    $ unzip -c 'apache-log4j-2.16.0-bin/*.jar' META-INF/MANIFEST.MF | \
+      jc --jar-manifest -p
+
+    $ cat MANIFEST.MF | jc --jar-manifest -p
+    [
+      {
+        "Import_Package": "com.conversantmedia.util.concurrent;resoluti...",
+        "Export_Package": "org.apache.logging.log4j.core;uses:="org.ap...",
+        "Manifest_Version": "1.0",
+        "Bundle_License": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+        "Bundle_SymbolicName": "org.apache.logging.log4j.core",
+        "Built_By": "matt",
+        "Bnd_LastModified": "1639373735804",
+        "Implementation_Vendor_Id": "org.apache.logging.log4j",
+        "Specification_Title": "Apache Log4j Core",
+        "Log4jReleaseManager": "Matt Sicker",
+        ...
+      }
+    ]
+
+    $ unzip -c 'apache-log4j-2.16.0-bin/*.jar' META-INF/MANIFEST.MF | \
+      jc --jar-manifest -p
+    [
+      ...
+      {
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-boot-2.16.0-so...",
+        "Manifest_Version": "1.0",
+        "Built_By": "matt",
+        "Created_By": "Apache Maven 3.8.4",
+        "Build_Jdk": "1.8.0_312"
+      },
+      {
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-boot-2.16.0-ja...",
+        "Manifest_Version": "1.0",
+        "Built_By": "matt",
+        "Created_By": "Apache Maven 3.8.4",
+        "Build_Jdk": "1.8.0_312"
+      },
+      {
+        "Bundle_SymbolicName": "org.apache.logging.log4j.spring-cloud-c...",
+        "Export_Package": "org.apache.logging.log4j.spring.cloud.config...",
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-cloud-config-c...",
+        "Manifest_Version": "1.0",
+        "Bundle_License": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+        ...
+      }
+      ...
+    ]
+
+
+## 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) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+## Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 0.01 by Matt J (https://github.com/listuser)

docs/parsers/jobs.md

@@ -5,16 +5,20 @@ jc - JSON CLI output utility `jobs` command output parser
 
 Also supports the `-l` option.
 
+The "Magic" syntax is not supported since the `jobs` command is a shell
+builtin.
+
 Usage (cli):
 
     $ jobs | jc --jobs
 
-    or
-
-    $ jc jobs
-
 Usage (module):
 
+    import jc
+    result = jc.parse('jobs', jobs_command_output)
+
+    or
+
     import jc.parsers.jobs
     result = jc.parsers.jobs.parse(jobs_command_output)
 
@@ -109,7 +113,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -119,4 +123,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/kv.md

@@ -3,9 +3,13 @@
 # jc.parsers.kv
 jc - JSON CLI output utility `Key/Value` file parser
 
-Supports files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix can be `#` or `;`. Comments must be on their own line.
+Supports files containing simple key/value pairs. Delimiter can be `=` or
+`:`. Missing values are supported. Comment prefix can be `#` or `;`.
+Comments must be on their own line.
 
-Note: Values starting and ending with quotation marks will have the marks removed. If you would like to keep the quotation marks, use the `-r` command-line argument or the `raw=True` argument in `parse()`.
+Note: Values starting and ending with quotation marks will have the marks
+removed. If you would like to keep the quotation marks, use the `-r`
+command-line argument or the `raw=True` argument in `parse()`.
 
 Usage (cli):
 
@@ -13,12 +17,18 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('kv', kv_file_output)
+
+    or
+
     import jc.parsers.kv
     result = jc.parsers.kv.parse(kv_file_output)
 
 Schema:
 
-    key/value document converted to a dictionary - see configparser standard library documentation for more details.
+    key/value document converted to a dictionary - see the
+    configparser standard library documentation for more details.
 
     {
       "key1":       string,
@@ -38,7 +48,7 @@ Examples:
     # but can be preserved with the -r argument
     occupation:"Engineer"
 
-    $ cat keyvalue.txt | jc --ini -p
+    $ cat keyvalue.txt | jc --kv -p
     {
       "name": "John Doe",
       "address": "555 California Drive",
@@ -65,7 +75,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:

docs/parsers/last.md

@@ -5,7 +5,9 @@ jc - JSON CLI output utility `last` and `lastb` command output parser
 
 Supports `-w` and `-F` options.
 
-Calculated epoch time fields are naive (i.e. based on the local time of the system the parser is run on) since there is no timezone information in the `last` command output.
+Calculated epoch time fields are naive (i.e. based on the local time of the
+system the parser is run on) since there is no timezone information in the
+`last` command output.
 
 Usage (cli):
 
@@ -17,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('last', last_command_output)
+
+    or
+
     import jc.parsers.last
     result = jc.parsers.last.parse(last_command_output)
 
@@ -30,9 +37,9 @@ Schema:
         "login":            string,
         "logout":           string,
         "duration":         string,
-        "login_epoch":      integer,   # (naive) available with last -F option
-        "logout_epoch":     integer,   # (naive) available with last -F option
-        "duration_seconds": integer    # available with last -F option
+        "login_epoch":      integer,  # (naive) available w/last -F option
+        "logout_epoch":     integer,  # (naive) available w/last -F option
+        "duration_seconds": integer   # available w/last -F option
       }
     ]
 
@@ -118,7 +125,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -128,4 +135,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

@@ -7,11 +7,17 @@ Options supported:
 - `lbaR1`
 - `--time-style=full-iso`
 
-Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly parse filenames that include newline characters. Since `ls` does not encode newlines in filenames when outputting to a pipe it will cause `jc` to see multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. Alternatively, `vdir` can be used, which is the same as running `ls -lb`.
+Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly
+parse filenames that include newline characters. Since `ls` does not encode
+newlines in filenames when outputting to a pipe it will cause `jc` to see
+multiple files instead of a single file if `-1`, `-l`, or `-b` is not used.
+Alternatively, `vdir` can be used, which is the same as running `ls -lb`.
 
-The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
-The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC.
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -23,6 +29,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ls', ls_command_output)
+
+    or
+
     import jc.parsers.ls
     result = jc.parsers.ls.parse(ls_command_output)
 
@@ -38,11 +49,15 @@ Schema:
         "group":        string,
         "size":         integer,
         "date":         string,
-        "epoch":        integer,     # naive timestamp if date field exists and can be converted
-        "epoch_utc":    integer      # timezone aware timestamp if date field is in UTC and can be converted
+        "epoch":        integer,     # [0]
+        "epoch_utc":    integer      # [1]
       }
     ]
 
+    [0] naive timestamp if date field exists and can be converted.
+    [1] timezone aware timestamp if date field is in UTC and can
+        be converted.
+
 Examples:
 
     $ ls /usr/bin | jc --ls -p
@@ -121,7 +136,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -131,4 +146,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

@@ -0,0 +1,117 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.ls_s
+jc - JSON CLI output utility `ls` and `vdir` command output streaming
+parser
+
+> This streaming parser outputs JSON Lines
+
+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)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ ls | jc --ls-s
+
+Usage (module):
+
+    import jc
+    # result is an iterable object (generator)
+    result = jc.parse('ls_s', ls_command_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.ls_s
+    # result is an iterable object (generator)
+    result = jc.parsers.ls_s.parse(ls_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "filename":       string,
+      "flags":          string,
+      "links":          integer,
+      "parent":         string,
+      "owner":          string,
+      "group":          string,
+      "size":           integer,
+      "date":           string,
+      "epoch":          integer,     # [0]
+      "epoch_utc":      integer,     # [1]
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":    boolean,     # false if error parsing
+          "error":      string,      # exists if "success" is false
+          "line":       string       # exists if "success" is false
+        }
+    }
+
+    [0] naive timestamp if date field exists and can be converted.
+    [1] timezone aware timestamp if date field is in UTC and can
+        be converted
+
+Examples:
+
+    $ ls -l /usr/bin | jc --ls-s
+    {"filename":"2to3-","flags":"-rwxr-xr-x","links":4,"owner":"root","...}
+    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/P...}
+    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":1,...}
+    ...
+
+    $ ls -l /usr/bin | jc --ls-s -r
+    {"filename":"2to3-","flags":"-rwxr-xr-x","links":"4","owner":"roo"..."}
+    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/P...}
+    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":"1...}
+    ...
+
+
+## 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)   unprocessed output 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, aix, freebsd
+
+Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsblk.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsblk', lsblk_command_output)
+
+    or
+
     import jc.parsers.lsblk
     result = jc.parsers.lsblk.parse(lsblk_command_output)
 
@@ -88,7 +93,10 @@ Examples:
       ...
     ]
 
-    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p
+    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,\
+      STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,\
+      SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,\
+      PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p
     [
       {
         "name": "sda",
@@ -177,7 +185,10 @@ Examples:
       ...
     ]
 
-    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p -r
+    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,\
+      STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,\
+      SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,\
+      PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p -r
     [
       {
         "name": "sda",
@@ -283,7 +294,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -293,4 +304,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsmod', lsmod_command_output)
+
+    or
+
     import jc.parsers.lsmod
     result = jc.parsers.lsmod.parse(lsmod_command_output)
 
@@ -140,7 +145,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -150,4 +155,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsof', lsof_command_output)
+
+    or
+
     import jc.parsers.lsof
     result = jc.parsers.lsof.parse(lsof_command_output)
 
@@ -134,7 +139,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -144,4 +149,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,294 @@
+[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
+    result = jc.parse('lsusb', lsusb_command_output)
+
+    or
+
+    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) unprocessed output 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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('mount', mount_command_output)
+
+    or
+
     import jc.parsers.mount
     result = jc.parsers.mount.parse(mount_command_output)
 
@@ -90,7 +95,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -100,4 +105,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

@@ -5,7 +5,8 @@ jc - JSON CLI output utility `netstat` command output parser
 
 Caveats:
 - Use of multiple `l` options is not supported on OSX (e.g. `netstat -rlll`)
-- Use of the `A` option is not supported on OSX when using the `r` option (e.g. `netstat -rA`)
+- Use of the `A` option is not supported on OSX when using the `r` option
+  (e.g. `netstat -rA`)
 
 Usage (cli):
 
@@ -17,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('netstat', netstat_command_output)
+
+    or
+
     import jc.parsers.netstat
     result = jc.parsers.netstat.parse(netstat_command_output)
 
@@ -369,7 +375,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -379,4 +385,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ntpq', ntpq_command_output)
+
+    or
+
     import jc.parsers.ntpq
     result = jc.parsers.ntpq.parse(ntpq_command_output)
 
@@ -221,7 +226,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -231,4 +236,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('passwd', passwd_file_output)
+
+    or
+
     import jc.parsers.passwd
     result = jc.parsers.passwd.parse(passwd_file_output)
 
@@ -109,7 +114,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -119,4 +124,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

@@ -7,7 +7,8 @@ Supports `ping` and `ping6` output.
 
 Usage (cli):
 
-    Note:  Use the ping `-c` (count) option, otherwise data will not be piped to `jc`.
+    Note:  Use the ping `-c` (count) option, otherwise data will not be
+           piped to `jc`.
 
     $ ping -c 3 1.2.3.4 | jc --ping
 
@@ -17,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ping', ping_command_output)
+
+    or
+
     import jc.parsers.ping
     result = jc.parsers.ping.parse(ping_command_output)
 
@@ -26,7 +32,7 @@ Schema:
       "source_ip":                   string,
       "destination_ip":              string,
       "data_bytes":                  integer,
-      "pattern":                     string,        # (null if not set)
+      "pattern":                     string,        # null if not set
       "destination":                 string,
       "packets_transmitted":         integer,
       "packets_received":            integer,
@@ -38,18 +44,35 @@ Schema:
       "round_trip_ms_stddev":        float,
       "responses": [
         {
-          "type":                    string,        # ('reply' or 'timeout')
+          "type":                    string,        # [0]
+          "unparsed_line":           string,        # [1]
           "timestamp":               float,
           "bytes":                   integer,
           "response_ip":             string,
           "icmp_seq":                integer,
           "ttl":                     integer,
           "time_ms":                 float,
-          "duplicate":               boolean
+          "duplicate":               boolean,
+          "vr":                      integer,       # [2]
+          "hl":                      integer,       # [2]
+          "tos":                     integer,       # [2]
+          "len":                     integer,       # [2]
+          "id":                      integer,       # [2]
+          "flg":                     integer,       # [2]
+          "off":                     integer,       # [2]
+          "pro":                     integer,       # [2]
+          "cks":                     ingeger,       # [2]
+          "src":                     string,
+          "dst":                     string
         }
       ]
     }
 
+    [0] 'reply', 'timeout', 'unparsable_line', etc. See
+        `_error_type.type_map` for all options
+    [1] only if an 'unparsable_line' type
+    [2] hex value converted to decimal
+
 Examples:
 
     $ ping -c 3 -p ff cnn.com | jc --ping -p
@@ -97,7 +120,6 @@ Examples:
       ]
     }
 
-
     $ ping -c 3 -p ff cnn.com | jc --ping -p -r
     {
       "destination_ip": "151.101.129.67",
@@ -160,7 +182,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -170,4 +192,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping_s.md

@@ -0,0 +1,123 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# 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/master#unbuffering-output)
+  for more information.
+
+Usage (module):
+
+    import jc
+    # result is an iterable object (generator)
+    result = jc.parse('ping_s', ping_command_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.ping_s
+    # result is an iterable object (generator)
+    result = jc.parsers.ping_s.parse(ping_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "type":                       string,   # [0]
+      "source_ip":                  string,
+      "destination_ip":             string,
+      "sent_bytes":                 integer,
+      "pattern":                    string,   # (null if not set)
+      "destination":                string,
+      "timestamp":                  float,
+      "response_bytes":             integer,
+      "response_ip":                string,
+      "icmp_seq":                   integer,
+      "ttl":                        integer,
+      "time_ms":                    float,
+      "duplicate":                  boolean,
+      "packets_transmitted":        integer,
+      "packets_received":           integer,
+      "packet_loss_percent":        float,
+      "duplicates":                 integer,
+      "round_trip_ms_min":          float,
+      "round_trip_ms_avg":          float,
+      "round_trip_ms_max":          float,
+      "round_trip_ms_stddev":       float,
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":                boolean,  # false if error parsing
+          "error":                  string,   # exists if "success" is false
+          "line":                   string    # exists if "success" is false
+        }
+    }
+
+    [0] 'reply', 'timeout', 'summary', etc. See `_error_type.type_map`
+        for all options.
+
+Examples:
+
+    $ ping 1.1.1.1 | jc --ping-s
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    ...
+
+    $ ping 1.1.1.1 | jc --ping-s -r
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    ...
+
+
+## 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)   unprocessed output 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, freebsd
+
+Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_list.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('pip_list', pip_list_command_output)
+
+    or
+
     import jc.parsers.pip_list
     result = jc.parsers.pip_list.parse(pip_list_command_output)
 
@@ -62,7 +67,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -72,4 +77,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('pip_show', pip_show_command_output)
+
+    or
+
     import jc.parsers.pip_show
     result = jc.parsers.pip_show.parse(pip_show_command_output)
 
@@ -80,7 +85,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -90,4 +95,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

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ps', ps_command_output)
+
+    or
+
     import jc.parsers.ps
     result = jc.parsers.ps.parse(ps_command_output)
 
@@ -56,7 +61,7 @@ Examples:
         "stime": "Nov01",
         "tty": null,
         "time": "00:00:11",
-        "cmd": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
+        "cmd": "/usr/lib/systemd/systemd --switched-root --system --dese..."
       },
       {
         "uid": "root",
@@ -91,7 +96,7 @@ Examples:
         "stime": "Nov01",
         "tty": "?",
         "time": "00:00:11",
-        "cmd": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
+        "cmd": "/usr/lib/systemd/systemd --switched-root --system --dese..."
       },
       {
         "uid": "root",
@@ -129,7 +134,7 @@ Examples:
         "stat": "Ss",
         "start": "Nov09",
         "time": "0:08",
-        "command": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
+        "command": "/usr/lib/systemd/systemd --switched-root --system --..."
       },
       {
         "user": "root",
@@ -173,7 +178,7 @@ Examples:
         "stat": "Ss",
         "start": "Nov09",
         "time": "0:08",
-        "command": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
+        "command": "/usr/lib/systemd/systemd --switched-root --system --..."
       },
       {
         "user": "root",
@@ -221,7 +226,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -231,4 +236,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('route', route_command_output)
+
+    or
+
     import jc.parsers.route
     result = jc.parsers.route.parse(route_command_output)
 
@@ -25,7 +30,7 @@ Schema:
         "genmask":         string,
         "flags":           string,
         "flags_pretty": [
-                           string,
+                           string
         ]
         "metric":          integer,
         "ref":             integer,
@@ -76,7 +81,6 @@ Examples:
       }
     ]
 
-
     $ route -ee | jc --route -p -r
     [
       {
@@ -108,7 +112,6 @@ Examples:
     ]
 
 
-
 ## info
 ```python
 info()
@@ -125,7 +128,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -135,4 +138,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

@@ -5,9 +5,11 @@ jc - JSON CLI output utility `rpm -qi` command output parser
 
 Works with `rpm -qi [package]` or `rpm -qia`.
 
-The `..._epoch` calculated timestamp fields are naive (i.e. based on the local time of the system the parser is run on)
+The `..._epoch` calculated timestamp fields are naive. (i.e. based on the
+local time of the system the parser is run on)
 
-The `..._epoch_utc` calculated timestamp fields are timezone-aware and is only available if the timezone field is UTC.
+The `..._epoch_utc` calculated timestamp fields are timezone-aware and is
+only available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -19,6 +21,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('rpm_qi', rpm_qi_command_output)
+
+    or
+
     import jc.parsers.rpm_qi
     result = jc.parsers.rpm_qi.parse(rpm_qi_command_output)
 
@@ -32,16 +39,16 @@ Schema:
         "release":                  string,
         "architecture":             string,
         "install_date":             string,
-        "install_date_epoch":       integer,          # naive timestamp
-        "install_date_epoch_utc":   integer,          # Aware timestamp if timezone is UTC
+        "install_date_epoch":       integer,      # [0]
+        "install_date_epoch_utc":   integer,      # [1]
         "group":                    string,
         "size":                     integer,
         "license":                  string,
         "signature":                string,
         "source_rpm":               string,
         "build_date":               string,
-        "build_epoch":              integer,          # naive timestamp
-        "build_epoch_utc":          integer,          # Aware timestamp if timezone is UTC
+        "build_epoch":              integer,      # [0]
+        "build_epoch_utc":          integer,      # [1]
         "build_host":               string,
         "relocations":              string,
         "packager":                 string,
@@ -52,6 +59,9 @@ Schema:
       }
     ]
 
+    [0] naive timestamp
+    [1] Aware timestamp if timezone is UTC
+
 Examples:
 
     $ rpm -qia | jc --rpm-qi -p
@@ -66,7 +76,7 @@ Examples:
         "group": "Development/Tools",
         "size": 1160660,
         "license": "GPLv2+",
-        "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ID 24c6a8a7f4a80eb5",
+        "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ...",
         "source_rpm": "make-3.82-24.el7.src.rpm",
         "build_date": "Thu 08 Aug 2019 05:47:25 PM PDT",
         "build_host": "x86-01.bsys.centos.org",
@@ -74,8 +84,8 @@ Examples:
         "packager": "CentOS BuildSystem <http://bugs.centos.org>",
         "vendor": "CentOS",
         "url": "http://www.gnu.org/software/make/",
-        "summary": "A GNU tool which simplifies the build process for users",
-        "description": "A GNU tool for controlling the generation of executables and other...",
+        "summary": "A GNU tool which simplifies the build process for ...",
+        "description": "A GNU tool for controlling the generation of ex...",
         "build_epoch": 1565311645,
         "build_epoch_utc": null,
         "install_date_epoch": 1571242902,
@@ -90,7 +100,7 @@ Examples:
         "group": "System Environment/Base",
         "size": 503608,
         "license": "GPLv2+",
-        "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ID 24c6a8a7f4a80eb5",
+        "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ...",
         "source_rpm": "kbd-1.15.5-15.el7.src.rpm",
         "build_date": "Tue 30 Oct 2018 03:40:00 PM PDT",
         "build_host": "x86-01.bsys.centos.org",
@@ -99,7 +109,7 @@ Examples:
         "vendor": "CentOS",
         "url": "http://ftp.altlinux.org/pub/people/legion/kbd",
         "summary": "Legacy data for kbd package",
-        "description": "The kbd-legacy package contains original keymaps for kbd package...",
+        "description": "The kbd-legacy package contains original keymap...",
         "build_epoch": 1540939200,
         "build_epoch_utc": null,
         "install_date_epoch": 1565891588,
@@ -120,7 +130,7 @@ Examples:
         "group": "Development/Tools",
         "size": "1160660",
         "license": "GPLv2+",
-        "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ID 24c6a8a7f4a80eb5",
+        "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ...",
         "source_rpm": "make-3.82-24.el7.src.rpm",
         "build_date": "Thu 08 Aug 2019 05:47:25 PM PDT",
         "build_host": "x86-01.bsys.centos.org",
@@ -128,8 +138,8 @@ Examples:
         "packager": "CentOS BuildSystem <http://bugs.centos.org>",
         "vendor": "CentOS",
         "url": "http://www.gnu.org/software/make/",
-        "summary": "A GNU tool which simplifies the build process for users",
-        "description": "A GNU tool for controlling the generation of executables and other..."
+        "summary": "A GNU tool which simplifies the build process for...",
+        "description": "A GNU tool for controlling the generation of exe..."
       },
       {
         "name": "kbd-legacy",
@@ -140,7 +150,7 @@ Examples:
         "group": "System Environment/Base",
         "size": "503608",
         "license": "GPLv2+",
-        "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ID 24c6a8a7f4a80eb5",
+        "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ...",
         "source_rpm": "kbd-1.15.5-15.el7.src.rpm",
         "build_date": "Tue 30 Oct 2018 03:40:00 PM PDT",
         "build_host": "x86-01.bsys.centos.org",
@@ -149,7 +159,7 @@ Examples:
         "vendor": "CentOS",
         "url": "http://ftp.altlinux.org/pub/people/legion/kbd",
         "summary": "Legacy data for kbd package",
-        "description": "The kbd-legacy package contains original keymaps for kbd package..."
+        "description": "The kbd-legacy package contains original keymaps..."
       },
       ...
     ]
@@ -171,7 +181,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -181,4 +191,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

@@ -0,0 +1,235 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.sfdisk
+jc - JSON CLI output utility `sfdisk` command output parser
+
+Supports the following `sfdisk` options:
+- `-l`
+- `-F`
+- `-d`   (deprecated - only for older versions of util-linux)
+- `-uM`  (deprecated - only for older versions of util-linux)
+- `-uC`  (deprecated - only for older versions of util-linux)
+- `-uS`  (deprecated - only for older versions of util-linux)
+- `-uB`  (deprecated - only for older versions of util-linux)
+
+Usage (cli):
+
+    # sfdisk -l | jc --sfdisk
+
+    or
+
+    # jc sfdisk -l
+
+Usage (module):
+
+    import jc
+    result = jc.parse('sfdisk', sfdisk_command_output)
+
+    or
+
+    import jc.parsers.sfdisk
+    result = jc.parsers.sfdisk.parse(sfdisk_command_output)
+
+Schema:
+
+    [
+      {
+        "disk":                     string,
+        "disk_size":                string,
+        "free_disk_size":           string,
+        "bytes":                    integer,
+        "free_bytes":               integer,
+        "sectors":                  integer,
+        "free_sectors":             integer,
+        "cylinders":                integer,
+        "heads":                    integer,
+        "sectors_per_track":        integer,
+        "units":                    string,
+        "logical_sector_size":      integer,
+        "physical_sector_size":     integer,
+        "min_io_size":              integer,
+        "optimal_io_size":          integer,
+        "disk_label_type":          string,
+        "disk_identifier":          string,
+        "disk_model":               string,
+        "partitions": [
+          {
+            "device":               string,
+            "boot":                 boolean,
+            "start":                integer,
+            "end":                  integer,
+            "size":                 string,    # [0]
+            "cyls":                 integer,
+            "mib":                  integer,
+            "blocks":               integer,
+            "sectors":              integer,
+            "id":                   string,
+            "system":               string,
+            "type":                 string
+          }
+        ]
+      }
+    ]
+
+    [0] will be integer when using deprecated -d sfdisk option
+
+Examples:
+
+    # sfdisk -l | jc --sfdisk -p
+    [
+      {
+        "disk": "/dev/sda",
+        "cylinders": 2610,
+        "heads": 255,
+        "sectors_per_track": 63,
+        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, ...",
+        "partitions": [
+          {
+            "device": "/dev/sda1",
+            "boot": true,
+            "start": 0,
+            "end": 130,
+            "cyls": 131,
+            "blocks": 1048576,
+            "id": "83",
+            "system": "Linux"
+          },
+          {
+            "device": "/dev/sda2",
+            "boot": false,
+            "start": 130,
+            "end": 2610,
+            "cyls": 2481,
+            "blocks": 19921920,
+            "id": "8e",
+            "system": "Linux LVM"
+          },
+          {
+            "device": "/dev/sda3",
+            "boot": false,
+            "start": 0,
+            "end": null,
+            "cyls": 0,
+            "blocks": 0,
+            "id": "0",
+            "system": "Empty"
+          },
+          {
+            "device": "/dev/sda4",
+            "boot": false,
+            "start": 0,
+            "end": null,
+            "cyls": 0,
+            "blocks": 0,
+            "id": "0",
+            "system": "Empty"
+          }
+        ]
+      },
+      {
+        "disk": "/dev/mapper/centos-root",
+        "cylinders": 2218,
+        "heads": 255,
+        "sectors_per_track": 63
+      },
+      {
+        "disk": "/dev/mapper/centos-swap",
+        "cylinders": 261,
+        "heads": 255,
+        "sectors_per_track": 63
+      }
+    ]
+
+    # sfdisk -l | jc --sfdisk -p -r
+    [
+      {
+        "disk": "/dev/sda",
+        "cylinders": "2610",
+        "heads": "255",
+        "sectors_per_track": "63",
+        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, co...",
+        "partitions": [
+          {
+            "device": "/dev/sda1",
+            "boot": "*",
+            "start": "0+",
+            "end": "130-",
+            "cyls": "131-",
+            "blocks": "1048576",
+            "id": "83",
+            "system": "Linux"
+          },
+          {
+            "device": "/dev/sda2",
+            "boot": null,
+            "start": "130+",
+            "end": "2610-",
+            "cyls": "2481-",
+            "blocks": "19921920",
+            "id": "8e",
+            "system": "Linux LVM"
+          },
+          {
+            "device": "/dev/sda3",
+            "boot": null,
+            "start": "0",
+            "end": "-",
+            "cyls": "0",
+            "blocks": "0",
+            "id": "0",
+            "system": "Empty"
+          },
+          {
+            "device": "/dev/sda4",
+            "boot": null,
+            "start": "0",
+            "end": "-",
+            "cyls": "0",
+            "blocks": "0",
+            "id": "0",
+            "system": "Empty"
+          }
+        ]
+      },
+      {
+        "disk": "/dev/mapper/centos-root",
+        "cylinders": "2218",
+        "heads": "255",
+        "sectors_per_track": "63"
+      },
+      {
+        "disk": "/dev/mapper/centos-swap",
+        "cylinders": "261",
+        "heads": "255",
+        "sectors_per_track": "63"
+      }
+    ]
+
+
+## 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) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+## Parser Information
+Compatibility:  linux
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/shadow.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('shadow', shadow_file_output)
+
+    or
+
     import jc.parsers.shadow
     result = jc.parsers.shadow.parse(shadow_file_output)
 
@@ -116,7 +121,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -126,4 +131,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

@@ -3,7 +3,8 @@
 # jc.parsers.ss
 jc - JSON CLI output utility `ss` command output parser
 
-Extended information options like -e and -p are not supported and may cause parsing irregularities.
+Extended information options like -e and -p are not supported and may cause
+parsing irregularities.
 
 Usage (cli):
 
@@ -15,12 +16,18 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ss', ss_command_output)
+
+    or
+
     import jc.parsers.ss
     result = jc.parsers.ss.parse(ss_command_output)
 
 Schema:
 
-    Information from https://www.cyberciti.biz/files/ss.html used to define field names
+    Information from https://www.cyberciti.biz/files/ss.html used to define
+    field names
 
     [
       {
@@ -293,7 +300,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -303,4 +310,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

@@ -3,9 +3,11 @@
 # jc.parsers.stat
 jc - JSON CLI output utility `stat` command output parser
 
-The `xxx_epoch` calculated timestamp fields are naive (i.e. based on the local time of the system the parser is run on)
+The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
+local time of the system the parser is run on)
 
-The `xxx_epoch_utc` calculated timestamp fields are timezone-aware and are only available if the timezone field is UTC.
+The `xxx_epoch_utc` calculated timestamp fields are timezone-aware and are
+only available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -17,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('stat', stat_command_output)
+
+    or
+
     import jc.parsers.stat
     result = jc.parsers.stat.parse(stat_command_output)
 
@@ -183,7 +190,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -193,4 +200,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 
-Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/stat_s.md

@@ -0,0 +1,121 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.stat_s
+jc - JSON CLI output utility `stat` command output streaming parser
+
+> This streaming parser outputs JSON Lines
+
+The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
+local time of the system the parser is run on).
+
+The `xxx_epoch_utc` calculated timestamp fields are timezone-aware and are
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ stat * | jc --stat-s
+
+Usage (module):
+
+    import jc
+    # result is an iterable object (generator)
+    result = jc.parse('stat_s', stat_command_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.stat_s
+    # result is an iterable object (generator)
+    result = jc.parsers.stat_s.parse(stat_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "file":                     string,
+      "link_to"                   string,
+      "size":                     integer,
+      "blocks":                   integer,
+      "io_blocks":                integer,
+      "type":                     string,
+      "device":                   string,
+      "inode":                    integer,
+      "links":                    integer,
+      "access":                   string,
+      "flags":                    string,
+      "uid":                      integer,
+      "user":                     string,
+      "gid":                      integer,
+      "group":                    string,
+      "access_time":              string,    # - = null
+      "access_time_epoch":        integer,   # naive timestamp
+      "access_time_epoch_utc":    integer,   # timezone-aware timestamp
+      "modify_time":              string,    # - = null
+      "modify_time_epoch":        integer,   # naive timestamp
+      "modify_time_epoch_utc":    integer,   # timezone-aware timestamp
+      "change_time":              string,    # - = null
+      "change_time_epoch":        integer,   # naive timestamp
+      "change_time_epoch_utc":    integer,   # timezone-aware timestamp
+      "birth_time":               string,    # - = null
+      "birth_time_epoch":         integer,   # naive timestamp
+      "birth_time_epoch_utc":     integer,   # timezone-aware timestamp
+      "unix_device":              integer,
+      "rdev":                     integer,
+      "block_size":               integer,
+      "unix_flags":               string,
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":              boolean,   # false if error parsing
+          "error":                string,    # exists if "success" is false
+          "line":                 string     # exists if "success" is false
+        }
+    }
+
+Examples:
+
+    $ stat | jc --stat-s
+    {"file":"(stdin)","unix_device":1027739696,"inode":1155,"flags":"cr...}
+
+    $ stat | jc --stat-s -r
+    {"file":"(stdin)","unix_device":"1027739696","inode":"1155","flag...}
+
+
+## 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)   unprocessed output 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, freebsd
+
+Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/sysctl.md

@@ -3,7 +3,10 @@
 # jc.parsers.sysctl
 jc - JSON CLI output utility `sysctl -a` command output parser
 
-Note: Since `sysctl` output is not easily parsable only a very simple key/value object will be output. An attempt is made to convert obvious integers and floats. If no conversion is desired, use the `-r` command-line argument or the `raw=True` argument in `parse()`.
+Note: Since `sysctl` output is not easily parsable only a very simple
+      key/value object will be output. An attempt is made to convert obvious
+      integers and floats. If no conversion is desired, use the `-r`
+      command-line argument or the `raw=True` argument in `parse()`.
 
 Usage (cli):
 
@@ -15,13 +18,18 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('sysctl', sysctl_command_output)
+
+    or
+
     import jc.parsers.sysctl
     result = jc.parsers.sysctl.parse(sysctl_command_output)
 
 Schema:
 
     {
-      "key1":     string/integer/float,         # best guess based on value
+      "key1":     string/integer/float,     # best guess based on value
       "key2":     string/integer/float,
       "key3":     string/integer/float
     }
@@ -69,7 +77,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -79,4 +87,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl', systemctl_command_output)
+
+    or
+
     import jc.parsers.systemctl
     result = jc.parsers.systemctl.parse(systemctl_command_output)
 
@@ -37,14 +42,14 @@ Examples:
         "load": "loaded",
         "active": "active",
         "sub": "waiting",
-        "description": "Arbitrary Executable File Formats File System Automount Point"
+        "description": "Arbitrary Executable File Formats File System ..."
       },
       {
         "unit": "dev-block-8:2.device",
         "load": "loaded",
         "active": "active",
         "sub": "plugged",
-        "description": "LVM PV 3klkIj-w1qk-DkJi-0XBJ-y3o7-i2Ac-vHqWBM on /dev/sda2 2"
+        "description": "LVM PV 3klkIj-w1qk-DkJi-0XBJ-y3o7-i2Ac-vHqWBM o..."
       },
       {
         "unit": "dev-cdrom.device",
@@ -73,7 +78,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -83,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/systemctl_lj.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_lj', systemctl_lj_command_output)
+
+    or
+
     import jc.parsers.systemctl_lj
     result = jc.parsers.systemctl_lj.parse(systemctl_lj_command_output)
 
@@ -90,7 +95,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -100,4 +105,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

@@ -1,7 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.systemctl_ls
-jc - JSON CLI output utility `systemctl list-sockets` command output parser
+jc - JSON CLI output utility `systemctl list-sockets` command output
+parser
 
 Usage (cli):
 
@@ -13,6 +14,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_ls', systemctl_ls_command_output)
+
+    or
+
     import jc.parsers.systemctl_ls
     result = jc.parsers.systemctl_ls.parse(systemctl_ls_command_output)
 
@@ -65,7 +71,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -75,4 +81,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

@@ -1,7 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.systemctl_luf
-jc - JSON CLI output utility `systemctl list-unit-files` command output parser
+jc - JSON CLI output utility `systemctl list-unit-files` command output
+parser
 
 Usage (cli):
 
@@ -13,6 +14,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_luf', systemctl_luf_command_output)
+
+    or
+
     import jc.parsers.systemctl_luf
     result = jc.parsers.systemctl_luf.parse(systemctl_luf_command_output)
 
@@ -61,7 +67,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -71,4 +77,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

@@ -5,9 +5,13 @@ jc - JSON CLI output utility `systeminfo` command output parser
 
 Blank or missing elements are set to `null`.
 
-The `original_install_date_epoch` and `system_boot_time_epoch` calculated timestamp fields are naive (i.e. based on the local time of the system the parser is run on)
+The `original_install_date_epoch` and `system_boot_time_epoch` calculated
+timestamp fields are naive. (i.e. based on the local time of the system the
+parser is run on)
 
-The `original_install_date_epoch_utc` and `system_boot_time_epoch_utc` calculated timestamp fields are timezone-aware and are only available if the timezone field is UTC.
+The `original_install_date_epoch_utc` and `system_boot_time_epoch_utc`
+calculated timestamp fields are timezone-aware and are only available if
+the timezone field is UTC.
 
 Usage (cli):
 
@@ -15,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systeminfo', systeminfo_command_output)
+
+    or
+
     import jc.parsers.systeminfo
     result = jc.parsers.systeminfo.parse(systeminfo_command_output)
 
@@ -31,11 +40,11 @@ Schema:
       "registered_organization":                    string,
       "product_id":                                 string,
       "original_install_date":                      string,
-      "original_install_date_epoch":                integer,     # naive timestamp
-      "original_install_date_epoch_utc":            integer,     # timezone-aware timestamp
+      "original_install_date_epoch":                integer,     # [0]
+      "original_install_date_epoch_utc":            integer,     # [1]
       "system_boot_time":                           string,
-      "system_boot_time_epoch":                     integer,     # naive timestamp
-      "system_boot_time_epoch_utc":                 integer,     # timezone-aware timestamp
+      "system_boot_time_epoch":                     integer,     # [0]
+      "system_boot_time_epoch_utc":                 integer,     # [1]
       "system_manufacturer":                        string,
       "system_model":                               string,
       "system_type":                                string,
@@ -80,6 +89,9 @@ Schema:
       }
     }
 
+    [0] naive timestamp
+    [1] timezone-aware timestamp
+
 Examples:
 
     $ systeminfo | jc --systeminfo -p
@@ -219,7 +231,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -229,4 +241,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

@@ -3,18 +3,27 @@
 # jc.parsers.time
 jc - JSON CLI output utility `/usr/bin/time` command output parser
 
-Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be used to redirect the output to a file that can be read by `jc`.
+Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be
+used to redirect the output to a file that can be read by `jc`.
 
-Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT` so `jc` can receive it.
+Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT`
+so `jc` can receive it.
 
-Note: `/usr/bin/time` is similar but different from the Bash builtin `time` command.
+Note: `/usr/bin/time` is similar but different from the Bash builtin
+      `time` command.
 
 Usage (cli):
 
-    $ /usr/bin/time -o timefile.out sleep 2.5; cat timefile.out | jc --time -p
+    $ /usr/bin/time -o timefile.out sleep 2; cat timefile.out | \
+      jc --time -p
 
 Usage (module):
 
+    import jc
+    result = jc.parse('time', time_command_output)
+
+    or
+
     import jc.parsers.time
     result = jc.parsers.time.parse(time_command_output)
 
@@ -39,8 +48,8 @@ Schema:
       "average_unshared_stack_size":        integer,
       "average_shared_memory_size":         integer,
       "maximum_resident_set_size":          integer,
-      "block_input_operations":             integer,   # aka File system inputs
-      "block_output_operations":            integer,   # aka File system outputs
+      "block_input_operations":             integer,   # [0]
+      "block_output_operations":            integer,   # [1]
       "major_pagefaults":                   integer,
       "minor_pagefaults":                   integer,
       "swaps":                              integer,
@@ -60,15 +69,19 @@ Schema:
       "exit_status":                        integer
     }
 
+    [0] aka File system inputs
+    [1] aka File system outputs
+
 Examples:
 
-    $ /usr/bin/time --verbose -o timefile.out sleep 2.5; cat timefile.out | jc --time -p
+    $ /usr/bin/time --verbose -o timefile.out sleep 2; cat timefile.out | \
+      jc --time -p
     {
-      "command_being_timed": "sleep 2.5",
+      "command_being_timed": "sleep 2",
       "user_time": 0.0,
       "system_time": 0.0,
       "cpu_percent": 0,
-      "elapsed_time": "0:02.50",
+      "elapsed_time": "0:02.00",
       "average_shared_text_size": 0,
       "average_unshared_data_size": 0,
       "average_stack_size": 0,
@@ -94,13 +107,14 @@ Examples:
       "elapsed_time_total_seconds": 2.5
     }
 
-    $ /usr/bin/time --verbose -o timefile.out sleep 2.5; cat timefile.out | jc --time -p -r
+    $ /usr/bin/time --verbose -o timefile.out sleep 2; cat timefile.out | \
+      jc --time -p -r
     {
-      "command_being_timed": ""sleep 2.5"",
+      "command_being_timed": ""sleep 2"",
       "user_time": "0.00",
       "system_time": "0.00",
       "cpu_percent": "0",
-      "elapsed_time": "0:02.50",
+      "elapsed_time": "0:02.00",
       "average_shared_text_size": "0",
       "average_unshared_data_size": "0",
       "average_stack_size": "0",
@@ -138,7 +152,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -148,4 +162,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

@@ -3,7 +3,8 @@
 # jc.parsers.timedatectl
 jc - JSON CLI output utility `timedatectl` command output parser
 
-The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the `universal_time` field is available.
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the `universal_time` field is available.
 
 Usage (cli):
 
@@ -15,6 +16,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('timedatectl', timedatectl_command_output)
+
+    or
+
     import jc.parsers.timedatectl
     result = jc.parsers.timedatectl.parse(timedatectl_command_output)
 
@@ -23,7 +29,7 @@ Schema:
     {
       "local_time":                        string,
       "universal_time":                    string,
-      "epoch_utc":                         integer,     # timezone-aware timestamp
+      "epoch_utc":                         integer,     # timezone-aware
       "rtc_time":                          string,
       "time_zone":                         string,
       "ntp_enabled":                       boolean,
@@ -78,7 +84,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -88,4 +94,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

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('tracepath', tracepath_command_output)
+
+    or
+
     import jc.parsers.tracepath
     result = jc.parsers.tracepath.parse(tracepath_command_output)
 
@@ -146,7 +151,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -156,4 +161,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

@@ -5,9 +5,12 @@ jc - JSON CLI output utility `traceroute` command output parser
 
 Supports `traceroute` and `traceroute6` output.
 
-Note: On some operating systems you will need to redirect `STDERR` to `STDOUT` for destination info since the header line is sent to `STDERR`. A warning message will be printed to `STDERR` if the header row is not found.
+Note: On some operating systems you will need to redirect `STDERR` to
+      `STDOUT` for destination info since the header line is sent to
+      `STDERR`. A warning message will be printed to `STDERR` if the
+      header row is not found.
 
-e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
+      e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
 
 Usage (cli):
 
@@ -19,6 +22,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('traceroute', traceroute_command_output)
+
+    or
+
     import jc.parsers.traceroute
     result = jc.parsers.traceroute.parse(traceroute_command_output)
 
@@ -132,7 +140,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -142,4 +150,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

@@ -0,0 +1,233 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.ufw
+jc - JSON CLI output utility `ufw status` command output parser
+
+Usage (cli):
+
+    $ ufw status | jc --ufw
+
+    or
+
+    $ jc ufw status
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ufw', ufw_command_output)
+
+    or
+
+    import jc.parsers.ufw
+    result = jc.parsers.ufw.parse(ufw_command_output)
+
+Schema:
+
+    {
+      "status":                     string,
+      "logging":                    string,
+      "logging_level":              string,
+      "default":                    string,
+      "new_profiles":               string,
+      "rules": [
+        {
+          "action":                 string,
+          "action_direction":       string,     # null if blank
+          "index":                  integer,    # null if blank
+          "network_protocol":       string,
+          "to_ip":                  string,
+          "to_ip_prefix":           integer,
+          "to_interface":           string,
+          "to_transport":           string,
+          "to_ports": [
+                                    integer
+          ],
+          "to_port_ranges": [
+            {
+              "start":              integer,
+              "end":                integer
+            }
+          ],
+          "to_service":             string,     # [0]
+          "from_ip":                string,
+          "from_ip_prefix":         integer,
+          "from_interface":         string,
+          "from_transport":         string,
+          "from_ports": [
+                                    integer
+          ],
+          "from_port_ranges": [
+            {
+              "start":              integer,
+              "end":                integer
+            }
+          ],
+          "from_service":           string,     # [1]
+          "comment":                string      # null if no comment
+        }
+      ]
+    }
+
+    [0] null if any 'to' ports or port_ranges are set
+    [1] null if any 'from' ports or port_ranges are set
+
+Examples:
+
+    $ ufw status verbose | jc --ufw -p
+    {
+      "status": "active",
+      "logging": "on",
+      "logging_level": "low",
+      "default": "deny (incoming), allow (outgoing), disabled (routed)",
+      "new_profiles": "skip",
+      "rules": [
+        {
+          "action": "ALLOW",
+          "action_direction": "IN",
+          "index": null,
+          "network_protocol": "ipv4",
+          "to_interface": "any",
+          "to_transport": "any",
+          "to_service": null,
+          "to_ports": [
+            22
+          ],
+          "to_ip": "0.0.0.0",
+          "to_ip_prefix": 0,
+          "comment": null,
+          "from_ip": "0.0.0.0",
+          "from_ip_prefix": 0,
+          "from_interface": "any",
+          "from_transport": "any",
+          "from_port_ranges": [
+            {
+              "start": 0,
+              "end": 65535
+            }
+          ],
+          "from_service": null
+        },
+        {
+          "action": "ALLOW",
+          "action_direction": "IN",
+          "index": null,
+          "network_protocol": "ipv4",
+          "to_interface": "any",
+          "to_transport": "tcp",
+          "to_service": null,
+          "to_ports": [
+            80,
+            443
+          ],
+          "to_ip": "0.0.0.0",
+          "to_ip_prefix": 0,
+          "comment": null,
+          "from_ip": "0.0.0.0",
+          "from_ip_prefix": 0,
+          "from_interface": "any",
+          "from_transport": "any",
+          "from_port_ranges": [
+            {
+              "start": 0,
+              "end": 65535
+            }
+          ],
+          "from_service": null
+        },
+        ...
+      ]
+    }
+
+    $ ufw status verbose | jc --ufw -p -r
+    {
+      "status": "active",
+      "logging": "on",
+      "logging_level": "low",
+      "default": "deny (incoming), allow (outgoing), disabled (routed)",
+      "new_profiles": "skip",
+      "rules": [
+        {
+          "action": "ALLOW",
+          "action_direction": "IN",
+          "index": null,
+          "network_protocol": "ipv4",
+          "to_interface": "any",
+          "to_transport": "any",
+          "to_service": null,
+          "to_ports": [
+            "22"
+          ],
+          "to_ip": "0.0.0.0",
+          "to_ip_prefix": "0",
+          "comment": null,
+          "from_ip": "0.0.0.0",
+          "from_ip_prefix": "0",
+          "from_interface": "any",
+          "from_transport": "any",
+          "from_port_ranges": [
+            {
+              "start": "0",
+              "end": "65535"
+            }
+          ],
+          "from_service": null
+        },
+        {
+          "action": "ALLOW",
+          "action_direction": "IN",
+          "index": null,
+          "network_protocol": "ipv4",
+          "to_interface": "any",
+          "to_transport": "tcp",
+          "to_service": null,
+          "to_ports": [
+            "80",
+            "443"
+          ],
+          "to_ip": "0.0.0.0",
+          "to_ip_prefix": "0",
+          "comment": null,
+          "from_ip": "0.0.0.0",
+          "from_ip_prefix": "0",
+          "from_interface": "any",
+          "from_transport": "any",
+          "from_port_ranges": [
+            {
+              "start": "0",
+              "end": "65535"
+            }
+          ],
+          "from_service": null
+        },
+        ...
+      ]
+    }
+
+
+## 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) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+## Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ufw_appinfo.md

@@ -0,0 +1,171 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.ufw_appinfo
+jc - JSON CLI output utility `ufw app info [application]` command
+output parser
+
+Supports individual apps via `ufw app info [application]` and all apps list
+via `ufw app info all`.
+
+Because `ufw` application definitions allow overlapping ports and port
+ranges, this parser preserves that behavior, but also provides `normalized`
+lists and ranges that remove duplicate ports and merge overlapping ranges.
+
+Usage (cli):
+
+    $ ufw app info OpenSSH | jc --ufw-appinfo
+
+    or
+
+    $ jc ufw app info OpenSSH
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ufw_appinfo', ufw_appinfo_command_output)
+
+    or
+
+    import jc.parsers.ufw_appinfo
+    result = jc.parsers.ufw_appinfo.parse(ufw_appinfo_command_output)
+
+Schema:
+
+    [
+      {
+        "profile":                  string,
+        "title":                    string,
+        "description":              string,
+        "tcp_list": [
+                                    integer
+        ],
+        "tcp_ranges": [
+          {
+            "start":                integer,      # [0]
+            "end":                  integer
+          }
+        ],
+        "udp_list": [
+                                    integer
+        ],
+        "udp_ranges": [
+          {
+            "start":                integer,      # [0]
+            "end":                  integer
+          }
+        ],
+        "normalized_tcp_list": [
+                                    integers      # [1]
+        ],
+        "normalized_tcp_ranges": [
+          {
+            "start":                integer,      # [0]
+            "end":                  integers      # [2]
+          }
+        ],
+        "normalized_udp_list": [
+                                    integers      # [1]
+        ],
+        "normalized_udp_ranges": [
+          {
+            "start":                integer,      # [0]
+            "end":                  integers      # [2]
+          }
+        ]
+      }
+    ]
+
+    [0] 'any' is converted to start/end: 0/65535
+    [1] duplicates and overlapping are removed
+    [2] overlapping are merged
+
+Examples:
+
+    $ ufw app info MSN | jc --ufw-appinfo -p
+    [
+      {
+        "profile": "MSN",
+        "title": "MSN Chat",
+        "description": "MSN chat protocol (with file transfer and voice)",
+        "tcp_list": [
+          1863,
+          6901
+        ],
+        "udp_list": [
+          1863,
+          6901
+        ],
+        "tcp_ranges": [
+          {
+            "start": 6891,
+            "end": 6900
+          }
+        ],
+        "normalized_tcp_list": [
+          1863,
+          6901
+        ],
+        "normalized_tcp_ranges": [
+          {
+            "start": 6891,
+            "end": 6900
+          }
+        ],
+        "normalized_udp_list": [
+          1863,
+          6901
+        ]
+      }
+    ]
+
+    $ ufw app info MSN | jc --ufw-appinfo -p -r
+    [
+      {
+        "profile": "MSN",
+        "title": "MSN Chat",
+        "description": "MSN chat protocol (with file transfer and voice)",
+        "tcp_list": [
+          "1863",
+          "6901"
+        ],
+        "udp_list": [
+          "1863",
+          "6901"
+        ],
+        "tcp_ranges": [
+          {
+            "start": "6891",
+            "end": "6900"
+          }
+        ]
+      }
+    ]
+
+
+## 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) unprocessed output 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/uname.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('uname', uname_command_output)
+
+    or
+
     import jc.parsers.uname
     result = jc.parsers.uname.parse(uname_command_output)
 
@@ -62,7 +67,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -72,4 +77,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/universal.md

@@ -0,0 +1,57 @@
+
+# jc.parsers.universal
+jc - JSON CLI output utility universal Parsers
+
+## simple_table_parse
+```python
+simple_table_parse(data)
+```
+
+Parse simple tables. The last column may contain data with spaces.
+
+Parameters:
+
+    data:   (list)   Text data to parse that has been split into lines
+                     via .splitlines(). Item 0 must be the header row.
+                     Any spaces in header names should be changed to
+                     underscore '_'. You should also ensure headers are
+                     lowercase by using .lower().
+
+                     Also, ensure there are no blank lines (list items)
+                     in the data.
+
+Returns:
+
+    List of Dictionaries
+
+
+## sparse_table_parse
+```python
+sparse_table_parse(data, delim='\u2063')
+```
+
+Parse tables with missing column data or with spaces in column data.
+
+Parameters:
+
+    data:   (list)   Text data to parse that has been split into lines
+                     via .splitlines(). Item 0 must be the header row.
+                     Any spaces in header names should be changed to
+                     underscore '_'. You should also ensure headers are
+                     lowercase by using .lower(). Do not change the
+                     position of header names as the positions are used
+                     to find the data.
+
+                     Also, ensure there are no blank lines (list items)
+                     in the data.
+
+    delim:  (string) Delimiter to use. By default `u\2063`
+                     (invisible separator) is used since it is unlikely
+                     to ever be seen in terminal output. You can change
+                     this for troubleshooting purposes or if there is a
+                     delimiter conflict with your data.
+
+Returns:
+
+    List of Dictionaries
+

docs/parsers/upower.md

@@ -3,9 +3,11 @@
 # jc.parsers.upower
 jc - JSON CLI output utility `upower` command output parser
 
-The `updated_epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
+The `updated_epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
 
-The `updated_epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC.
+The `updated_epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -17,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('upower', upower_command_output)
+
+    or
+
     import jc.parsers.upower
     result = jc.parsers.upower.parse(upower_command_output)
 
@@ -29,8 +36,8 @@ Schema:
         "native_path":                  string,
         "power_supply":                 boolean,
         "updated":                      string,
-        "updated_epoch":                integer,       # null if date-time conversion fails
-        "updated_epoch_utc":            integer,       # null if date-time conversion fails
+        "updated_epoch":                integer,       # [0]
+        "updated_epoch_utc":            integer,       # [0]
         "updated_seconds_ago":          integer,
         "has_history":                  boolean,
         "has_statistics":               boolean,
@@ -82,12 +89,14 @@ Schema:
       }
     ]
 
+    [0] null if date-time conversion fails
+
 Examples:
 
     $ upower -i /org/freedesktop/UPower/devices/battery | jc --upower -p
     [
       {
-        "native_path": "/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0",
+        "native_path": "/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/p...",
         "vendor": "NOTEBOOK",
         "model": "BAT",
         "serial": "0001",
@@ -146,7 +155,7 @@ Examples:
     $ upower -i /org/freedesktop/UPower/devices/battery | jc --upower -p -r
     [
       {
-        "native_path": "/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0",
+        "native_path": "/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/p...",
         "vendor": "NOTEBOOK",
         "model": "BAT",
         "serial": "0001",
@@ -209,7 +218,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -219,4 +228,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('uptime', uptime_command_output)
+
+    or
+
     import jc.parsers.uptime
     result = jc.parsers.uptime.parse(uptime_command_output)
 
@@ -80,7 +85,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -90,4 +95,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

@@ -0,0 +1,159 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# jc.parsers.vmstat
+jc - JSON CLI output utility `vmstat` command output parser
+
+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)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ vmstat | jc --vmstat
+
+    or
+
+    $ jc vmstat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('vmstat', vmstat_command_output)
+
+    or
+
+    import jc.parsers.vmstat
+    result = jc.parsers.vmstat.parse(vmstat_command_output)
+
+Schema:
+
+    [
+      {
+        "runnable_procs":                    integer,
+        "uninterruptible_sleeping_procs":    integer,
+        "virtual_mem_used":                  integer,
+        "free_mem":                          integer,
+        "buffer_mem":                        integer,
+        "cache_mem":                         integer,
+        "inactive_mem":                      integer,
+        "active_mem":                        integer,
+        "swap_in":                           integer,
+        "swap_out":                          integer,
+        "blocks_in":                         integer,
+        "blocks_out":                        integer,
+        "interrupts":                        integer,
+        "context_switches":                  integer,
+        "user_time":                         integer,
+        "system_time":                       integer,
+        "idle_time":                         integer,
+        "io_wait_time":                      integer,
+        "stolen_time":                       integer,
+        "disk":                              string,
+        "total_reads":                       integer,
+        "merged_reads":                      integer,
+        "sectors_read":                      integer,
+        "reading_ms":                        integer,
+        "total_writes":                      integer,
+        "merged_writes":                     integer,
+        "sectors_written":                   integer,
+        "writing_ms":                        integer,
+        "current_io":                        integer,
+        "io_seconds":                        integer,
+        "timestamp":                         string,
+        "timezone":                          string,
+        "epoch":                             integer,     # [0]
+        "epoch_utc":                         integer      # [1]
+      }
+    ]
+
+    [0] naive timestamp if -t flag is used
+    [1] aware timestamp if -t flag is used and UTC TZ
+
+Examples:
+
+    $ vmstat | jc --vmstat -p
+    [
+      {
+        "runnable_procs": 2,
+        "uninterruptible_sleeping_procs": 0,
+        "virtual_mem_used": 0,
+        "free_mem": 2794468,
+        "buffer_mem": 2108,
+        "cache_mem": 741208,
+        "inactive_mem": null,
+        "active_mem": null,
+        "swap_in": 0,
+        "swap_out": 0,
+        "blocks_in": 1,
+        "blocks_out": 3,
+        "interrupts": 29,
+        "context_switches": 57,
+        "user_time": 0,
+        "system_time": 0,
+        "idle_time": 99,
+        "io_wait_time": 0,
+        "stolen_time": 0,
+        "timestamp": null,
+        "timezone": null
+      }
+    ]
+
+    $ vmstat | jc --vmstat -p -r
+    [
+      {
+        "runnable_procs": "2",
+        "uninterruptible_sleeping_procs": "0",
+        "virtual_mem_used": "0",
+        "free_mem": "2794468",
+        "buffer_mem": "2108",
+        "cache_mem": "741208",
+        "inactive_mem": null,
+        "active_mem": null,
+        "swap_in": "0",
+        "swap_out": "0",
+        "blocks_in": "1",
+        "blocks_out": "3",
+        "interrupts": "29",
+        "context_switches": "57",
+        "user_time": "0",
+        "system_time": "0",
+        "idle_time": "99",
+        "io_wait_time": "0",
+        "stolen_time": "0",
+        "timestamp": null,
+        "timezone": null
+      }
+    ]
+
+
+## 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) unprocessed output 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/vmstat_s.md

@@ -0,0 +1,140 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+
+# 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)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
+
+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
+    # result is an iterable object (generator)
+    result = jc.parse('vmstat_s', vmstat_command_output.splitlines())
+    for item in result:
+        # do something
+
+    or
+
+    import jc.parsers.vmstat_s
+    # result is an iterable object (generator)
+    result = jc.parsers.vmstat_s.parse(vmstat_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "runnable_procs":                   integer,
+      "uninterruptible_sleeping_procs":   integer,
+      "virtual_mem_used":                 integer,
+      "free_mem":                         integer,
+      "buffer_mem":                       integer,
+      "cache_mem":                        integer,
+      "inactive_mem":                     integer,
+      "active_mem":                       integer,
+      "swap_in":                          integer,
+      "swap_out":                         integer,
+      "blocks_in":                        integer,
+      "blocks_out":                       integer,
+      "interrupts":                       integer,
+      "context_switches":                 integer,
+      "user_time":                        integer,
+      "system_time":                      integer,
+      "idle_time":                        integer,
+      "io_wait_time":                     integer,
+      "stolen_time":                      integer,
+      "disk":                             string,
+      "total_reads":                      integer,
+      "merged_reads":                     integer,
+      "sectors_read":                     integer,
+      "reading_ms":                       integer,
+      "total_writes":                     integer,
+      "merged_writes":                    integer,
+      "sectors_written":                  integer,
+      "writing_ms":                       integer,
+      "current_io":                       integer,
+      "io_seconds":                       integer,
+      "timestamp":                        string,
+      "timezone":                         string,
+      "epoch":                            integer,     # [0]
+      "epoch_utc":                        integer      # [1]
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
+        {
+          "success":                      boolean,  # [2]
+          "error":                        string,   # [3]
+          "line":                         string    # [3]
+        }
+    }
+
+    [0] naive timestamp if -t flag is used
+    [1] aware timestamp if -t flag is used and UTC TZ
+    [2] false if error parsing
+    [3] exists if "success" is false
+
+Examples:
+
+    $ vmstat | jc --vmstat-s
+    {"runnable_procs":2,"uninterruptible_sleeping_procs":0,"virtual_mem...}
+    ...
+
+    $ vmstat | jc --vmstat-s -r
+    {"runnable_procs":"2","uninterruptible_sleeping_procs":"0","virtua...}
+    ...
+
+
+## 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)   unprocessed output 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 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/w.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('w', w_command_output)
+
+    or
+
     import jc.parsers.w
     result = jc.parsers.w.parse(w_command_output)
 
@@ -118,7 +123,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -128,4 +133,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

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('wc', wc_command_output)
+
+    or
+
     import jc.parsers.wc
     result = jc.parsers.wc.parse(wc_command_output)
 
@@ -69,7 +74,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -79,4 +84,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

@@ -5,7 +5,8 @@ jc - JSON CLI output utility `who` command output parser
 
 Accepts any of the following who options (or no options): `-aTH`
 
-The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
 Usage (cli):
 
@@ -17,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('who', who_command_output)
+
+    or
+
     import jc.parsers.who
     result = jc.parsers.who.parse(who_command_output)
 
@@ -29,7 +35,7 @@ Schema:
         "writeable_tty":   string,
         "tty":             string,
         "time":            string,
-        "epoch":           integer,     # naive timestamp. null if time cannot be converted
+        "epoch":           integer,     # [0]
         "idle":            string,
         "pid":             integer,
         "from":            string,
@@ -37,6 +43,8 @@ Schema:
       }
     ]
 
+    [0] naive timestamp. null if time cannot be converted
+
 Examples:
 
     $ who -a | jc --who -p
@@ -147,7 +155,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -157,4 +165,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

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('xml', xml_file_output)
+
+    or
+
     import jc.parsers.xml
     result = jc.parsers.xml.parse(xml_file_output)
 
@@ -85,7 +90,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -95,4 +100,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/yaml.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('yaml', yaml_file_output)
+
+    or
+
     import jc.parsers.yaml
     result = jc.parsers.yaml.parse(yaml_file_output)
 
@@ -99,7 +104,7 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
@@ -109,4 +114,4 @@ Returns:
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/zipinfo.md

@@ -0,0 +1,112 @@
+[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
+    result = jc.parse('zipinfo', zipinfo_command_output)
+
+    or
+
+    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) unprocessed output 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/readme.md

@@ -4,85 +4,70 @@ JC - JSON CLI output utility
 
 * kellyjonbrazil@gmail.com
 
-This package serializes the output of many standard unix command line tools to JSON format.
+This package serializes the output of many standard unix command line tools
+to dictionaries and lists of dictionaries.
 
-For documentation on each parser, see the [documentation site](https://kellyjonbrazil.github.io/jc/).
+## Interactive Documentation
 
-CLI Example:
+    >>> help(jc)
+    >>> help(jc.lib)
+    >>> help(jc.util)
+    >>> jc.get_help('parser_module_name')
 
-    $ dig example.com | jc --dig -p
-    [
-      {
-        "id": 2951,
-        "opcode": "QUERY",
-        "status": "NOERROR",
-        "flags": [
-          "qr",
-          "rd",
-          "ra"
-        ],
-        "query_num": 1,
-        "answer_num": 1,
-        "authority_num": 0,
-        "additional_num": 1,
-        "opt_pseudosection": {
-          "edns": {
-            "version": 0,
-            "flags": [],
-            "udp": 4096
-          }
-        },
-        "question": {
-          "name": "example.com.",
-          "class": "IN",
-          "type": "A"
-        },
-        "answer": [
-          {
-            "name": "example.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": 39302,
-            "data": "93.184.216.34"
-          }
-        ],
-        "query_time": 49,
-        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
-        "when": "Fri Apr 16 16:05:10 PDT 2021",
-        "rcvd": 56,
-        "when_epoch": 1618614310,
-        "when_epoch_utc": null
-      }
-    ]
+## Online Documentation
 
-Module Example:
+### Latest
 
+https://github.com/kellyjonbrazil/jc/tree/master/docs
+
+### Specific Version
+
+Replace `{{full_version_number}}` - e.g. `1.17.7`:
+
+`https://github.com/kellyjonbrazil/jc/tree/v{{full_version_number}}/docs`
+
+Specific versions can also be selected by tag in the branch dropdown menu.
+
+## Usage Example
+
+    >>> import subprocess
+    >>> import jc
+    >>>
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
+    >>> data = jc.parse('dig', cmd_output)
+    >>> data
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
+
+Alternatively, you can bypass the high-level API and call the parser
+modules directly:
+
+    >>> import subprocess
     >>> import jc.parsers.dig
     >>>
-    >>> data = '''; <<>> DiG 9.10.6 <<>> example.com
-    ... ;; global options: +cmd
-    ... ;; Got answer:
-    ... ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 64612
-    ... ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
-    ...
-    ... ;; OPT PSEUDOSECTION:
-    ... ; EDNS: version: 0, flags:; udp: 4096
-    ... ;; QUESTION SECTION:
-    ... ;example.com.           IN  A
-    ...
-    ... ;; ANSWER SECTION:
-    ... example.com.        29658   IN  A   93.184.216.34
-    ...
-    ... ;; Query time: 52 msec
-    ... ;; SERVER: 2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)
-    ... ;; WHEN: Fri Apr 16 16:13:00 PDT 2021
-    ... ;; MSG SIZE  rcvd: 56'''
-    >>>
-    >>> jc.parsers.dig.parse(data)
-    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', 'flags': ['qr', 'rd', 'ra'], 'query_num': 1, 'answer_num':
-    1, 'authority_num': 0, 'additional_num': 1, 'opt_pseudosection': {'edns': {'version': 0, 'flags': [], 'udp':
-    4096}}, 'question': {'name': 'example.com.', 'class': 'IN', 'type': 'A'}, 'answer': [{'name': 'example.com.',
-    'class': 'IN', 'type': 'A', 'ttl': 29658, 'data': '93.184.216.34'}], 'query_time': 52, 'server':
-    '2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when': 'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56,
-    'when_epoch': 1618614780, 'when_epoch_utc': None}]
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
+    >>> data = jc.parsers.dig.parse(cmd_output)
+    >>> data
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
+
+## Available Functions
+
+Use `help(jc.lib)` for details:
+
+    parse(parser_module_name: str, data: str | iterable)
+        High-level API to easily access the parser. This API will find both
+        built-in parsers and local plugin parsers.
+
+    get_help(parser_module_name: str)
+        Convenience function to display the help screen for a parser using
+        its module name.
+
+    parser_mod_list()
+        Get a list of all available parser module names to be used in
+        parse() and get_help().
+
+    plugin_parser_mod_list()
+        Get a list of plugin parser module names. This list is a subset of
+        parser_mod_list().
 

docs/utils.md

@@ -4,14 +4,16 @@ jc - JSON CLI output utility utils
 
 ## warning_message
 ```python
-warning_message(message)
+warning_message(message_lines)
 ```
 
-Prints a warning message for non-fatal issues
+Prints warning message for non-fatal issues. The first line is
+prepended with 'jc:  Warning - ' and subsequent lines are indented.
+Wraps text as needed based on the terminal width.
 
 Parameters:
 
-    message:        (string) text of message
+    message:   (list) list of string lines
 
 Returns:
 
@@ -20,14 +22,16 @@ Returns:
 
 ## error_message
 ```python
-error_message(message)
+error_message(message_lines)
 ```
 
-Prints an error message for fatal issues
+Prints an error message for fatal issues. The first line is
+prepended with 'jc:  Error - ' and subsequent lines are indented.
+Wraps text as needed based on the terminal width.
 
 Parameters:
 
-    message:        (string) text of message
+    message:   (list) list of string lines
 
 Returns:
 
@@ -36,17 +40,21 @@ Returns:
 
 ## compatibility
 ```python
-compatibility(mod_name, compatible)
+compatibility(mod_name, compatible, quiet=False)
 ```
-Checks for the parser's compatibility with the running OS platform.
+
+Checks for the parser's compatibility with the running OS
+platform.
 
 Parameters:
 
-    mod_name:       (string) __name__ of the calling module
+    mod_name:     (string) __name__ of the calling module
 
-    compatible:     (list) sys.platform name(s) compatible with the parser
-                    compatible options:
-                    linux, darwin, cygwin, win32, aix, freebsd
+    compatible:   (list) sys.platform name(s) compatible with
+                  the parser. compatible options:
+                  linux, darwin, cygwin, win32, aix, freebsd
+
+    quiet:        (bool) supress compatibility message if True
 
 Returns:
 
@@ -58,7 +66,8 @@ Returns:
 has_data(data)
 ```
 
-Checks if the input contains data. If there are any non-whitespace characters then return True, else return False
+Checks if the input contains data. If there are any non-whitespace
+characters then return True, else return False.
 
 Parameters:
 
@@ -66,7 +75,8 @@ Parameters:
 
 Returns:
 
-    Boolean      True if input string (data) contains non-whitespace characters, otherwise False
+    Boolean      True if input string (data) contains non-whitespace
+                 characters, otherwise False
 
 
 ## convert_to_int
@@ -74,15 +84,16 @@ Returns:
 convert_to_int(value)
 ```
 
-Converts string input to integer by stripping all non-numeric characters
+Converts string and float input to int. Strips all non-numeric
+characters from strings.
 
 Parameters:
 
-    value:          (string/integer/float) Input value
+    value:         (string/integer/float) Input value
 
 Returns:
 
-    integer/None    Integer if successful conversion, otherwise None
+    integer/None   Integer if successful conversion, otherwise None
 
 
 ## convert_to_float
@@ -90,15 +101,16 @@ Returns:
 convert_to_float(value)
 ```
 
-Converts string input to float by stripping all non-numeric characters
+Converts string and int input to float. Strips all non-numeric
+characters from strings.
 
 Parameters:
 
-    value:          (string) Input value
+    value:         (string) Input value
 
 Returns:
 
-    float/None      Float if successful conversion, otherwise None
+    float/None     Float if successful conversion, otherwise None
 
 
 ## convert_to_bool
@@ -106,7 +118,8 @@ Returns:
 convert_to_bool(value)
 ```
 
-Converts string, integer, or float input to boolean by checking for 'truthy' values
+Converts string, integer, or float input to boolean by checking
+for 'truthy' values.
 
 Parameters:
 
@@ -114,24 +127,68 @@ Parameters:
 
 Returns:
 
-    True/False      False unless a 'truthy' number or string is found ('y', 'yes', 'true', '1', 1, -1, etc.)
+    True/False      False unless a 'truthy' number or string is found
+                    ('y', 'yes', 'true', '1', 1, -1, etc.)
 
 
+## stream_success
+```python
+stream_success(output_line, ignore_exceptions)
+```
+Add `_jc_meta` object to output line if `ignore_exceptions=True`
+
+## stream_error
+```python
+stream_error(e, ignore_exceptions, line)
+```
+
+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)
 ```
 
-Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC
+Input a date-time text string of several formats and convert to a
+naive or timezone-aware epoch timestamp in UTC.
 
 Parameters:
 
-    datetime_string:    (str)   a string representation of a date-time in several supported formats
+    datetime_string:  (str)  a string representation of a
+                             date-time in several supported formats
 
 Attributes:
 
-    string              (str)   the input datetime string
-    format              (int)   the format rule that was used to decode the datetime string
-    naive               (int)   timestamp based on locally configured timezone. None if conversion fails
-    utc                 (int)   aware timestamp only if UTC timezone detected in datetime string. None if conversion fails
+    string            (str)   the input datetime string
+
+    format            (int)   the format rule that was used to
+                              decode the datetime string. None if
+                              conversion fails
+
+    naive             (int)   timestamp based on locally configured
+                              timezone. None if conversion fails
+
+    utc               (int)   aware timestamp only if UTC timezone
+                              detected in datetime string. None if
+                              conversion fails
 

jc/__init__.py

@@ -2,88 +2,72 @@
 
 * kellyjonbrazil@gmail.com
 
-This package serializes the output of many standard unix command line tools to JSON format.
+This package serializes the output of many standard unix command line tools
+to dictionaries and lists of dictionaries.
 
-For documentation on each parser, see the [documentation site](https://kellyjonbrazil.github.io/jc/).
+## Interactive Documentation
 
-CLI Example:
+    >>> help(jc)
+    >>> help(jc.lib)
+    >>> help(jc.util)
+    >>> jc.get_help('parser_module_name')
 
-    $ dig example.com | jc --dig -p
-    [
-      {
-        "id": 2951,
-        "opcode": "QUERY",
-        "status": "NOERROR",
-        "flags": [
-          "qr",
-          "rd",
-          "ra"
-        ],
-        "query_num": 1,
-        "answer_num": 1,
-        "authority_num": 0,
-        "additional_num": 1,
-        "opt_pseudosection": {
-          "edns": {
-            "version": 0,
-            "flags": [],
-            "udp": 4096
-          }
-        },
-        "question": {
-          "name": "example.com.",
-          "class": "IN",
-          "type": "A"
-        },
-        "answer": [
-          {
-            "name": "example.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": 39302,
-            "data": "93.184.216.34"
-          }
-        ],
-        "query_time": 49,
-        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
-        "when": "Fri Apr 16 16:05:10 PDT 2021",
-        "rcvd": 56,
-        "when_epoch": 1618614310,
-        "when_epoch_utc": null
-      }
-    ]
+## Online Documentation
 
-Module Example:
+### Latest
 
+https://github.com/kellyjonbrazil/jc/tree/master/docs
+
+### Specific Version
+
+Replace `{{full_version_number}}` - e.g. `1.17.7`:
+
+`https://github.com/kellyjonbrazil/jc/tree/v{{full_version_number}}/docs`
+
+Specific versions can also be selected by tag in the branch dropdown menu.
+
+## Usage Example
+
+    >>> import subprocess
+    >>> import jc
+    >>>
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
+    >>> data = jc.parse('dig', cmd_output)
+    >>> data
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
+
+Alternatively, you can bypass the high-level API and call the parser
+modules directly:
+
+    >>> import subprocess
     >>> import jc.parsers.dig
     >>>
-    >>> data = '''; <<>> DiG 9.10.6 <<>> example.com
-    ... ;; global options: +cmd
-    ... ;; Got answer:
-    ... ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 64612
-    ... ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
-    ... 
-    ... ;; OPT PSEUDOSECTION:
-    ... ; EDNS: version: 0, flags:; udp: 4096
-    ... ;; QUESTION SECTION:
-    ... ;example.com.           IN  A
-    ... 
-    ... ;; ANSWER SECTION:
-    ... example.com.        29658   IN  A   93.184.216.34
-    ... 
-    ... ;; Query time: 52 msec
-    ... ;; SERVER: 2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)
-    ... ;; WHEN: Fri Apr 16 16:13:00 PDT 2021
-    ... ;; MSG SIZE  rcvd: 56'''
-    >>>
-    >>> jc.parsers.dig.parse(data)
-    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', 'flags': ['qr', 'rd', 'ra'], 'query_num': 1, 'answer_num':
-    1, 'authority_num': 0, 'additional_num': 1, 'opt_pseudosection': {'edns': {'version': 0, 'flags': [], 'udp':
-    4096}}, 'question': {'name': 'example.com.', 'class': 'IN', 'type': 'A'}, 'answer': [{'name': 'example.com.',
-    'class': 'IN', 'type': 'A', 'ttl': 29658, 'data': '93.184.216.34'}], 'query_time': 52, 'server':
-    '2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when': 'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56,
-    'when_epoch': 1618614780, 'when_epoch_utc': None}]
-"""
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
+    >>> data = jc.parsers.dig.parse(cmd_output)
+    >>> data
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
 
-name = 'jc'
-__version__ = '1.15.2'
+## Available Functions
+
+Use `help(jc.lib)` for details:
+
+    parse(parser_module_name: str, data: str | iterable)
+        High-level API to easily access the parser. This API will find both
+        built-in parsers and local plugin parsers.
+
+    get_help(parser_module_name: str)
+        Convenience function to display the help screen for a parser using
+        its module name.
+
+    parser_mod_list()
+        Get a list of all available parser module names to be used in
+        parse() and get_help().
+
+    plugin_parser_mod_list()
+        Get a list of plugin parser module names. This list is a subset of
+        parser_mod_list().
+"""
+from .lib import (__version__, parse, parser_mod_list,
+                  plugin_parser_mod_list, get_help)

jc/cli.py

@@ -4,15 +4,17 @@ JC cli module
 
 import sys
 import os
-import os.path
-import re
-import shlex
 import importlib
 import textwrap
 import signal
+import shlex
+import subprocess
 import json
-import jc
-import jc.appdirs as appdirs
+from .lib import __version__, parsers, local_parsers
+from . import utils
+from . import tracebackplus
+from .exceptions import LibraryNotInstalled, ParseError
+
 # make pygments import optional
 try:
     import pygments
@@ -21,115 +23,27 @@ try:
     from pygments.token import (Name, Number, String, Keyword)
     from pygments.lexers import JsonLexer
     from pygments.formatters import Terminal256Formatter
-    pygments_installed = True
+    PYGMENTS_INSTALLED = True
 except Exception:
-    pygments_installed = False
+    PYGMENTS_INSTALLED = False
+
+
+JC_ERROR_EXIT = 100
 
 
 class info():
-    version = jc.__version__
+    version = __version__
     description = 'JSON CLI output utility'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
     website = 'https://github.com/kellyjonbrazil/jc'
-    copyright = '© 2019-2021 Kelly Brazil'
+    copyright = '© 2019-2022 Kelly Brazil'
     license = 'MIT License'
 
 
-__version__ = info.version
-
-parsers = [
-    'acpi',
-    'airport',
-    'airport-s',
-    'arp',
-    'blkid',
-    'cksum',
-    'crontab',
-    'crontab-u',
-    'csv',
-    'date',
-    'df',
-    'dig',
-    'dir',
-    'dmidecode',
-    'dpkg-l',
-    'du',
-    'env',
-    'file',
-    'finger',
-    'free',
-    'fstab',
-    'group',
-    'gshadow',
-    'hash',
-    'hashsum',
-    'hciconfig',
-    'history',
-    'hosts',
-    'id',
-    'ifconfig',
-    'ini',
-    'iptables',
-    'iw-scan',
-    'jobs',
-    'kv',
-    'last',
-    'ls',
-    'lsblk',
-    'lsmod',
-    'lsof',
-    'mount',
-    'netstat',
-    'ntpq',
-    'passwd',
-    'ping',
-    'pip-list',
-    'pip-show',
-    'ps',
-    'route',
-    'rpm-qi',
-    'shadow',
-    'ss',
-    'stat',
-    'sysctl',
-    'systemctl',
-    'systemctl-lj',
-    'systemctl-ls',
-    'systemctl-luf',
-    'systeminfo',
-    'time',
-    'timedatectl',
-    'tracepath',
-    'traceroute',
-    'uname',
-    'upower',
-    'uptime',
-    'w',
-    'wc',
-    'who',
-    'xml',
-    'yaml'
-]
-
-# List of custom or override parsers.
-# Allow any <user_data_dir>/jc/jcparsers/*.py
-local_parsers = []
-data_dir = appdirs.user_data_dir('jc', 'jc')
-local_parsers_dir = os.path.join(data_dir, 'jcparsers')
-if os.path.isdir(local_parsers_dir):
-    sys.path.append(data_dir)
-    for name in os.listdir(local_parsers_dir):
-        if re.match(r'\w+\.py', name) and os.path.isfile(os.path.join(local_parsers_dir, name)):
-            plugin_name = name[0:-3]
-            local_parsers.append(plugin_name)
-            if plugin_name not in parsers:
-                parsers.append(plugin_name)
-
-
 # We only support 2.3.0+, pygments changed color names in 2.4.0.
 # startswith is sufficient and avoids potential exceptions from split and int.
-if pygments_installed:
+if PYGMENTS_INSTALLED:
     if pygments.__version__.startswith('2.3.'):
         PYGMENT_COLOR = {
             'black': '#ansiblack',
@@ -184,10 +98,9 @@ def set_env_colors(env_colors=None):
 
     Default colors:
 
-    JC_COLORS=blue,brightblack,magenta,green
+        JC_COLORS=blue,brightblack,magenta,green
     or
-    JC_COLORS=default,default,default,default
-
+        JC_COLORS=default,default,default,default
     """
     input_error = False
 
@@ -205,7 +118,7 @@ def set_env_colors(env_colors=None):
 
     # if there is an issue with the env variable, just set all colors to default and move on
     if input_error:
-        jc.utils.warning_message('could not parse JC_COLORS environment variable')
+        utils.warning_message(['Could not parse JC_COLORS environment variable'])
         color_list = ['default', 'default', 'default', 'default']
 
     # Try the color set in the JC_COLORS env variable first. If it is set to default, then fall back to default colors
@@ -217,22 +130,21 @@ 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"""
-    if sys.stdout.isatty():
-        return False
-    else:
-        return True
+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):
     """Exit with error on SIGINT"""
-    sys.exit(1)
+    sys.exit(JC_ERROR_EXIT)
 
 
-def parser_shortname(parser_argument):
+def parser_shortname(parser_arg):
     """Return short name of the parser with dashes and no -- prefix"""
-    return parser_argument[2:]
+    return parser_arg[2:]
 
 
 def parser_argument(parser):
@@ -319,14 +231,16 @@ def helptext():
     Parsers:
 {parsers_string}
     Options:
-            -a               about jc
-            -d               debug (-dd for verbose debug)
-            -h               help (-h --parser_name for parser documentation)
-            -m               monochrome output
-            -p               pretty print output
-            -q               quiet - suppress parser warnings
-            -r               raw JSON output
-            -v               version info
+            -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
+            -p    pretty print output
+            -q    quiet - suppress parser warnings (-qq to ignore streaming errors)
+            -r    raw JSON output
+            -u    unbuffer output
+            -v    version info
 
     Examples:
             Standard Syntax:
@@ -353,11 +267,10 @@ def help_doc(options):
             # load parser module just in time so we don't need to load all modules
             parser = parser_module(arg)
             compatible = ', '.join(parser.info.compatible)
-            doc_text = f'''{parser.__doc__}
-Compatibility:  {compatible}
-
-Version {parser.info.version} by {parser.info.author} ({parser.info.author_email})
-'''
+            doc_text = \
+                f'{parser.__doc__}\n'\
+                f'Compatibility:  {compatible}\n\n'\
+                f'Version {parser.info.version} by {parser.info.author} ({parser.info.author_email})\n'
 
             return doc_text
 
@@ -375,46 +288,49 @@ def versiontext():
 
 def json_out(data, pretty=False, env_colors=None, mono=False, piped_out=False):
     """Return a JSON formatted string. String may include color codes or be pretty printed."""
+    separators = (',', ':')
+    indent = None
+
+    if pretty:
+        separators = None
+        indent = 2
+
     if not mono and not piped_out:
         # set colors
         class JcStyle(Style):
             styles = set_env_colors(env_colors)
 
-        if pretty:
-            return str(highlight(json.dumps(data, indent=2, ensure_ascii=False),
-                                 JsonLexer(), Terminal256Formatter(style=JcStyle))[0:-1])
-        else:
-            return str(highlight(json.dumps(data, separators=(',', ':'), ensure_ascii=False),
-                                 JsonLexer(), Terminal256Formatter(style=JcStyle))[0:-1])
-    else:
-        if pretty:
-            return json.dumps(data, indent=2, ensure_ascii=False)
-        else:
-            return json.dumps(data, separators=(',', ':'), ensure_ascii=False)
+        return str(highlight(json.dumps(data, indent=indent, separators=separators, ensure_ascii=False),
+                             JsonLexer(), Terminal256Formatter(style=JcStyle))[0:-1])
+
+    return json.dumps(data, indent=indent, separators=separators, ensure_ascii=False)
 
 
-def generate_magic_command(args):
-    """
-    Return a tuple with a boolean and a command, where the boolean signifies that
-    the command is valid, and the command is either a command string or None.
+def magic_parser(args):
     """
+    Parse command arguments for magic syntax: jc -p ls -al
 
-    # Parse with magic syntax: jc -p ls -al
+    Return a tuple:
+        valid_command   (bool)  is this a valid command? (exists in magic dict)
+        run_command     (list)  list of the user's command to run. None if no command.
+        jc_parser       (str)   parser to use for this user's command.
+        jc_options      (list)  list of jc options
+    """
+    # bail immediately if there are no args or a parser is defined
     if len(args) <= 1 or args[1].startswith('--'):
-        return False, None
+        return False, None, None, []
 
-    # correctly parse escape characters and spaces with shlex
-    args_given = ' '.join(map(shlex.quote, args[1:])).split()
+    args_given = args[1:]
     options = []
 
     # find the options
     for arg in list(args_given):
         # parser found - use standard syntax
         if arg.startswith('--'):
-            return False, None
+            return False, None, None, []
 
         # option found - populate option list
-        elif arg.startswith('-'):
+        if arg.startswith('-'):
             options.extend(args_given.pop(0)[1:])
 
         # command found if iterator didn't already stop - stop iterating
@@ -423,11 +339,11 @@ def generate_magic_command(args):
 
     # if -h, -a, or -v found in options, then bail out
     if 'h' in options or 'a' in options or 'v' in options:
-        return False, None
+        return False, None, None, []
 
-    # all options popped and no command found - for case like 'jc -a'
+    # all options popped and no command found - for case like 'jc -x'
     if len(args_given) == 0:
-        return False, None
+        return False, None, None, []
 
     magic_dict = {}
     parser_info = about_jc()['parsers']
@@ -444,31 +360,37 @@ def generate_magic_command(args):
     # try to get a parser for two_word_command, otherwise get one for one_word_command
     found_parser = magic_dict.get(two_word_command, magic_dict.get(one_word_command))
 
-    # construct a new command line using the standard syntax: COMMAND | jc --PARSER -OPTIONS
-    run_command = ' '.join(args_given)
-    if found_parser:
-        cmd_options = ('-' + ''.join(options)) if options else ''
-        return True, ' '.join([run_command, '|', 'jc', found_parser, cmd_options])
-    else:
-        return False, run_command
+    return (
+        bool(found_parser),                 # was a suitable parser found?
+        args_given,                         # run_command
+        found_parser,                       # the parser selected
+        options                             # jc options to preserve
+    )
 
 
-def magic():
-    """Runs the command generated by generate_magic_command() to support magic syntax"""
-    valid_command, run_command = generate_magic_command(sys.argv)
-    if valid_command:
-        os.system(run_command)
-        sys.exit(0)
-    elif run_command is None:
-        return
-    else:
-        jc.utils.error_message(f'parser not found for "{run_command}". Use "jc -h" for help.')
-        sys.exit(1)
+def run_user_command(command):
+    """Use subprocess to run the user's command. Returns the STDOUT, STDERR, and the Exit Code as a tuple."""
+    proc = subprocess.Popen(command,
+                            stdout=subprocess.PIPE,
+                            stderr=subprocess.PIPE,
+                            close_fds=False,            # Allows inheriting file descriptors. Useful for process substitution
+                            universal_newlines=True)
+    stdout, stderr = proc.communicate()
+
+    return (
+        stdout or '\n',
+        stderr,
+        proc.returncode
+    )
+
+
+def combined_exit_code(program_exit=0, jc_exit=0):
+    exit_code = program_exit + jc_exit
+    exit_code = min(exit_code, 255)
+    return exit_code
 
 
 def main():
-    import jc.utils
-
     # break on ctrl-c keyboard interrupt
     signal.signal(signal.SIGINT, ctrlc)
 
@@ -478,33 +400,52 @@ def main():
     except AttributeError:
         pass
 
-    # try magic syntax first: e.g. jc -p ls -al
-    magic()
+    # enable colors for Windows cmd.exe terminal
+    if sys.platform.startswith('win32'):
+        os.system('')
 
+    # parse magic syntax first: e.g. jc -p ls -al
+    magic_options = []
+    valid_command, run_command, magic_found_parser, magic_options = magic_parser(sys.argv)
+
+    # set colors
     jc_colors = os.getenv('JC_COLORS')
 
+    # set options
     options = []
+    options.extend(magic_options)
 
-    # options
-    for opt in sys.argv:
-        if opt.startswith('-') and not opt.startswith('--'):
-            options.extend(opt[1:])
+    # find options if magic_parser did not find a command
+    if not valid_command:
+        for opt in sys.argv:
+            if opt.startswith('-') and not opt.startswith('--'):
+                options.extend(opt[1:])
 
     about = 'a' in options
     debug = 'd' in options
-    verbose_debug = True if options.count('d') > 1 else False
-    mono = 'm' in options
+    verbose_debug = options.count('d') > 1
+    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
+    ignore_exceptions = options.count('q') > 1
     raw = 'r' in options
+    unbuffer = 'u' in options
     version_info = 'v' in options
 
-    if not pygments_installed:
+    if verbose_debug:
+        tracebackplus.enable(context=11)
+
+    if not PYGMENTS_INSTALLED:
         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:
@@ -515,44 +456,128 @@ def main():
         print(versiontext())
         sys.exit(0)
 
-    if verbose_debug:
-        import jc.tracebackplus
-        jc.tracebackplus.enable(context=11)
+    # if magic syntax used, try to run the command and error if it's not found, etc.
+    magic_stdout, magic_stderr, magic_exit_code = None, None, 0
+    if run_command:
+        try:
+            run_command_str = shlex.join(run_command)      # python 3.8+
+        except AttributeError:
+            run_command_str = ' '.join(run_command)        # older python versions
 
-    if sys.stdin.isatty():
-        jc.utils.error_message('Missing piped data. Use "jc -h" for help.')
-        sys.exit(1)
+    if valid_command:
+        try:
+            magic_stdout, magic_stderr, magic_exit_code = run_user_command(run_command)
+            if magic_stderr:
+                print(magic_stderr[:-1], file=sys.stderr)
 
-    data = sys.stdin.read()
+        except OSError as e:
+            if debug:
+                raise
 
-    found = False
+            error_msg = os.strerror(e.errno)
+            utils.error_message([f'"{run_command_str}" command could not be run: {error_msg}. For details use the -d or -dd option.'])
+            sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
 
-    for arg in sys.argv:
-        parser_name = parser_shortname(arg)
+        except Exception:
+            if debug:
+                raise
 
-        if parser_name in parsers:
-            # load parser module just in time so we don't need to load all modules
-            parser = parser_module(arg)
-            try:
-                result = parser.parse(data, raw=raw, quiet=quiet)
+            utils.error_message([f'"{run_command_str}" command could not be run. For details use the -d or -dd option.'])
+            sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
+
+    elif run_command is not None:
+        utils.error_message([f'"{run_command_str}" cannot be used with Magic syntax. Use "jc -h" for help.'])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
+
+    # find the correct parser
+    if magic_found_parser:
+        parser = parser_module(magic_found_parser)
+        parser_name = parser_shortname(magic_found_parser)
+
+    else:
+        found = False
+        for arg in sys.argv:
+            parser_name = parser_shortname(arg)
+
+            if parser_name in parsers:
+                parser = parser_module(arg)
                 found = True
                 break
 
-            except Exception:
-                if debug:
-                    raise
-                else:
-                    import jc.utils
-                    jc.utils.error_message(
-                        f'{parser_name} parser could not parse the input data. Did you use the correct parser?\n'
-                        '             For details use the -d or -dd option. Use "jc -h" for help.')
-                    sys.exit(1)
+        if not found:
+            utils.error_message(['Missing or incorrect arguments. Use "jc -h" for help.'])
+            sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
 
-    if not found:
-        jc.utils.error_message('Missing or incorrect arguments. Use "jc -h" for help.')
-        sys.exit(1)
+    # check for input errors (pipe vs magic)
+    if not sys.stdin.isatty() and magic_stdout:
+        utils.error_message(['Piped data and Magic syntax used simultaneously. Use "jc -h" for help.'])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
 
-    print(json_out(result, pretty=pretty, env_colors=jc_colors, mono=mono, piped_out=piped_output()))
+    elif sys.stdin.isatty() and magic_stdout is None:
+        utils.error_message(['Missing piped data. Use "jc -h" for help.'])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
+
+    # parse and print to stdout
+    try:
+        # differentiate between regular and streaming parsers
+
+        # streaming
+        if getattr(parser.info, 'streaming', None):
+            result = parser.parse(sys.stdin, raw=raw, quiet=quiet, ignore_exceptions=ignore_exceptions)
+            for line in result:
+                print(json_out(line,
+                               pretty=pretty,
+                               env_colors=jc_colors,
+                               mono=mono,
+                               piped_out=piped_output(force_color)),
+                      flush=unbuffer)
+
+            sys.exit(combined_exit_code(magic_exit_code, 0))
+
+        # regular
+        else:
+            data = magic_stdout or sys.stdin.read()
+            result = parser.parse(data, raw=raw, quiet=quiet)
+            print(json_out(result,
+                           pretty=pretty,
+                           env_colors=jc_colors,
+                           mono=mono,
+                           piped_out=piped_output(force_color)),
+                  flush=unbuffer)
+
+        sys.exit(combined_exit_code(magic_exit_code, 0))
+
+    except (ParseError, LibraryNotInstalled) as e:
+        if debug:
+            raise
+
+        utils.error_message([f'Parser issue with {parser_name}:',
+                             f'{e.__class__.__name__}: {e}',
+                             'For details use the -d or -dd option. Use "jc -h" for help.'])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
+
+    except json.JSONDecodeError:
+        if debug:
+            raise
+
+        utils.error_message(['There was an issue generating the JSON output.',
+                             'For details use the -d or -dd option.'])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
+
+    except Exception:
+        if debug:
+            raise
+
+        streaming_msg = ''
+        if getattr(parser.info, 'streaming', None):
+            streaming_msg = 'Use the -qq option to ignore streaming parser errors.'
+
+        utils.error_message([
+            f'{parser_name} parser could not parse the input data. Did you use the correct parser?',
+            f'{streaming_msg}',
+            'For details use the -d or -dd option. Use "jc -h" for help.'
+        ])
+        sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
 
 
 if __name__ == '__main__':