Merge pull request #203 from kellyjonbrazil/dev

Dev v1.18.2

.github/workflows/pythonapp.yml

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

CHANGELOG

@@ -1,5 +1,35 @@
 jc changelog
 
+20220127 v1.18.2
+- Fix for plugin parsers with underscores in the name
+- Add type hints to public API functions
+- Add plugin attribute to plugin parser metadata
+- Add C locale hint to parsing error messages
+- Refactor more cli code into lib
+
+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)

EXAMPLES.md

@@ -1713,6 +1713,27 @@ 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
@@ -3793,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,3 +1,2 @@
-include jc/man/jc.1.gz
 include man/jc.1
 include CHANGELOG

README.md

@@ -1,60 +1,92 @@
 ![Tests](https://github.com/kellyjonbrazil/jc/workflows/Tests/badge.svg?branch=master)
 ![Pypi](https://img.shields.io/pypi/v/jc.svg)
 
+> `jc` was recently featured in the [Console Open Source Newsletter](https://console.substack.com/p/console-89)
+
+> Check out the `jc` Python [package documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs) for developers
+
 > 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
 
-`jc` JSONifies the output of many CLI tools and file-types for easier parsing in scripts. See the [**Parsers**](#parsers) section for supported commands and file-types.
+`jc` JSONifies the output of many CLI tools and file-types for easier parsing in
+scripts. See the [**Parsers**](#parsers) section for supported commands and
+file-types.
 ```bash
 dig example.com | jc --dig
 ```
 ```json
-[{"id":38052,"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":
-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}]
+[{"id":38052,"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":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` or [`jello`](https://github.com/kellyjonbrazil/jello) 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
 ```
+
 or using the alternative "magic" syntax:
+
 ```bash
 $ jc dig example.com | jq -r '.[].answer[].data'
 93.184.216.34
 ```
-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:
+
+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 subprocess
->>> import jc.parsers.dig
->>> 
+>>> import jc
+>>>
 >>> cmd_output = subprocess.check_output(['dig', 'example.com'], text=True)
->>> data = jc.parsers.dig.parse(cmd_output)
+>>> 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.',
-'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}]
+[{'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}]
 ```
-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()`.
+> For `jc` Python package documentation, use `help('jc')`, `help('jc.lib')`, or
+see the [online documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs).
 
-Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below.
+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**](#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 on [Bringing the Unix Philosophy to the 21st Century](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/) and my [interview with Console](https://console.substack.com/p/console-89).
 
 See also:
 - [libxo on FreeBSD](http://juniper.github.io/libxo/libxo-manual.html)
@@ -70,7 +102,10 @@ Use Cases:
 - [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`, 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.
+There are several ways to get `jc`. You can install via `pip`, OS package
+[repositories](https://repology.org/project/jc/versions), or by downloading the
+correct [binary](https://github.com/kellyjonbrazil/jc/releases) for your
+architecture and running it anywhere on your filesystem.
 
 ### Pip (macOS, linux, unix, Windows)
 ```bash
@@ -79,7 +114,7 @@ pip3 install jc
 
 ### OS Package Repositories
 
-| OS                    | Command                                                                       | 
+| OS                    | Command                                                                       |
 |-----------------------|-------------------------------------------------------------------------------|
 | Debian/Ubuntu linux   | `apt-get install jc`                                                          |
 | Fedora linux          | `dnf install jc`                                                              |
@@ -91,18 +126,28 @@ pip3 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 the [jc packaging](https://kellyjonbrazil.github.io/jc-packaging/) site.
+> For more OS Packages, see https://repology.org/project/jc/versions.
+
+### Binaries and Packages
+For precompiled binaries, 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`.
+`jc` accepts piped input from `STDIN` and outputs a JSON representation of the
+previous command's output to `STDOUT`.
 ```bash
 COMMAND | jc PARSER [OPTIONS]
 ```
-Alternatively, the "magic" syntax can be used by prepending `jc` to the command to be converted. Options can be passed to `jc` immediately before the command is given. (Note: command aliases and shell builtins are not supported)
+
+Alternatively, the "magic" syntax can be used by prepending `jc` to the command
+to be converted. Options can be passed to `jc` immediately before the command is
+given. (Note: command aliases and shell builtins are not supported)
 ```bash
 jc [OPTIONS] COMMAND
 ```
-The JSON output can be compact (default) or pretty formatted with the `-p` option.
+
+The JSON output can be compact (default) or pretty formatted with the `-p`
+option.
 
 ### Parsers
 
@@ -142,6 +187,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--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))
@@ -166,6 +212,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--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))
@@ -188,24 +235,35 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `--who` enables the `who` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/who))
 - `--xml` enables the XML file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/xml))
 - `--yaml` enables the YAML file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/yaml))
+- `--zipinfo` enables the `zipinfo` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo))
 
 ### Options
-- `-a` about `jc`. Prints information about `jc` and the parsers (in JSON, of course!)
-- `-d` debug mode. Prints trace messages if parsing issues are encountered (use `-dd` for verbose debugging)
+- `-a` about `jc`. Prints information about `jc` and the parsers (in JSON, of
+       course!)
+- `-C` force color output even when using pipes (overrides `-m` and the
+       `NO_COLOR` env variable)
+- `-d` debug mode. Prints trace messages if parsing issues are encountered (use
+       `-dd` for verbose debugging)
 - `-h` help. Use `jc -h --parser_name` for parser documentation
 - `-m` monochrome JSON output
 - `-p` pretty format the JSON output
-- `-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
+- `-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`.
+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                     | 
+| `ifconfig` exit code | `jc` exit code | Combined exit code | Interpretation                     |
 |----------------------|----------------|--------------------|------------------------------------|
 | `0`                  | `0`            | `0`                | No errors                          |
 | `1`                  | `0`            | `1`                | Error in  `ifconfig`               |
@@ -214,11 +272,16 @@ Consider the following examples using `ifconfig`:
 
 
 ### 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:
+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
 JC_COLORS=<keyname_color>,<keyword_color>,<number_color>,<string_color>
 ```
-Where colors are: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `gray`, `brightblack`, `brightred`, `brightgreen`, `brightyellow`, `brightblue`, `brightmagenta`, `brightcyan`, `white`, or  `default`
+
+Where colors are: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`,
+`gray`, `brightblack`, `brightred`, `brightgreen`, `brightyellow`, `brightblue`,
+`brightmagenta`, `brightcyan`, `white`, or  `default`
 
 For example, to set to the default colors:
 ```bash
@@ -229,14 +292,34 @@ 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.
+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:
+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
@@ -247,6 +330,7 @@ Successfully parsed line with `-qq` option:
   }
 }
 ```
+
 Unsuccessfully parsed line with `-qq` option:
 ```json
 {
@@ -260,54 +344,76 @@ Unsuccessfully parsed line with `-qq` option:
 
 #### 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`):
+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:
+
+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}
+{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","respons...}
+{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","respons...}
 ...
 ```
+
 > 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()`.
+Streaming parsers accept any iterable object and return an iterator object
+(generator) 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:
+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.parsers.ls_s
+import jc
 
-result = jc.parsers.ls_s.parse(ls_command_output.splitlines())
+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"**:
+Custom local parser plugins may be placed in a `jc/jcparsers` folder in your
+local **"App data directory"**:
 
 - Linux/unix: `$HOME/.local/share/jc/jcparsers`
 - 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) 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 parser plugins are standard python module files. Use the
+[`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py)
+or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py)
+parser as a template and simply place a `.py` file in the `jcparsers` subfolder.
 
-Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default parsers.
+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)
+> 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:
+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
@@ -315,19 +421,30 @@ $ 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).
+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.
+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 `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`.
+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 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()`:
+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
@@ -347,22 +464,30 @@ Tested on:
 - 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) 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.
+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.
 
 ## Acknowledgments
 - Local parser plugin feature contributed by [Dean Serenevy](https://github.com/duelafn)
 - CI automation and code optimizations by [philippeitis](https://github.com/philippeitis)
-- [`ifconfig-parser`](https://github.com/KnightWhoSayNi/ifconfig-parser) module by KnightWhoSayNi
+- [`ifconfig-parser`](https://github.com/KnightWhoSayNi/ifconfig-parser) module
+  by KnightWhoSayNi
 - [`xmltodict`](https://github.com/martinblech/xmltodict) module by Martín Blech
-- [`ruamel.yaml`](https://pypi.org/project/ruamel.yaml) module by Anthon van der Neut
+- [`ruamel.yaml`](https://pypi.org/project/ruamel.yaml) module by Anthon van
+  der Neut
 - [`trparse`](https://github.com/lbenitez000/trparse) module by Luis Benitez
-- Parsing [code](https://gist.github.com/cahna/43a1a3ff4d075bcd71f9d7120037a501) from Conor Heine adapted for some parsers
+- Parsing [code](https://gist.github.com/cahna/43a1a3ff4d075bcd71f9d7120037a501)
+  from Conor Heine adapted for some parsers
 - Excellent constructive feedback from [Ilya Sher](https://github.com/ilyash-b)
 
 ## Examples
-Here are some examples of `jc` output. For more examples, see [here](https://kellyjonbrazil.github.io/jc/EXAMPLES) or the parser documentation.
+Here are some examples of `jc` output. For more examples, see
+[here](https://kellyjonbrazil.github.io/jc/EXAMPLES) or the parser
+documentation.
+
 ### arp
 ```bash
 arp | jc --arp -p          # or:  jc -p arp
@@ -770,7 +895,7 @@ ps axu | jc --ps -p          # or:  jc -p ps axu
     "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 --deseria..."
   },
   {
     "user": "root",
@@ -802,7 +927,8 @@ ps axu | jc --ps -p          # or:  jc -p ps axu
 ```
 ### traceroute
 ```bash
-traceroute -m 2 8.8.8.8 | jc --traceroute -p          # or:  jc -p traceroute -m 2 8.8.8.8
+traceroute -m 2 8.8.8.8 | jc --traceroute -p
+# or:  jc -p traceroute -m 2 8.8.8.8
 ```
 ```json
 {
@@ -1001,4 +1127,4 @@ cat istio.yaml | jc --yaml -p
 ]
 ```
 
-© 2019-2021 Kelly Brazil
+© 2019-2022 Kelly Brazil

docgen.sh

@@ -1,24 +1,104 @@
 #!/bin/bash
 # Generate docs.md
-# requires pydoc-markdown 2.1.0.post1
+# requires pydoc-markdown 4.5.0
+readme_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Data": 3
+        }
+    }
+}
+EOF
+)
+
+toc_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "render_toc": true,
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Data": 3
+        }
+    }
+}
+EOF
+)
+
+parser_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter",
+            "expression": "not name == \"info\" and not name.startswith(\"_\") and default()"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Data": 3
+        }
+    }
+}
+EOF
+)
 
 cd jc
 echo Building docs for: package
-pydocmd simple jc+ > ../docs/readme.md
+pydoc-markdown -m jc "${readme_config}" > ../docs/readme.md
+
+echo Building docs for: lib
+pydoc-markdown -m jc.lib "${toc_config}" > ../docs/lib.md
+
 echo Building docs for: utils
-pydocmd simple utils+ > ../docs/utils.md
+pydoc-markdown -m jc.utils "${toc_config}" > ../docs/utils.md
+
+echo Building docs for: universal parser
+pydoc-markdown -m jc.parsers.universal "${toc_config}" > ../docs/parsers/universal.md
 
 # a bit of inception here... jc is being used to help
 # automate the generation of its own documentation. :)
 
 # pull jc parser objects into a bash array from jq
+# filter out any plugin parsers
 parsers=()
 while read -r value
 do
     parsers+=("$value")
-done < <(jc -a | jq -c '.parsers[]')
+done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)')
 
-# iterate over the bash array
 for parser in "${parsers[@]}"
 do
     parser_name=$(jq -r '.name' <<< "$parser")
@@ -29,8 +109,8 @@ do
 
     echo "Building docs for: ${parser_name}"
     echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md
-    pydocmd simple jc.parsers."${parser_name}"+ >> ../docs/parsers/"${parser_name}".md
-    echo "## Parser Information" >> ../docs/parsers/"${parser_name}".md
+    pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md
+    echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md
     echo "Compatibility:  ${compatible}" >> ../docs/parsers/"${parser_name}".md
     echo >> ../docs/parsers/"${parser_name}".md
     echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md

docs/_config.yml

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

docs/lib.md

@@ -0,0 +1,138 @@
+# Table of Contents
+
+* [jc.lib](#jc.lib)
+  * [parse](#jc.lib.parse)
+  * [parser\_mod\_list](#jc.lib.parser_mod_list)
+  * [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list)
+  * [parser\_info](#jc.lib.parser_info)
+  * [all\_parser\_info](#jc.lib.all_parser_info)
+  * [get\_help](#jc.lib.get_help)
+
+<a id="jc.lib"></a>
+
+# jc.lib
+
+jc - JSON CLI output utility
+JC lib module
+
+<a id="jc.lib.parse"></a>
+
+### parse
+
+```python
+def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: bool = False, raw: bool = False, ignore_exceptions: bool = None, **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]]
+```
+
+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. This
+                                     function will accept module_name,
+                                     cli-name, and --argument-name
+                                     variants of the module name.
+
+    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
+
+<a id="jc.lib.parser_mod_list"></a>
+
+### parser\_mod\_list
+
+```python
+def parser_mod_list() -> List[str]
+```
+
+Returns a list of all available parser module names.
+
+<a id="jc.lib.plugin_parser_mod_list"></a>
+
+### plugin\_parser\_mod\_list
+
+```python
+def plugin_parser_mod_list() -> List[str]
+```
+
+Returns a list of plugin parser module names. This function is a
+subset of `parser_mod_list()`.
+
+<a id="jc.lib.parser_info"></a>
+
+### parser\_info
+
+```python
+def parser_info(parser_mod_name: str) -> Union[Dict, None]
+```
+
+Returns a dictionary that includes the module metadata.
+
+This function will accept **module_name**, **cli-name**, and
+**--argument-name** variants of the module name string.
+
+<a id="jc.lib.all_parser_info"></a>
+
+### all\_parser\_info
+
+```python
+def all_parser_info() -> List[Optional[Dict]]
+```
+
+Returns a list of dictionaris that includes metadata for all modules.
+
+<a id="jc.lib.get_help"></a>
+
+### get\_help
+
+```python
+def get_help(parser_mod_name: str) -> None
+```
+
+Show help screen for the selected parser.
+
+This function will accept **module_name**, **cli-name**, and
+**--argument-name** variants of the module name string.
+

docs/parsers/acpi.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.acpi"></a>
 
 # jc.parsers.acpi
+
 jc - JSON CLI output utility `acpi` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -225,16 +232,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.acpi.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -242,14 +245,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.airport"></a>
 
 # jc.parsers.airport
+
 jc - JSON CLI output utility `airport -I` command output parser
 
 The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
@@ -15,6 +17,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)
 
@@ -78,16 +85,12 @@ Examples:
       "channel": "48,80"
     }
 
+<a id="jc.parsers.airport.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -95,14 +98,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  darwin
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport_s.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.airport_s"></a>
+
+# jc.parsers.airport\_s
 
-# jc.parsers.airport_s
 jc - JSON CLI output utility `airport -s` command output parser
 
 The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
@@ -15,6 +17,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)
 
@@ -106,16 +113,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.airport_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -123,14 +126,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  darwin
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/arp.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.arp"></a>
 
 # jc.parsers.arp
+
 jc - JSON CLI output utility `arp` command output parser
 
 Supports `arp` and `arp -a` output.
@@ -15,6 +17,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)
 
@@ -115,16 +122,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.arp.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -132,14 +135,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
 Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/blkid.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.blkid"></a>
 
 # jc.parsers.blkid
+
 jc - JSON CLI output utility `blkid` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -83,7 +90,7 @@ Examples:
       {
         "id_fs_uuid": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
         "id_fs_uuid_enc": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
-        "id_fs_version": "LVM2\x20001",
+        "id_fs_version": "LVM2\\x20001",
         "id_fs_type": "LVM2_member",
         "id_fs_usage": "raid",
         "id_iolimit_minimum_io_size": 512,
@@ -118,16 +125,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.blkid.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -135,14 +138,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cksum.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cksum"></a>
 
 # jc.parsers.cksum
+
 jc - JSON CLI output utility `cksum` command output parser
 
 This parser works with the following checksum calculation utilities:
@@ -17,6 +19,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)
 
@@ -52,16 +59,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.cksum.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -69,14 +72,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab.md

@@ -1,7 +1,10 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.crontab"></a>
 
 # 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 +18,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 +30,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -168,16 +178,12 @@ Examples:
       ]
     }
 
+<a id="jc.parsers.crontab.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -185,14 +191,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab_u.md

@@ -1,9 +1,13 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.crontab_u"></a>
 
-# jc.parsers.crontab_u
-jc - JSON CLI output utility `crontab -l` command output and crontab file parser
+# jc.parsers.crontab\_u
 
-This version of the `crontab -l` parser supports output that contains user information for processes.
+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.
 
 Usage (cli):
 
@@ -11,6 +15,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 +27,10 @@ Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -53,7 +64,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 +89,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 +108,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 +127,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 +137,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 +152,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 +161,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,21 +170,17 @@ 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 ..."
         }
       ]
     }
 
+<a id="jc.parsers.crontab_u.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -181,14 +188,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv.md

@@ -1,9 +1,13 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.csv"></a>
 
 # 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 +15,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 +38,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
@@ -72,16 +82,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.csv.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -89,14 +95,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### 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/csv_s.md

@@ -1,13 +1,18 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.csv_s"></a>
+
+# jc.parsers.csv\_s
 
-# 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.
+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.
+Note: The first 100 rows are read into memory to enable delimiter detection,
+then the rest of the rows are loaded lazily.
 
 Usage (cli):
 
@@ -15,59 +20,70 @@ Usage (cli):
 
 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 = jc.parsers.csv_s.parse(csv_output.splitlines())    # result is an iterable object
+    # 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
+    csv file converted to a Dictionary:
+    https://docs.python.org/3/library/csv.html
 
     {
       "column_name1":     string,
       "column_name2":     string,
-      "_jc_meta":                    # This object only exists if using -qq or ignore_exceptions=True
+
+      # below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
         {
-          "success":    booean,      # true if successfully parsed, false if error
-          "error":      string,      # exists if "success" is false
-          "line":       string       # exists if "success" is false
+          "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", "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
     ...
 
     $ cat homes.csv | jc --csv-s
-    {"Sell":"142","List":"160","Living":"28","Rooms":"10","Beds":"5","Baths":"3","Age":"60","Acres":"0.28","Taxes":"3167"}
-    {"Sell":"175","List":"180","Living":"18","Rooms":"8","Beds":"4","Baths":"1","Age":"12","Acres":"0.43","Taxes":"4033"}
-    {"Sell":"129","List":"132","Living":"13","Rooms":"6","Beds":"3","Baths":"1","Age":"41","Acres":"0.33","Taxes":"1471"}
+    {"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"...}
     ...
 
+<a id="jc.parsers.csv_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False, ignore_exceptions=False)
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
 ```
 
 Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
-    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
-    raw:               (boolean)   output preprocessed JSON if True
+    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
 
@@ -79,7 +95,7 @@ Returns:
 
     Iterator object
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/date.md

@@ -1,11 +1,15 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.date"></a>
 
 # 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 +21,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 +44,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
@@ -69,16 +82,12 @@ Examples:
       "timezone_aware": true
     }
 
+<a id="jc.parsers.date.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -86,14 +95,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/df.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.df"></a>
 
 # jc.parsers.df
+
 jc - JSON CLI output utility `df` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -95,16 +102,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.df.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -112,14 +115,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dig.md

@@ -1,15 +1,20 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dig"></a>
 
 # jc.parsers.dig
+
 jc - JSON CLI output utility `dig` command output parser
 
 Options supported:
-- `+noall +answer` options are supported in cases where only the answer information is desired.
+- `+noall +answer` options are supported in cases where only the answer
+  information is desired.
 - `+axfr` option is supported on its own
 
-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` 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.
+The `when_epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
 
 Usage (cli):
 
@@ -21,6 +26,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)
 
@@ -93,13 +103,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
@@ -314,16 +327,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.dig.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -331,14 +340,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
 
 Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dir.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dir"></a>
 
 # jc.parsers.dir
+
 jc - JSON CLI output utility `dir` command output parser
 
 Options supported:
@@ -9,9 +11,11 @@ Options supported:
 - `/C, /-C`
 - `/S`
 
-The "Magic" syntax is not supported since the `dir` command is a shell builtin.
+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)
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
 Usage (cli):
 
@@ -19,6 +23,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('dir', dir_command_output)
+
+    or
+
     import jc.parsers.dir
     result = jc.parsers.dir.parse(dir_command_output)
 
@@ -46,7 +55,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": ".",
-        "parent": "C:\Program Files\Internet Explorer",
+        "parent": "C:\\Program Files\\Internet Explorer",
         "epoch": 1616624100
       },
       {
@@ -55,7 +64,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": "..",
-        "parent": "C:\Program Files\Internet Explorer",
+        "parent": "C:\\Program Files\\Internet Explorer",
         "epoch": 1616624100
       },
       {
@@ -64,7 +73,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": "en-US",
-        "parent": "C:\Program Files\Internet Explorer",
+        "parent": "C:\\Program Files\\Internet Explorer",
         "epoch": 1575715740
       },
       {
@@ -73,7 +82,7 @@ Examples:
         "dir": false,
         "size": 54784,
         "filename": "ExtExport.exe",
-        "parent": "C:\Program Files\Internet Explorer",
+        "parent": "C:\\Program Files\\Internet Explorer",
         "epoch": 1575713340
       },
       ...
@@ -87,7 +96,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": ".",
-        "parent": "C:\Program Files\Internet Explorer"
+        "parent": "C:\\Program Files\\Internet Explorer"
       },
       {
         "date": "03/24/2021",
@@ -95,7 +104,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": "..",
-        "parent": "C:\Program Files\Internet Explorer"
+        "parent": "C:\\Program Files\\Internet Explorer"
       },
       {
         "date": "12/07/2019",
@@ -103,7 +112,7 @@ Examples:
         "dir": true,
         "size": null,
         "filename": "en-US",
-        "parent": "C:\Program Files\Internet Explorer"
+        "parent": "C:\\Program Files\\Internet Explorer"
       },
       {
         "date": "12/07/2019",
@@ -111,21 +120,17 @@ Examples:
         "dir": false,
         "size": "54,784",
         "filename": "ExtExport.exe",
-        "parent": "C:\Program Files\Internet Explorer"
+        "parent": "C:\\Program Files\\Internet Explorer"
       },
       ...
     ]
 
+<a id="jc.parsers.dir.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -133,14 +138,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  win32
 
 Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

docs/parsers/dmidecode.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dmidecode"></a>
 
 # jc.parsers.dmidecode
+
 jc - JSON CLI output utility `dmidecode` command output parser
 
 Usage (cli):
@@ -13,6 +15,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 +31,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,
@@ -123,16 +130,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.dmidecode.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -140,14 +143,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dpkg_l.md

@@ -1,9 +1,12 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dpkg_l"></a>
+
+# jc.parsers.dpkg\_l
 
-# 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 +20,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 +80,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 +124,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",
@@ -128,16 +136,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.dpkg_l.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -145,14 +149,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/du.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.du"></a>
 
 # jc.parsers.du
+
 jc - JSON CLI output utility `du` command output parser
 
 Usage (cli):
@@ -13,6 +15,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 +42,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,37 +71,33 @@ 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/..."
       },
       ...
     ]
 
+<a id="jc.parsers.du.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -102,14 +105,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/env.md

@@ -1,9 +1,14 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.env"></a>
 
 # 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 +20,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)
 
@@ -67,16 +77,12 @@ Examples:
       "_": "/usr/bin/env"
     }
 
+<a id="jc.parsers.env.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -84,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:
@@ -92,7 +98,7 @@ Returns:
     Dictionary of raw structured data or
     List of Dictionaries of processed structured data
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/file.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.file"></a>
 
 # jc.parsers.file
+
 jc - JSON CLI output utility `file` command output parser
 
 Usage (cli):
@@ -13,6 +15,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 +28,7 @@ Schema:
     [
       {
         "filename":   string,
-        "type   ":    string
+        "type":       string
       }
     ]
 
@@ -51,25 +58,21 @@ 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 ..."
       },
       ...
     ]
 
+<a id="jc.parsers.file.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -77,14 +80,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/finger.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.finger"></a>
 
 # jc.parsers.finger
+
 jc - JSON CLI output utility `finger` command output parser
 
 Supports `-s` output option. Does not support the `-l` detail option.
@@ -15,6 +17,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)
 
@@ -88,16 +95,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.finger.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -105,14 +108,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, freebsd
 
 Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/free.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.free"></a>
 
 # jc.parsers.free
+
 jc - JSON CLI output utility `free` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -70,16 +77,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.free.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -87,14 +90,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/fstab.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.fstab"></a>
 
 # jc.parsers.fstab
+
 jc - JSON CLI output utility `fstab` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -83,16 +90,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.fstab.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -100,14 +103,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/group.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.group"></a>
 
 # jc.parsers.group
+
 jc - JSON CLI output utility `/etc/group` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -107,16 +114,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.group.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -124,14 +127,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/gshadow.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.gshadow"></a>
 
 # jc.parsers.gshadow
+
 jc - JSON CLI output utility `/etc/gshadow` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -75,16 +82,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.gshadow.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -92,14 +95,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hash.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hash"></a>
 
 # jc.parsers.hash
+
 jc - JSON CLI output utility `hash` command output parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -35,16 +42,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.hash.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -52,14 +55,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hashsum.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hashsum"></a>
 
 # jc.parsers.hashsum
+
 jc - JSON CLI output utility `hash sum` command output parser
 
 This parser works with the following hash calculation utilities:
@@ -23,6 +25,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)
 
@@ -66,16 +73,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.hashsum.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -83,14 +86,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hciconfig.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hciconfig"></a>
 
 # jc.parsers.hciconfig
+
 jc - JSON CLI output utility `hciconfig` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -315,16 +322,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.hciconfig.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -332,14 +335,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/history.md

@@ -1,11 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.history"></a>
 
 # 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.
+The "Magic" syntax is not supported since the `history` command is a shell
+builtin.
 
 Usage (cli):
 
@@ -13,6 +19,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)
 
@@ -39,7 +50,7 @@ Examples:
       },
       {
         "line": 120,
-        "command": "echo "hello""
+        "command": "echo \"hello\""
       },
       {
         "line": 121,
@@ -52,21 +63,17 @@ Examples:
     {
       "118": "sleep 100",
       "119": "ls /bin",
-      "120": "echo "hello"",
+      "120": "echo \"hello\"",
       "121": "docker images",
       ...
     }
 
+<a id="jc.parsers.history.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -74,7 +81,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:
@@ -82,7 +89,7 @@ Returns:
     Dictionary of raw structured data or
     List of Dictionaries of processed structured data
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hosts.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hosts"></a>
 
 # jc.parsers.hosts
+
 jc - JSON CLI output utility `/etc/hosts` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -72,16 +79,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.hosts.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -89,14 +92,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/id.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.id"></a>
 
 # jc.parsers.id
+
 jc - JSON CLI output utility `id` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -103,16 +110,12 @@ Examples:
       }
     }
 
+<a id="jc.parsers.id.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -120,14 +123,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ifconfig.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ifconfig"></a>
 
 # jc.parsers.ifconfig
+
 jc - JSON CLI output utility `ifconfig` command output parser
 
 Note: No `ifconfig` options are supported.
@@ -15,6 +17,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)
 
@@ -184,16 +191,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.ifconfig.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -201,14 +204,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, aix, freebsd, darwin
 
 Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini.md

@@ -1,11 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ini"></a>
 
 # 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 +19,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,
@@ -63,16 +71,12 @@ Examples:
       }
     }
 
+<a id="jc.parsers.ini.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -80,14 +84,14 @@ 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:
 
     Dictionary representing the ini file
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iostat"></a>
 
 # jc.parsers.iostat
+
 jc - JSON CLI output utility `iostat` command output parser
 
 Note: `iostat` version 11 and higher include a JSON output option
@@ -15,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iostat', iostat_command_output)
+
+    or
+
     import jc.parsers.iostat
     result = jc.parsers.iostat.parse(iostat_command_output)
 
@@ -157,16 +164,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.iostat.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -174,14 +177,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat_s.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iostat_s"></a>
+
+# jc.parsers.iostat\_s
 
-# jc.parsers.iostat_s
 jc - JSON CLI output utility `iostat` command output streaming parser
 
 > This streaming parser outputs JSON Lines
@@ -13,8 +15,17 @@ Usage (cli):
 
 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 = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())    # result is an iterable object
+    # result is an iterable object (generator)
+    result = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())
     for item in result:
         # do something
 
@@ -71,9 +82,12 @@ Schema:
       "percent_util":     float,
       "percent_rrqm":     float,
       "percent_wrqm":     float,
-      "_jc_meta":                      # This object only exists if using -qq or ignore_exceptions=True
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
         {
-          "success":      booean,      # true if successfully parsed, false if error
+          "success":      boolean,     # false if error parsing
           "error":        string,      # exists if "success" is false
           "line":         string       # exists if "success" is false
         }
@@ -82,33 +96,31 @@ Schema:
 Examples:
 
     $ iostat | jc --iostat-s
-    {"percent_user":0.14,"percent_nice":0.0,"percent_system":0.16,"percent_iowait":0.0,"percent_steal":0.0,"percent_idle":99.7,"type":"cpu"}
-    {"device":"sda","tps":0.24,"kb_read_s":5.28,"kb_wrtn_s":1.1,"kb_read":203305,"kb_wrtn":42368,"type":"device"}
+    {"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","percent_iowait":"0.00","percent_steal":"0.00","percent_idle":"99.70","type":"cpu"}
-    {"device":"sda","tps":"0.24","kb_read_s":"5.28","kb_wrtn_s":"1.10","kb_read":"203305","kb_wrtn":"42368","type":"device"}
+    {"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"...}
     ...
 
+<a id="jc.parsers.iostat_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False, ignore_exceptions=False)
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
 ```
 
 Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
-    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
-    raw:               (boolean)   output preprocessed JSON if True
+    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
 
@@ -120,7 +132,7 @@ Returns:
 
     Iterator object
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iptables.md

@@ -1,7 +1,9 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iptables"></a>
 
 # 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 +17,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)
 
@@ -161,16 +168,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.iptables.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -178,14 +181,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iw_scan.md

@@ -1,9 +1,12 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iw_scan"></a>
+
+# jc.parsers.iw\_scan
 
-# 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 +18,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
       }
@@ -118,16 +126,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.iw_scan.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -135,14 +139,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 0.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/jar_manifest.md

@@ -0,0 +1,108 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.jar_manifest"></a>
+
+# 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",
+        ...
+      }
+      ...
+    ]
+
+<a id="jc.parsers.jar_manifest.parse"></a>
+
+### parse
+
+```python
+def 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

@@ -1,11 +1,14 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.jobs"></a>
 
 # jc.parsers.jobs
+
 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.
+The "Magic" syntax is not supported since the `jobs` command is a shell
+builtin.
 
 Usage (cli):
 
@@ -13,6 +16,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('jobs', jobs_command_output)
+
+    or
+
     import jc.parsers.jobs
     result = jc.parsers.jobs.parse(jobs_command_output)
 
@@ -90,16 +98,12 @@ Example:
       }
     ]
 
+<a id="jc.parsers.jobs.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -107,14 +111,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/kv.md

@@ -1,11 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.kv"></a>
 
 # 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 +19,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,
@@ -46,16 +58,12 @@ Examples:
       "occupation": "Engineer"
     }
 
+<a id="jc.parsers.kv.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -65,14 +73,14 @@ 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:
 
     Dictionary representing the key/value file
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/last.md

@@ -1,11 +1,15 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.last"></a>
 
 # jc.parsers.last
+
 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 +21,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 +39,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
       }
     ]
 
@@ -100,17 +109,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.last.parse"></a>
 
+### parse
 
-## info
 ```python
-info()
-```
-Provides parser metadata (version, author, etc.)
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -118,14 +122,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls.md

@@ -1,17 +1,25 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ls"></a>
 
 # jc.parsers.ls
+
 jc - JSON CLI output utility `ls` and `vdir` command output parser
 
 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 +31,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 +51,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
@@ -104,16 +121,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.ls.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -121,14 +134,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls_s.md

@@ -1,17 +1,24 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ls_s"></a>
 
-# jc.parsers.ls_s
-jc - JSON CLI output utility `ls` and `vdir` command output streaming parser
+# 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`.
+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 `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` 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):
 
@@ -19,8 +26,17 @@ Usage (cli):
 
 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 = jc.parsers.ls_s.parse(ls_command_output.splitlines())    # result is an iterable object
+    # result is an iterable object (generator)
+    result = jc.parsers.ls_s.parse(ls_command_output.splitlines())
     for item in result:
         # do something
 
@@ -35,48 +51,53 @@ 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
-      "_jc_meta":                    # This object only exists if using -qq or ignore_exceptions=True
+      "epoch":          integer,     # [0]
+      "epoch_utc":      integer,     # [1]
+
+      # Below object only exists if using -qq or ignore_exceptions=True
+
+      "_jc_meta":
         {
-          "success":    booean,      # true if successfully parsed, false if error
+          "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","group":"wheel","size":925,"date":"Feb 22 2019"}
-    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/Python.framework/Versions/2.7/bin/2to3-2.7","flags":"lrwxr-xr-x","links":1,"owner":"root","group":"wheel","size":74,"date":"May 4 2019"}
-    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":1,"owner":"root","group":"wheel","size":55152,"date":"May 3 2019"}
+    {"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":"root","group":"wheel","size":"925","date":"Feb 22 2019"}
-    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/Python.framework/Versions/2.7/bin/2to3-2.7","flags":"lrwxr-xr-x","links":"1","owner":"root","group":"wheel","size":"74","date":"May 4 2019"}
-    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":"1","owner":"root","group":"wheel","size":"55152","date":"May 3 2019"}
+    {"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...}
     ...
 
+<a id="jc.parsers.ls_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False, ignore_exceptions=False)
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
 ```
 
 Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
-    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
-    raw:               (boolean)   output preprocessed JSON if True
+    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
 
@@ -88,7 +109,7 @@ Returns:
 
     Iterator object
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsblk.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsblk"></a>
 
 # jc.parsers.lsblk
+
 jc - JSON CLI output utility `lsblk` command output parser
 
 Usage (cli):
@@ -13,6 +15,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 +95,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 +187,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",
@@ -266,16 +279,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.lsblk.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -283,14 +292,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsmod.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsmod"></a>
 
 # jc.parsers.lsmod
+
 jc - JSON CLI output utility `lsmod` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -123,16 +130,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.lsmod.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -140,14 +143,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsof.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsof"></a>
 
 # jc.parsers.lsof
+
 jc - JSON CLI output utility `lsof` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -117,16 +124,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.lsof.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -134,14 +137,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsusb.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsusb"></a>
 
 # jc.parsers.lsusb
+
 jc - JSON CLI output utility `lsusb` command output parser
 
 Supports the `-v` option or no options.
@@ -15,13 +17,19 @@ Usage (cli):
 
 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.
+    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.
 
     [
       {
@@ -258,16 +266,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.lsusb.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -275,14 +279,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mount.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mount"></a>
 
 # jc.parsers.mount
+
 jc - JSON CLI output utility `mount` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -73,16 +80,12 @@ Example:
       ...
     ]
 
+<a id="jc.parsers.mount.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -90,14 +93,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/netstat.md

@@ -1,11 +1,14 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.netstat"></a>
 
 # jc.parsers.netstat
+
 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 +20,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)
 
@@ -352,16 +360,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.netstat.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -369,14 +373,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ntpq.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ntpq"></a>
 
 # jc.parsers.ntpq
+
 jc - JSON CLI output utility `ntpq -p` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -204,16 +211,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.ntpq.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -221,14 +224,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/passwd.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.passwd"></a>
 
 # jc.parsers.passwd
+
 jc - JSON CLI output utility `/etc/passwd` file Parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -92,16 +99,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.passwd.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -109,14 +112,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping.md

@@ -1,13 +1,16 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ping"></a>
 
 # jc.parsers.ping
+
 jc - JSON CLI output utility `ping` command output parser
 
 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 +20,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 +34,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,8 +46,8 @@ Schema:
       "round_trip_ms_stddev":        float,
       "responses": [
         {
-          "type":                    string,        # 'reply', 'timeout', 'unparsable_line', etc. See `_error_type.type_map` for all options
-          "unparsed_line":           string,        # only if an 'unparsable_line' type
+          "type":                    string,        # [0]
+          "unparsed_line":           string,        # [1]
           "timestamp":               float,
           "bytes":                   integer,
           "response_ip":             string,
@@ -47,21 +55,26 @@ Schema:
           "ttl":                     integer,
           "time_ms":                 float,
           "duplicate":               boolean,
-          "vr":                      integer,       # hex value converted to decimal
-          "hl":                      integer,       # hex value converted to decimal
-          "tos":                     integer,       # hex value converted to decimal
-          "len":                     integer,       # hex value converted to decimal
-          "id":                      integer,       # hex value converted to decimal
-          "flg":                     integer,       # hex value converted to decimal
-          "off":                     integer,       # hex value converted to decimal
-          "pro":                     integer,       # hex value converted to decimal
-          "cks":                     ingeger,       # hex value converted to decimal
+          "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
@@ -154,16 +167,12 @@ Examples:
       ]
     }
 
+<a id="jc.parsers.ping.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -171,14 +180,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping_s.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ping_s"></a>
+
+# jc.parsers.ping\_s
 
-# jc.parsers.ping_s
 jc - JSON CLI output utility `ping` command output streaming parser
 
 > This streaming parser outputs JSON Lines
@@ -11,79 +13,97 @@ 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.
+> 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 = jc.parsers.ping_s.parse(ping_command_output.splitlines())    # result is an iterable object
+    # 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,        # 'reply', 'timeout', 'summary', etc. See `_error_type.type_map` for all options.
-      "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,
-      "_jc_meta":                                  # This object only exists if using -qq or ignore_exceptions=True
+      "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":                 booean,       # true if successfully parsed, false if error
-          "error":                   string,       # exists if "success" is false
-          "line":                    string        # exists if "success" is false
+          "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,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":0,"ttl":56,"time_ms":23.703}
-    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":1,"ttl":56,"time_ms":22.862}
-    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":2,"ttl":56,"time_ms":22.82}
+    {"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","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"0","ttl":"56","time_ms":"23.054"}
-    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"1","ttl":"56","time_ms":"24.739"}
-    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"2","ttl":"56","time_ms":"23.232"}
+    {"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...}
     ...
 
+<a id="jc.parsers.ping_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False, ignore_exceptions=False)
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
 ```
 
 Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
-    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
-    raw:               (boolean)   output preprocessed JSON if True
+    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
 
@@ -95,7 +115,7 @@ Returns:
 
     Iterator object
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_list.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pip_list"></a>
+
+# jc.parsers.pip\_list
 
-# jc.parsers.pip_list
 jc - JSON CLI output utility `pip-list` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -45,16 +52,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.pip_list.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -62,14 +65,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_show.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pip_show"></a>
+
+# jc.parsers.pip\_show
 
-# jc.parsers.pip_show
 jc - JSON CLI output utility `pip-show` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -63,16 +70,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.pip_show.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -80,14 +83,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ps.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ps"></a>
 
 # jc.parsers.ps
+
 jc - JSON CLI output utility `ps` command output parser
 
 `ps` options supported:
@@ -17,6 +19,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 +63,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 +98,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 +136,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 +180,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",
@@ -204,16 +211,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.ps.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -221,14 +224,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/route.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.route"></a>
 
 # jc.parsers.route
+
 jc - JSON CLI output utility `route` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -106,16 +113,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.route.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -123,14 +126,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/rpm_qi.md

@@ -1,13 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.rpm_qi"></a>
+
+# jc.parsers.rpm\_qi
 
-# jc.parsers.rpm_qi
 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 +23,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 +41,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 +61,9 @@ Schema:
       }
     ]
 
+    [0] naive timestamp
+    [1] Aware timestamp if timezone is UTC
+
 Examples:
 
     $ rpm -qia | jc --rpm-qi -p
@@ -66,7 +78,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 +86,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 +102,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 +111,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 +132,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 +140,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 +152,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,21 +161,17 @@ 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..."
       },
       ...
     ]
 
+<a id="jc.parsers.rpm_qi.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -171,14 +179,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/sfdisk.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.sfdisk"></a>
 
 # jc.parsers.sfdisk
+
 jc - JSON CLI output utility `sfdisk` command output parser
 
 Supports the following `sfdisk` options:
@@ -22,6 +24,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('sfdisk', sfdisk_command_output)
+
+    or
+
     import jc.parsers.sfdisk
     result = jc.parsers.sfdisk.parse(sfdisk_command_output)
 
@@ -53,7 +60,7 @@ Schema:
             "boot":                 boolean,
             "start":                integer,
             "end":                  integer,
-            "size":                 string,    # Note: will be integer when using deprecated -d sfdisk option
+            "size":                 string,    # [0]
             "cyls":                 integer,
             "mib":                  integer,
             "blocks":               integer,
@@ -66,6 +73,8 @@ Schema:
       }
     ]
 
+    [0] will be integer when using deprecated -d sfdisk option
+
 Examples:
 
     # sfdisk -l | jc --sfdisk -p
@@ -75,7 +84,7 @@ Examples:
         "cylinders": 2610,
         "heads": 255,
         "sectors_per_track": 63,
-        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0",
+        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, ...",
         "partitions": [
           {
             "device": "/dev/sda1",
@@ -140,7 +149,7 @@ Examples:
         "cylinders": "2610",
         "heads": "255",
         "sectors_per_track": "63",
-        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0",
+        "units": "cylinders of 8225280 bytes, blocks of 1024 bytes, co...",
         "partitions": [
           {
             "device": "/dev/sda1",
@@ -198,16 +207,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.sfdisk.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -215,14 +220,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/shadow.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.shadow"></a>
 
 # jc.parsers.shadow
+
 jc - JSON CLI output utility `/etc/shadow` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -99,16 +106,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.shadow.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -116,14 +119,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ss.md

@@ -1,9 +1,12 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ss"></a>
 
 # 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 +18,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
 
     [
       {
@@ -276,16 +285,12 @@ Examples:
         }
       ]
 
+<a id="jc.parsers.ss.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -293,14 +298,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/stat.md

@@ -1,11 +1,15 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.stat"></a>
 
 # 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 +21,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)
 
@@ -166,16 +175,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.stat.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -183,14 +188,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/stat_s.md

@@ -0,0 +1,119 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.stat_s"></a>
+
+# 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...}
+
+<a id="jc.parsers.stat_s.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterator object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   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

@@ -1,9 +1,14 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.sysctl"></a>
 
 # 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 +20,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
     }
@@ -52,16 +62,12 @@ Examples:
       ...
     }
 
+<a id="jc.parsers.sysctl.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -69,14 +75,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.systemctl"></a>
 
 # jc.parsers.systemctl
+
 jc - JSON CLI output utility `systemctl` command output parser
 
 Usage (cli):
@@ -13,6 +15,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 +44,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",
@@ -56,16 +63,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.systemctl.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -73,14 +76,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_lj.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.systemctl_lj"></a>
+
+# jc.parsers.systemctl\_lj
 
-# jc.parsers.systemctl_lj
 jc - JSON CLI output utility `systemctl list-jobs` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -73,16 +80,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.systemctl_lj.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -90,14 +93,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_ls.md

@@ -1,7 +1,10 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.systemctl_ls"></a>
 
-# jc.parsers.systemctl_ls
-jc - JSON CLI output utility `systemctl list-sockets` command output parser
+# jc.parsers.systemctl\_ls
+
+jc - JSON CLI output utility `systemctl list-sockets` command output
+parser
 
 Usage (cli):
 
@@ -13,6 +16,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)
 
@@ -48,16 +56,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.systemctl_ls.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -65,14 +69,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systemctl_luf.md

@@ -1,7 +1,10 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.systemctl_luf"></a>
 
-# jc.parsers.systemctl_luf
-jc - JSON CLI output utility `systemctl list-unit-files` command output parser
+# jc.parsers.systemctl\_luf
+
+jc - JSON CLI output utility `systemctl list-unit-files` command output
+parser
 
 Usage (cli):
 
@@ -13,6 +16,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)
 
@@ -44,16 +52,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.systemctl_luf.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -61,14 +65,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/systeminfo.md

@@ -1,13 +1,19 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.systeminfo"></a>
 
 # jc.parsers.systeminfo
+
 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 +21,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 +42,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 +91,9 @@ Schema:
       }
     }
 
+    [0] naive timestamp
+    [1] timezone-aware timestamp
+
 Examples:
 
     $ systeminfo | jc --systeminfo -p
@@ -102,9 +116,9 @@ Examples:
         "Intel64 Family 6 Model 158 Stepping 10 GenuineIntel ~2592 Mhz"
       ],
       "bios_version": "Dell Inc. 1.16.2, 4/21/2020",
-      "windows_directory": "C:\WINDOWS",
-      "system_directory": "C:\WINDOWS\system32",
-      "boot_device": "\Device\HarddiskVolume2",
+      "windows_directory": "C:\\WINDOWS",
+      "system_directory": "C:\\WINDOWS\\system32",
+      "boot_device": "\\Device\\HarddiskVolume2",
       "system_locale": "en-us;English (United States)",
       "input_locale": "en-us;English (United States)",
       "time_zone": "(UTC+00:00) UTC",
@@ -113,9 +127,9 @@ Examples:
       "virtual_memory_max_size_mb": 37367,
       "virtual_memory_available_mb": 22266,
       "virtual_memory_in_use_mb": 15101,
-      "page_file_locations": "C:\pagefile.sys",
+      "page_file_locations": "C:\\pagefile.sys",
       "domain": "test.com",
-      "logon_server": "\\TESTDC01",
+      "logon_server": "\\\\TESTDC01",
       "hotfixs": [
         "KB2693643",
         "KB4601054"
@@ -164,9 +178,9 @@ Examples:
         "Intel64 Family 6 Model 158 Stepping 10 GenuineIntel ~2592 Mhz"
       ],
       "bios_version": "Dell Inc. 1.16.2, 4/21/2020",
-      "windows_directory": "C:\WINDOWS",
-      "system_directory": "C:\WINDOWS\system32",
-      "boot_device": "\Device\HarddiskVolume2",
+      "windows_directory": "C:\\WINDOWS",
+      "system_directory": "C:\\WINDOWS\\system32",
+      "boot_device": "\\Device\\HarddiskVolume2",
       "system_locale": "en-us;English (United States)",
       "input_locale": "en-us;English (United States)",
       "time_zone": "(UTC+00:00) UTC",
@@ -175,9 +189,9 @@ Examples:
       "virtual_memory_max_size_mb": "37,367 MB",
       "virtual_memory_available_mb": "22,266 MB",
       "virtual_memory_in_use_mb": "15,101 MB",
-      "page_file_locations": "C:\pagefile.sys",
+      "page_file_locations": "C:\\pagefile.sys",
       "domain": "test.com",
-      "logon_server": "\\TESTDC01",
+      "logon_server": "\\\\TESTDC01",
       "hotfixs": [
         "KB2693643",
         "KB4601054"
@@ -202,16 +216,12 @@ Examples:
       }
     }
 
+<a id="jc.parsers.systeminfo.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -219,14 +229,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  win32
 
 Version 1.1 by Jon Smith (jon@rebelliondefense.com)

docs/parsers/time.md

@@ -1,20 +1,31 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.time"></a>
 
 # 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 +50,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 +71,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 +109,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",
@@ -121,16 +137,12 @@ Examples:
       "exit_status": "0"
     }
 
+<a id="jc.parsers.time.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -138,14 +150,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/timedatectl.md

@@ -1,9 +1,12 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.timedatectl"></a>
 
 # 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 +18,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 +31,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,
@@ -61,16 +69,12 @@ Examples:
       "dst_active": "yes"
     }
 
+<a id="jc.parsers.timedatectl.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -78,14 +82,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/tracepath.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.tracepath"></a>
 
 # jc.parsers.tracepath
+
 jc - JSON CLI output utility `tracepath` command output parser
 
 Supports `tracepath` and `tracepath6` output.
@@ -15,6 +17,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)
 
@@ -129,16 +136,12 @@ Examples:
       ]
     }
 
+<a id="jc.parsers.tracepath.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -146,14 +149,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/traceroute.md

@@ -1,13 +1,18 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.traceroute"></a>
 
 # jc.parsers.traceroute
+
 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 +24,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)
 
@@ -115,16 +125,12 @@ Examples:
       ]
     }
 
+<a id="jc.parsers.traceroute.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -132,14 +138,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ufw.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ufw"></a>
 
 # jc.parsers.ufw
+
 jc - JSON CLI output utility `ufw status` command output parser
 
 Usage (cli):
@@ -13,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ufw', ufw_command_output)
+
+    or
+
     import jc.parsers.ufw
     result = jc.parsers.ufw.parse(ufw_command_output)
 
@@ -43,7 +50,7 @@ Schema:
               "end":                integer
             }
           ],
-          "to_service":             string,     # null if any to ports or port_ranges are set
+          "to_service":             string,     # [0]
           "from_ip":                string,
           "from_ip_prefix":         integer,
           "from_interface":         string,
@@ -57,12 +64,15 @@ Schema:
               "end":                integer
             }
           ],
-          "from_service":           string,     # null if any from ports or port_ranges are set
+          "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
@@ -195,16 +205,12 @@ Examples:
       ]
     }
 
+<a id="jc.parsers.ufw.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -212,14 +218,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ufw_appinfo.md

@@ -1,11 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ufw_appinfo"></a>
 
-# jc.parsers.ufw_appinfo
-jc - JSON CLI output utility `ufw app info [application]` command output parser
+# jc.parsers.ufw\_appinfo
 
-Supports individual apps via `ufw app info [application]` and all apps list via `ufw app info all`.
+jc - JSON CLI output utility `ufw app info [application]` command
+output parser
 
-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.
+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):
 
@@ -17,6 +23,11 @@ Usage (cli):
 
 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)
 
@@ -32,7 +43,7 @@ Schema:
         ],
         "tcp_ranges": [
           {
-            "start":                integer,      # 'any' is converted to start/end: 0/65535
+            "start":                integer,      # [0]
             "end":                  integer
           }
         ],
@@ -41,31 +52,35 @@ Schema:
         ],
         "udp_ranges": [
           {
-            "start":                integer,      # 'any' is converted to start/end: 0/65535
+            "start":                integer,      # [0]
             "end":                  integer
           }
         ],
         "normalized_tcp_list": [
-                                    integers      # duplicates and overlapping are removed
+                                    integers      # [1]
         ],
         "normalized_tcp_ranges": [
           {
-            "start":                integer,      # 'any' is converted to start/end: 0/65535
-            "end":                  integers      # overlapping are merged
+            "start":                integer,      # [0]
+            "end":                  integers      # [2]
           }
         ],
         "normalized_udp_list": [
-                                    integers      # duplicates and overlapping are removed
+                                    integers      # [1]
         ],
         "normalized_udp_ranges": [
           {
-            "start":                integer,      # 'any' is converted to start/end: 0/65535
-            "end":                  integers      # overlapping are merged
+            "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
@@ -128,16 +143,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.ufw_appinfo.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -145,14 +156,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/uname.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.uname"></a>
 
 # jc.parsers.uname
+
 jc - JSON CLI output utility `uname -a` command output parser
 
 Note: Must use `uname -a`
@@ -15,6 +17,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)
 
@@ -45,16 +52,12 @@ Example:
       "kernel_version": "#74-Ubuntu SMP Tue Sep 17 17:06:04 UTC 2019"
     }
 
+<a id="jc.parsers.uname.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -62,14 +65,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, freebsd
 
 Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/universal.md

@@ -0,0 +1,70 @@
+# Table of Contents
+
+* [jc.parsers.universal](#jc.parsers.universal)
+  * [simple\_table\_parse](#jc.parsers.universal.simple_table_parse)
+  * [sparse\_table\_parse](#jc.parsers.universal.sparse_table_parse)
+
+<a id="jc.parsers.universal"></a>
+
+# jc.parsers.universal
+
+jc - JSON CLI output utility universal Parsers
+
+<a id="jc.parsers.universal.simple_table_parse"></a>
+
+### simple\_table\_parse
+
+```python
+def simple_table_parse(data: List[str]) -> List[Dict]
+```
+
+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
+
+<a id="jc.parsers.universal.sparse_table_parse"></a>
+
+### sparse\_table\_parse
+
+```python
+def sparse_table_parse(data: List[str], delim: Optional[str] = '\u2063') -> List[Dict]
+```
+
+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

@@ -1,11 +1,15 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.upower"></a>
 
 # 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 +21,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 +38,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 +91,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 +157,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",
@@ -192,16 +203,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.upower.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -209,14 +216,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/uptime.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.uptime"></a>
 
 # jc.parsers.uptime
+
 jc - JSON CLI output utility `uptime` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -63,16 +70,12 @@ Example:
       "load_15m": "1.94"
     }
 
+<a id="jc.parsers.uptime.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -80,14 +83,14 @@ 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:
 
     Dictionary. Raw or processed structured data
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/vmstat.md

@@ -1,13 +1,17 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.vmstat"></a>
 
 # 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` 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):
 
@@ -19,6 +23,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('vmstat', vmstat_command_output)
+
+    or
+
     import jc.parsers.vmstat
     result = jc.parsers.vmstat.parse(vmstat_command_output)
 
@@ -58,11 +67,14 @@ Schema:
         "io_seconds":                        integer,
         "timestamp":                         string,
         "timezone":                          string,
-        "epoch":                             integer,     # naive timestamp if -t flag is used
-        "epoch_utc":                         integer      # aware timestamp if -t flag is used and UTC TZ
+        "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
@@ -119,16 +131,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.vmstat.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -136,14 +144,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/vmstat_s.md

@@ -1,102 +1,126 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.vmstat_s"></a>
+
+# jc.parsers.vmstat\_s
 
-# 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` 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):
 
     $ 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.
+> 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 = jc.parsers.vmstat_s.parse(vmstat_command_output.splitlines())    # result is an iterable object
+    # 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,     # naive timestamp if -t flag is used
-      "epoch_utc":                         integer      # aware timestamp if -t flag is used and UTC TZ
-      "_jc_meta":                                       # This object only exists if using -qq or ignore_exceptions=True
+      "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":                       booean,      # true if successfully parsed, false if error
-          "error":                         string,      # exists if "success" is false
-          "line":                          string       # exists if "success" is false
+          "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_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}
+    {"runnable_procs":2,"uninterruptible_sleeping_procs":0,"virtual_mem...}
     ...
 
     $ vmstat | jc --vmstat-s -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}
+    {"runnable_procs":"2","uninterruptible_sleeping_procs":"0","virtua...}
     ...
 
+<a id="jc.parsers.vmstat_s.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False, ignore_exceptions=False)
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
 ```
 
 Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
-    data:              (iterable)  line-based text data to parse (e.g. sys.stdin or str.splitlines())
-    raw:               (boolean)   output preprocessed JSON if True
+    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
 
@@ -108,7 +132,7 @@ Returns:
 
     Iterator object
 
-## Parser Information
+### Parser Information
 Compatibility:  linux
 
 Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/w.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.w"></a>
 
 # jc.parsers.w
+
 jc - JSON CLI output utility `w` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -101,16 +108,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.w.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -118,14 +121,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/wc.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.wc"></a>
 
 # jc.parsers.wc
+
 jc - JSON CLI output utility `wc` command output parser
 
 Usage (cli):
@@ -13,6 +15,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)
 
@@ -52,16 +59,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.wc.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -69,14 +72,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/who.md

@@ -1,11 +1,14 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.who"></a>
 
 # jc.parsers.who
+
 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 +20,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 +37,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 +45,8 @@ Schema:
       }
     ]
 
+    [0] naive timestamp. null if time cannot be converted
+
 Examples:
 
     $ who -a | jc --who -p
@@ -130,16 +140,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.who.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -147,14 +153,14 @@ 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:
 
     List of Dictionaries. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 
 Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/xml.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.xml"></a>
 
 # jc.parsers.xml
+
 jc - JSON CLI output utility `XML` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -68,16 +75,12 @@ Examples:
       ...
     }
 
+<a id="jc.parsers.xml.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -85,14 +88,14 @@ 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:
 
     Dictionary. Raw or processed structured data.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/yaml.md

@@ -1,6 +1,8 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.yaml"></a>
 
 # jc.parsers.yaml
+
 jc - JSON CLI output utility `YAML` file parser
 
 Usage (cli):
@@ -9,6 +11,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)
 
@@ -82,16 +89,12 @@ Examples:
       }
     ]
 
+<a id="jc.parsers.yaml.parse"></a>
 
-## info
-```python
-info()
-```
-Provides parser metadata (version, author, etc.)
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -99,14 +102,14 @@ 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:
 
     List of Dictionaries representing the YAML documents.
 
-## Parser Information
+### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
 Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/zipinfo.md

@@ -0,0 +1,110 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.zipinfo"></a>
+
+# 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"
+          },
+    ...
+
+<a id="jc.parsers.zipinfo.parse"></a>
+
+### parse
+
+```python
+def 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

@@ -1,75 +1,83 @@
+<a id="jc"></a>
 
 # jc
+
 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 converts the output of many standard unix command line tools
+and file-types 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.utils')
+    >>> 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
 
-    >>> import jc.parsers.dig
+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
     >>>
-    >>> cmd_output = subprocess.check_output(['dig', 'example.com'], text=True)
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
     >>> data = jc.parsers.dig.parse(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.',
-    '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}]
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
+
+## Available Functions
+
+Use `help(jc.lib)` for details:
+
+    parse(parser_module_name: str, data: str | Iterable)
+      -> dict | list[dict] | Iterable[dict]
+        High-level API to easily access the parser. This API will find both
+        built-in parsers and local plugin parsers.
+
+    parser_info(parser_module_name: str) -> dict
+        Get the metadata for a particular parser.
+
+    all_parser_info() -> list[dict]
+        Get the metadata for all parsers.
+
+    get_help(parser_module_name: str) -> None
+        Convenience function to display the help screen for a parser using
+        its module name.
+
+    parser_mod_list() -> list
+        Get a list of all available parser module names to be used in
+        parse(), parser_info(), and get_help().
+
+    plugin_parser_mod_list() -> list
+        Get a list of plugin parser module names to be used in
+        parse(), parser_info(), and get_help(). This list is a subset of
+        parser_mod_list().
 

docs/utils.md

@@ -1,15 +1,38 @@
+# Table of Contents
+
+* [jc.utils](#jc.utils)
+  * [warning\_message](#jc.utils.warning_message)
+  * [error\_message](#jc.utils.error_message)
+  * [compatibility](#jc.utils.compatibility)
+  * [has\_data](#jc.utils.has_data)
+  * [convert\_to\_int](#jc.utils.convert_to_int)
+  * [convert\_to\_float](#jc.utils.convert_to_float)
+  * [convert\_to\_bool](#jc.utils.convert_to_bool)
+  * [stream\_success](#jc.utils.stream_success)
+  * [stream\_error](#jc.utils.stream_error)
+  * [input\_type\_check](#jc.utils.input_type_check)
+  * [streaming\_input\_type\_check](#jc.utils.streaming_input_type_check)
+  * [streaming\_line\_input\_type\_check](#jc.utils.streaming_line_input_type_check)
+  * [timestamp](#jc.utils.timestamp)
+    * [\_\_init\_\_](#jc.utils.timestamp.__init__)
+
+<a id="jc.utils"></a>
+
+# jc.utils
 
-# utils
 jc - JSON CLI output utility utils
 
-## warning_message
+<a id="jc.utils.warning_message"></a>
+
+### warning\_message
+
 ```python
-warning_message(message_lines)
+def warning_message(message_lines: List[str]) -> None
 ```
 
-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.
+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:
 
@@ -19,15 +42,17 @@ Returns:
 
     None - just prints output to STDERR
 
+<a id="jc.utils.error_message"></a>
+
+### error\_message
 
-## error_message
 ```python
-error_message(message_lines)
+def error_message(message_lines: List[str]) -> None
 ```
 
-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.
+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:
 
@@ -37,34 +62,41 @@ Returns:
 
     None - just prints output to STDERR
 
+<a id="jc.utils.compatibility"></a>
+
+### compatibility
 
-## compatibility
 ```python
-compatibility(mod_name, compatible, quiet=False)
+def compatibility(mod_name: str, compatible: List, quiet: Optional[bool] = False) -> None
 ```
-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
+    quiet:        (bool) supress compatibility message if True
 
 Returns:
 
     None - just prints output to STDERR
 
+<a id="jc.utils.has_data"></a>
+
+### has\_data
 
-## has_data
 ```python
-has_data(data)
+def has_data(data: str) -> bool
 ```
 
-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:
 
@@ -72,15 +104,57 @@ 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
 
+<a id="jc.utils.convert_to_int"></a>
+
+### convert\_to\_int
 
-## convert_to_int
 ```python
-convert_to_int(value)
+def convert_to_int(value: Union[str, float]) -> Union[int, None]
 ```
 
-Converts string and float input to int. Strips all non-numeric characters from strings.
+Converts string and float input to int. Strips all non-numeric
+characters from strings.
+
+Parameters:
+
+    value:         (string/float) Input value
+
+Returns:
+
+    integer/None   Integer if successful conversion, otherwise None
+
+<a id="jc.utils.convert_to_float"></a>
+
+### convert\_to\_float
+
+```python
+def convert_to_float(value: Union[str, int]) -> Union[float, None]
+```
+
+Converts string and int input to float. Strips all non-numeric
+characters from strings.
+
+Parameters:
+
+    value:         (string/integer) Input value
+
+Returns:
+
+    float/None     Float if successful conversion, otherwise None
+
+<a id="jc.utils.convert_to_bool"></a>
+
+### convert\_to\_bool
+
+```python
+def convert_to_bool(value: Union[str, int, float]) -> bool
+```
+
+Converts string, integer, or float input to boolean by checking
+for 'truthy' values.
 
 Parameters:
 
@@ -88,88 +162,97 @@ Parameters:
 
 Returns:
 
-    integer/None    Integer if successful conversion, otherwise None
+    True/False      False unless a 'truthy' number or string is found
+                    ('y', 'yes', 'true', '1', 1, -1, etc.)
 
+<a id="jc.utils.stream_success"></a>
+
+### stream\_success
 
-## convert_to_float
 ```python
-convert_to_float(value)
+def stream_success(output_line: Dict, ignore_exceptions: bool) -> Dict
 ```
 
-Converts string and int input to float. Strips all non-numeric characters from strings.
-
-Parameters:
-
-    value:          (string) Input value
-
-Returns:
-
-    float/None      Float if successful conversion, otherwise None
-
-
-## convert_to_bool
-```python
-convert_to_bool(value)
-```
-
-Converts string, integer, or float input to boolean by checking for 'truthy' values
-
-Parameters:
-
-    value:          (string/integer/float) Input value
-
-Returns:
-
-    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`
+<a id="jc.utils.stream_error"></a>
 
+### stream\_error
 
-## 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)
+def stream_error(e: BaseException, ignore_exceptions: bool, line: str) -> Dict
 ```
 
-Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC
+Reraise the stream exception with annotation or print an error
+`_jc_meta` field if `ignore_exceptions=True`.
+
+<a id="jc.utils.input_type_check"></a>
+
+### input\_type\_check
+
+```python
+def input_type_check(data: str) -> None
+```
+
+Ensure input data is a string. Raises `TypeError` if not.
+
+<a id="jc.utils.streaming_input_type_check"></a>
+
+### streaming\_input\_type\_check
+
+```python
+def streaming_input_type_check(data: Iterable) -> None
+```
+
+Ensure input data is an iterable, but not a string or bytes. Raises
+`TypeError` if not.
+
+<a id="jc.utils.streaming_line_input_type_check"></a>
+
+### streaming\_line\_input\_type\_check
+
+```python
+def streaming_line_input_type_check(line: str) -> None
+```
+
+Ensure each line is a string. Raises `TypeError` if not.
+
+<a id="jc.utils.timestamp"></a>
+
+### timestamp Objects
+
+```python
+class timestamp()
+```
+
+<a id="jc.utils.timestamp.__init__"></a>
+
+### \_\_init\_\_
+
+```python
+def __init__(datetime_string: str) -> None
+```
+
+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. 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
+    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,75 +2,80 @@
 
 * kellyjonbrazil@gmail.com
 
-This package serializes the output of many standard unix command line tools to JSON format.
+This package converts the output of many standard unix command line tools
+and file-types 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.utils')
+    >>> 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
 
-    >>> import jc.parsers.dig
+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
     >>>
-    >>> cmd_output = subprocess.check_output(['dig', 'example.com'], text=True)
+    >>> cmd_output = subprocess.check_output(['dig', 'example.com'],
+                                             text=True)
     >>> data = jc.parsers.dig.parse(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.',
-    '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}]
-"""
+    [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
 
-name = 'jc'
-__version__ = '1.17.3'
+## Available Functions
+
+Use `help(jc.lib)` for details:
+
+    parse(parser_module_name: str, data: str | Iterable)
+      -> dict | list[dict] | Iterable[dict]
+        High-level API to easily access the parser. This API will find both
+        built-in parsers and local plugin parsers.
+
+    parser_info(parser_module_name: str) -> dict
+        Get the metadata for a particular parser.
+
+    all_parser_info() -> list[dict]
+        Get the metadata for all parsers.
+
+    get_help(parser_module_name: str) -> None
+        Convenience function to display the help screen for a parser using
+        its module name.
+
+    parser_mod_list() -> list
+        Get a list of all available parser module names to be used in
+        parse(), parser_info(), and get_help().
+
+    plugin_parser_mod_list() -> list
+        Get a list of plugin parser module names to be used in
+        parse(), parser_info(), and get_help(). This list is a subset of
+        parser_mod_list().
+"""
+from .lib import (__version__, parse, parser_mod_list, plugin_parser_mod_list,
+                  parser_info, all_parser_info, get_help)

jc/cli.py

@@ -4,19 +4,17 @@ JC cli module
 
 import sys
 import os
-import os.path
-import re
 import importlib
 import textwrap
 import signal
 import shlex
 import subprocess
 import json
-import jc
-from jc import appdirs
-import jc.utils
-import jc.tracebackplus
-from jc.exceptions import LibraryNotInstalled, ParseError
+from .lib import (__version__, all_parser_info, parsers,
+                  _parser_argument, _get_parser)
+from . import utils
+from . import tracebackplus
+from .exceptions import LibraryNotInstalled, ParseError
 
 # make pygments import optional
 try:
@@ -31,121 +29,19 @@ except Exception:
     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',
-    'csv-s',
-    'date',
-    'df',
-    'dig',
-    'dir',
-    'dmidecode',
-    'dpkg-l',
-    'du',
-    'env',
-    'file',
-    'finger',
-    'free',
-    'fstab',
-    'group',
-    'gshadow',
-    'hash',
-    'hashsum',
-    'hciconfig',
-    'history',
-    'hosts',
-    'id',
-    'ifconfig',
-    'ini',
-    'iostat',
-    'iostat-s',
-    'iptables',
-    'iw-scan',
-    'jobs',
-    'kv',
-    'last',
-    'ls',
-    'ls-s',
-    'lsblk',
-    'lsmod',
-    'lsof',
-    'lsusb',
-    'mount',
-    'netstat',
-    'ntpq',
-    'passwd',
-    'ping',
-    'ping-s',
-    'pip-list',
-    'pip-show',
-    'ps',
-    'route',
-    'rpm-qi',
-    'sfdisk',
-    'shadow',
-    'ss',
-    'stat',
-    'sysctl',
-    'systemctl',
-    'systemctl-lj',
-    'systemctl-ls',
-    'systemctl-luf',
-    'systeminfo',
-    'time',
-    'timedatectl',
-    'tracepath',
-    'traceroute',
-    'ufw',
-    'ufw-appinfo',
-    'uname',
-    'upower',
-    'uptime',
-    'vmstat',
-    'vmstat-s',
-    'w',
-    'wc',
-    'who',
-    'xml',
-    'yaml'
-]
-
-JC_ERROR_EXIT = 100
-
-
-# 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:
@@ -223,7 +119,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
@@ -235,9 +131,11 @@ def set_env_colors(env_colors=None):
     }
 
 
-def piped_output():
-    """Return False if stdout is a TTY. True if output is being piped to another program"""
-    return not sys.stdout.isatty()
+def piped_output(force_color):
+    """Return False if stdout is a TTY. True if output is being piped to another program
+       and foce_color is True. This allows forcing of ANSI color codes even when using pipes.
+    """
+    return not sys.stdout.isatty() and not force_color
 
 
 def ctrlc(signum, frame):
@@ -250,29 +148,12 @@ def parser_shortname(parser_arg):
     return parser_arg[2:]
 
 
-def parser_argument(parser):
-    """Return short name of the parser with dashes and with -- prefix"""
-    return f'--{parser}'
-
-
-def parser_mod_shortname(parser):
-    """Return short name of the parser's module name (no -- prefix and dashes converted to underscores)"""
-    return parser.replace('--', '').replace('-', '_')
-
-
-def parser_module(parser):
-    """Import the module just in time and return the module object"""
-    shortname = parser_mod_shortname(parser)
-    path = ('jcparsers.' if shortname in local_parsers else 'jc.parsers.')
-    return importlib.import_module(path + shortname)
-
-
 def parsers_text(indent=0, pad=0):
     """Return the argument and description information from each parser"""
     ptext = ''
     for parser in parsers:
-        parser_arg = parser_argument(parser)
-        parser_mod = parser_module(parser)
+        parser_arg = _parser_argument(parser)
+        parser_mod = _get_parser(parser)
 
         if hasattr(parser_mod, 'info'):
             parser_desc = parser_mod.info.description
@@ -287,23 +168,6 @@ def parsers_text(indent=0, pad=0):
 
 def about_jc():
     """Return jc info and the contents of each parser.info as a dictionary"""
-    parser_list = []
-
-    for parser in parsers:
-        parser_mod = parser_module(parser)
-
-        if hasattr(parser_mod, 'info'):
-            info_dict = {}
-            info_dict['name'] = parser_mod.__name__.split('.')[-1]
-            info_dict['argument'] = parser_argument(parser)
-            parser_entry = vars(parser_mod.info)
-
-            for k, v in parser_entry.items():
-                if not k.startswith('__'):
-                    info_dict[k] = v
-
-        parser_list.append(info_dict)
-
     return {
         'name': 'jc',
         'version': info.version,
@@ -313,8 +177,8 @@ def about_jc():
         'website': info.website,
         'copyright': info.copyright,
         'license': info.license,
-        'parser_count': len(parser_list),
-        'parsers': parser_list
+        'parser_count': len(all_parser_info()),
+        'parsers': all_parser_info()
     }
 
 
@@ -335,6 +199,7 @@ def helptext():
 {parsers_string}
     Options:
             -a    about jc
+            -C    force color output even when using pipes (overrides -m)
             -d    debug (-dd for verbose debug)
             -h    help (-h --parser_name for parser documentation)
             -m    monochrome output
@@ -366,8 +231,7 @@ def help_doc(options):
         parser_name = parser_shortname(arg)
 
         if parser_name in parsers:
-            # load parser module just in time so we don't need to load all modules
-            parser = parser_module(arg)
+            parser = _get_parser(arg)
             compatible = ', '.join(parser.info.compatible)
             doc_text = \
                 f'{parser.__doc__}\n'\
@@ -526,7 +390,8 @@ def main():
     about = 'a' in options
     debug = 'd' in options
     verbose_debug = options.count('d') > 1
-    mono = 'm' in options
+    force_color = 'C' in options
+    mono = ('m' in options or bool(os.getenv('NO_COLOR'))) and not force_color
     help_me = 'h' in options
     pretty = 'p' in options
     quiet = 'q' in options
@@ -536,13 +401,17 @@ def main():
     version_info = 'v' in options
 
     if verbose_debug:
-        jc.tracebackplus.enable(context=11)
+        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:
@@ -567,34 +436,28 @@ def main():
             if magic_stderr:
                 print(magic_stderr[:-1], file=sys.stderr)
 
-        except FileNotFoundError:
+        except OSError as e:
             if debug:
                 raise
 
-            jc.utils.error_message([f'"{run_command_str}" command could not be found. For details use the -d or -dd option.'])
-            sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
-
-        except OSError:
-            if debug:
-                raise
-
-            jc.utils.error_message([f'"{run_command_str}" command could not be run due to too many open files. For details use the -d or -dd option.'])
+            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))
 
         except Exception:
             if debug:
                 raise
 
-            jc.utils.error_message([f'"{run_command_str}" command could not be run. For details use the -d or -dd option.'])
+            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:
-        jc.utils.error_message([f'"{run_command_str}" cannot be used with Magic syntax. Use "jc -h" for help.'])
+        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 = _get_parser(magic_found_parser)
         parser_name = parser_shortname(magic_found_parser)
 
     else:
@@ -603,21 +466,21 @@ def main():
             parser_name = parser_shortname(arg)
 
             if parser_name in parsers:
-                parser = parser_module(arg)
+                parser = _get_parser(arg)
                 found = True
                 break
 
         if not found:
-            jc.utils.error_message(['Missing or incorrect arguments. Use "jc -h" for help.'])
+            utils.error_message(['Missing or incorrect arguments. Use "jc -h" for help.'])
             sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))
 
     # check for input errors (pipe vs magic)
     if not sys.stdin.isatty() and magic_stdout:
-        jc.utils.error_message(['Piped data and Magic syntax used simultaneously. Use "jc -h" for help.'])
+        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))
 
     elif sys.stdin.isatty() and magic_stdout is None:
-        jc.utils.error_message(['Missing piped data. Use "jc -h" for help.'])
+        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
@@ -632,7 +495,7 @@ def main():
                                pretty=pretty,
                                env_colors=jc_colors,
                                mono=mono,
-                               piped_out=piped_output()),
+                               piped_out=piped_output(force_color)),
                       flush=unbuffer)
 
             sys.exit(combined_exit_code(magic_exit_code, 0))
@@ -645,7 +508,7 @@ def main():
                            pretty=pretty,
                            env_colors=jc_colors,
                            mono=mono,
-                           piped_out=piped_output()),
+                           piped_out=piped_output(force_color)),
                   flush=unbuffer)
 
         sys.exit(combined_exit_code(magic_exit_code, 0))
@@ -654,17 +517,18 @@ def main():
         if debug:
             raise
 
-        jc.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.'])
+        utils.error_message([f'Parser issue with {parser_name}:',
+                             f'{e.__class__.__name__}: {e}',
+                             'If this is the correct parser, try setting the locale to C (LANG=C).',
+                             '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
 
-        jc.utils.error_message(['There was an issue generating the JSON output.',
-                                'For details use the -d or -dd option.'])
+        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:
@@ -675,9 +539,10 @@ def main():
         if getattr(parser.info, 'streaming', None):
             streaming_msg = 'Use the -qq option to ignore streaming parser errors.'
 
-        jc.utils.error_message([
-            f'{parser_name} parser could not parse the input data. Did you use the correct parser?',
+        utils.error_message([
+            f'{parser_name} parser could not parse the input data.',
             f'{streaming_msg}',
+            'If this is the correct parser, try setting the locale to C (LANG=C).',
             'For details use the -d or -dd option. Use "jc -h" for help.'
         ])
         sys.exit(combined_exit_code(magic_exit_code, JC_ERROR_EXIT))

jc/lib.py

@@ -0,0 +1,269 @@
+"""jc - JSON CLI output utility
+JC lib module
+"""
+
+import sys
+import os
+import re
+import importlib
+from typing import Dict, List, Iterable, Union, Iterator, Optional
+from jc import appdirs
+
+__version__ = '1.18.2'
+
+parsers = [
+    'acpi',
+    'airport',
+    'airport-s',
+    'arp',
+    'blkid',
+    'cksum',
+    'crontab',
+    'crontab-u',
+    'csv',
+    'csv-s',
+    'date',
+    'df',
+    'dig',
+    'dir',
+    'dmidecode',
+    'dpkg-l',
+    'du',
+    'env',
+    'file',
+    'finger',
+    'free',
+    'fstab',
+    'group',
+    'gshadow',
+    'hash',
+    'hashsum',
+    'hciconfig',
+    'history',
+    'hosts',
+    'id',
+    'ifconfig',
+    'ini',
+    'iostat',
+    'iostat-s',
+    'iptables',
+    'iw-scan',
+    'jar-manifest',
+    'jobs',
+    'kv',
+    'last',
+    'ls',
+    'ls-s',
+    'lsblk',
+    'lsmod',
+    'lsof',
+    'lsusb',
+    'mount',
+    'netstat',
+    'ntpq',
+    'passwd',
+    'ping',
+    'ping-s',
+    'pip-list',
+    'pip-show',
+    'ps',
+    'route',
+    'rpm-qi',
+    'sfdisk',
+    'shadow',
+    'ss',
+    'stat',
+    'stat-s',
+    'sysctl',
+    'systemctl',
+    'systemctl-lj',
+    'systemctl-ls',
+    'systemctl-luf',
+    'systeminfo',
+    'time',
+    'timedatectl',
+    'tracepath',
+    'traceroute',
+    'ufw',
+    'ufw-appinfo',
+    'uname',
+    'upower',
+    'uptime',
+    'vmstat',
+    'vmstat-s',
+    'w',
+    'wc',
+    'who',
+    'xml',
+    'yaml',
+    'zipinfo'
+]
+
+def _cliname_to_modname(parser_cli_name):
+    """Return real module name (dashes converted to underscores)"""
+    return parser_cli_name.replace('--', '').replace('-', '_')
+
+def _modname_to_cliname(parser_mod_name):
+    """Return module's cli name (underscores converted to dashes)"""
+    return parser_mod_name.replace('_', '-')
+
+# Create the local_parsers list. This is a list of custom or
+# override parsers from <user_data_dir>/jc/jcparsers/*.py.
+# Once this list is created, extend the parsers list with it.
+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(_modname_to_cliname(plugin_name))
+            if plugin_name not in parsers:
+                parsers.append(_modname_to_cliname(plugin_name))
+    try:
+        del name
+    except Exception:
+        pass
+
+def _parser_argument(parser_mod_name):
+    """Return short name of the parser with dashes and with -- prefix"""
+    parser = _modname_to_cliname(parser_mod_name)
+    return f'--{parser}'
+
+def _get_parser(parser_mod_name):
+    """Return the parser module object"""
+    # ensure parser_mod_name is a true module name and not a cli name
+    parser_mod_name = _cliname_to_modname(parser_mod_name)
+
+    parser_cli_name = _modname_to_cliname(parser_mod_name)
+    modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.'
+    return importlib.import_module(f'{modpath}{parser_mod_name}')
+
+def parse(
+    parser_mod_name: str,
+    data: Union[str, Iterable[str]],
+    quiet: bool = False,
+    raw: bool = False,
+    ignore_exceptions: bool = None,
+    **kwargs
+) -> Union[Dict, List[Dict], Iterator[Dict]]:
+    """
+    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. This
+                                         function will accept module_name,
+                                         cli-name, and --argument-name
+                                         variants of the module name.
+
+        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
+    """
+    jc_parser = _get_parser(parser_mod_name)
+
+    if ignore_exceptions is not None:
+        return jc_parser.parse(data, quiet=quiet, raw=raw,
+                               ignore_exceptions=ignore_exceptions, **kwargs)
+
+    return jc_parser.parse(data, quiet=quiet, raw=raw, **kwargs)
+
+def parser_mod_list() -> List[str]:
+    """Returns a list of all available parser module names."""
+    return [_cliname_to_modname(p) for p in parsers]
+
+def plugin_parser_mod_list() -> List[str]:
+    """
+    Returns a list of plugin parser module names. This function is a
+    subset of `parser_mod_list()`.
+    """
+    return [_cliname_to_modname(p) for p in local_parsers]
+
+def parser_info(parser_mod_name: str) -> Union[Dict, None]:
+    """
+    Returns a dictionary that includes the module metadata.
+
+    This function will accept **module_name**, **cli-name**, and
+    **--argument-name** variants of the module name string.
+    """
+    # ensure parser_mod_name is a true module name and not a cli name
+    parser_mod_name = _cliname_to_modname(parser_mod_name)
+
+    parser_mod = _get_parser(parser_mod_name)
+
+    if hasattr(parser_mod, 'info'):
+        info_dict: Dict = {}
+        info_dict['name'] = parser_mod_name
+        info_dict['argument'] = _parser_argument(parser_mod_name)
+        parser_entry = vars(parser_mod.info)
+
+        for k, v in parser_entry.items():
+            if not k.startswith('__'):
+                info_dict[k] = v
+
+        if _modname_to_cliname(parser_mod_name) in local_parsers:
+            info_dict['plugin'] = True
+
+        return info_dict
+
+    return None
+
+def all_parser_info() -> List[Optional[Dict]]:
+    """
+    Returns a list of dictionaris that includes metadata for all modules.
+    """
+    return [parser_info(_cliname_to_modname(p)) for p in parsers]
+
+def get_help(parser_mod_name: str) -> None:
+    """
+    Show help screen for the selected parser.
+
+    This function will accept **module_name**, **cli-name**, and
+    **--argument-name** variants of the module name string.
+    """
+    help(_get_parser(parser_mod_name))

jc/parsers/acpi.py

@@ -10,6 +10,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)
 
@@ -231,8 +236,6 @@ class info():
     description = '`acpi` command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
-
-    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']
     magic_commands = ['acpi']
 
@@ -252,7 +255,8 @@ def _process(proc_data):
 
         List of Dictionaries. Structured data to conform to the schema.
     """
-    int_list = ['id', 'charge_percent', 'design_capacity_mah', 'last_full_capacity', 'last_full_capacity_percent']
+    int_list = ['id', 'charge_percent', 'design_capacity_mah', 'last_full_capacity',
+                'last_full_capacity_percent']
     float_list = ['temperature']
 
     for entry in proc_data:
@@ -295,7 +299,7 @@ def parse(data, raw=False, quiet=False):
     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: