Merge pull request #91 from kellyjonbrazil/dev

Dev v1.14.0

.github/workflows/pythonapp.yml

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

CHANGELOG

@@ -1,7 +1,44 @@
 jc changelog
 
+20201231 v1.14.0
+- Add hashsum parser tested on linux, macos
+- Add hash parser tested on linux, macos
+- Add cksum parser tested on linux, macos
+- Add wc parser tested on linux, macos
+- Add printenv support under env parser
+- Add vdir support under ls parser
+- Add python 3.9 to github automation tests
+
+20200805 v1.13.4
+- Update crontab and crontab-u parsers to tighten up variable detection
+- Update ping parser to tighten linux/bsd detection
+
+20200804 v1.13.3
+- Update ping parser for Raspberry Pi compatibility
+
+20200803 v1.13.2
+- Add key/value file parser (wrapper for ini parser)
+- Add date command parser
+- Update traceroute parser to more gracefully handle missing header row
+- Update traceroute parser to handle annotations
+- Update traceroute parser to only return successful probes
+
+20200727 v1.13.1
+- Add route -6 tests
+
+20200727 v1.13.0
+- Add ping and ping6 command parser tested on linux, macos, and freebsd
+- Add traceroute and traceroute6 command parser tested on linux, macos, and freebsd
+- Add tracepath command parser tested on linux
+- Update ini parser to support files only containing key/value pairs
+- Update uname parser exception with a hint to use "uname -a"
+- Update route parser to support IPv6 tables
+
+20200711 v1.12.1
+- Fix tests when using older version of pygments library
+
 20200710 v1.12.0
-- Add sysctl command parser tested on linux, macOS, and freebsd12
+- Add sysctl command parser tested on linux, macOS, and freebsd
 - Update the cli code to allow older versions of the pygments library (2.3.0) for debian packaging
 - Code cleanup on the cli
 - Add tests for the cli

docgen.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 # Generate docs.md
+# requires pydoc-markdown 2.1.0.post1
 
 cd jc
 pydocmd simple jc+ > ../docs/readme.md
@@ -8,9 +9,11 @@ pydocmd simple jc.parsers.airport+ > ../docs/parsers/airport.md
 pydocmd simple jc.parsers.airport_s+ > ../docs/parsers/airport_s.md
 pydocmd simple jc.parsers.arp+ > ../docs/parsers/arp.md
 pydocmd simple jc.parsers.blkid+ > ../docs/parsers/blkid.md
+pydocmd simple jc.parsers.cksum+ > ../docs/parsers/cksum.md
 pydocmd simple jc.parsers.crontab+ > ../docs/parsers/crontab.md
 pydocmd simple jc.parsers.crontab_u+ > ../docs/parsers/crontab_u.md
 pydocmd simple jc.parsers.csv+ > ../docs/parsers/csv.md
+pydocmd simple jc.parsers.date+ > ../docs/parsers/date.md
 pydocmd simple jc.parsers.df+ > ../docs/parsers/df.md
 pydocmd simple jc.parsers.dig+ > ../docs/parsers/dig.md
 pydocmd simple jc.parsers.dmidecode+ > ../docs/parsers/dmidecode.md
@@ -21,6 +24,8 @@ pydocmd simple jc.parsers.free+ > ../docs/parsers/free.md
 pydocmd simple jc.parsers.fstab+ > ../docs/parsers/fstab.md
 pydocmd simple jc.parsers.group+ > ../docs/parsers/group.md
 pydocmd simple jc.parsers.gshadow+ > ../docs/parsers/gshadow.md
+pydocmd simple jc.parsers.hash+ > ../docs/parsers/hash.md
+pydocmd simple jc.parsers.hashsum+ > ../docs/parsers/hashsum.md
 pydocmd simple jc.parsers.history+ > ../docs/parsers/history.md
 pydocmd simple jc.parsers.hosts+ > ../docs/parsers/hosts.md
 pydocmd simple jc.parsers.id+ > ../docs/parsers/id.md
@@ -28,6 +33,7 @@ pydocmd simple jc.parsers.ifconfig+ > ../docs/parsers/ifconfig.md
 pydocmd simple jc.parsers.ini+ > ../docs/parsers/ini.md
 pydocmd simple jc.parsers.iptables+ > ../docs/parsers/iptables.md
 pydocmd simple jc.parsers.jobs+ > ../docs/parsers/jobs.md
+pydocmd simple jc.parsers.kv+ > ../docs/parsers/kv.md
 pydocmd simple jc.parsers.last+ > ../docs/parsers/last.md
 pydocmd simple jc.parsers.ls+ > ../docs/parsers/ls.md
 pydocmd simple jc.parsers.lsblk+ > ../docs/parsers/lsblk.md
@@ -37,6 +43,7 @@ pydocmd simple jc.parsers.mount+ > ../docs/parsers/mount.md
 pydocmd simple jc.parsers.netstat+ > ../docs/parsers/netstat.md
 pydocmd simple jc.parsers.ntpq+ > ../docs/parsers/ntpq.md
 pydocmd simple jc.parsers.passwd+ > ../docs/parsers/passwd.md
+pydocmd simple jc.parsers.ping+ > ../docs/parsers/ping.md
 pydocmd simple jc.parsers.pip_list+ > ../docs/parsers/pip_list.md
 pydocmd simple jc.parsers.pip_show+ > ../docs/parsers/pip_show.md
 pydocmd simple jc.parsers.ps+ > ../docs/parsers/ps.md
@@ -50,6 +57,8 @@ pydocmd simple jc.parsers.systemctl_lj+ > ../docs/parsers/systemctl_lj.md
 pydocmd simple jc.parsers.systemctl_ls+ > ../docs/parsers/systemctl_ls.md
 pydocmd simple jc.parsers.systemctl_luf+ > ../docs/parsers/systemctl_luf.md
 pydocmd simple jc.parsers.timedatectl+ > ../docs/parsers/timedatectl.md
+pydocmd simple jc.parsers.tracepath+ > ../docs/parsers/tracepath.md
+pydocmd simple jc.parsers.traceroute+ > ../docs/parsers/traceroute.md
 pydocmd simple jc.parsers.uname+ > ../docs/parsers/uname.md
 pydocmd simple jc.parsers.uptime+ > ../docs/parsers/uptime.md
 pydocmd simple jc.parsers.w+ > ../docs/parsers/w.md

docs/parsers/airport.md

@@ -1,12 +1,21 @@
+
 # jc.parsers.airport
-jc - JSON CLI output utility airport -I Parser
+jc - JSON CLI output utility `airport -I` command output parser
 
-Usage:
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-    specify --airport as the first argument if the piped input is coming from airport -I (OSX)
+Usage (cli):
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+    $ airport -I | jc --airport
+
+    or
+
+    $ jc airport -I
+
+Usage (module):
+
+    import jc.parsers.airport
+    result = jc.parsers.airport.parse(airport_command_output)
 
 Compatibility:
 
@@ -52,11 +61,13 @@ Examples:
       "channel": "48,80"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -90,6 +101,7 @@ Returns:
       "channel":           string
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/airport_s.md

@@ -1,12 +1,21 @@
+
 # jc.parsers.airport_s
-jc - JSON CLI output utility airport -s Parser
+jc - JSON CLI output utility `airport -s` command output parser
 
-Usage:
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-    specify --airport as the first argument if the piped input is coming from airport -s (OSX)
+Usage (cli):
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+    $ airport -s | jc --airport-s
+
+    or
+
+    $ jc airport -s
+
+Usage (module):
+
+    import jc.parsers.airport_s
+    result = jc.parsers.airport_s.parse(airport_s_command_output)
 
 Compatibility:
 
@@ -84,11 +93,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -117,6 +128,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/arp.md

@@ -1,13 +1,21 @@
+
 # jc.parsers.arp
-jc - JSON CLI output utility arp Parser
+jc - JSON CLI output utility `arp` command output parser
 
-Usage:
+Supports `arp` and `arp -a` output.
 
-    specify --arp as the first argument if the piped input is coming from:
+Usage (cli):
 
-    arp
-      or
-    arp -a
+    $ arp | jc --arp
+
+    or
+
+    $ jc arp
+
+Usage (module):
+
+    import jc.parsers.arp
+    result = jc.parsers.arp.parse(arp_command_output)
 
 Compatibility:
 
@@ -95,11 +103,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -128,6 +138,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/blkid.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.blkid
-jc - JSON CLI output utility blkid Parser
+jc - JSON CLI output utility `blkid` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --blkid as the first argument if the piped input is coming from blkid
+    $ blkid | jc --blkid
+
+    or
+
+    $ jc blkid
+
+Usage (module):
+
+    import jc.parsers.blkid
+    result = jc.parsers.blkid.parse(blkid_command_output)
 
 Compatibility:
 
@@ -75,11 +85,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -129,6 +141,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/cksum.md

@@ -0,0 +1,95 @@
+
+# jc.parsers.cksum
+jc - JSON CLI output utility `cksum` command output parser
+
+This parser works with the following checksum calculation utilities:
+- `sum`
+- `cksum`
+
+Usage (cli):
+
+    $ cksum file.txt | jc --cksum
+
+    or
+
+    $ jc cksum file.txt
+
+Usage (module):
+
+    import jc.parsers.cksum
+    result = jc.parsers.cksum.parse(cksum_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ cksum * | jc --cksum -p
+    [
+      {
+        "filename": "__init__.py",
+        "checksum": 4294967295,
+        "blocks": 0
+      },
+      {
+        "filename": "airport.py",
+        "checksum": 2208551092,
+        "blocks": 3745
+      },
+      {
+        "filename": "airport_s.py",
+        "checksum": 1113817598,
+        "blocks": 4572
+      },
+      ...
+    ]
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Structured data with the following schema:
+
+    [
+      {
+        "filename":     string,
+        "checksum":     integer,
+        "blocks":       integer
+      }
+    ]
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+

docs/parsers/crontab.md

@@ -1,9 +1,21 @@
+
 # jc.parsers.crontab
-jc - JSON CLI output utility crontab command and file Parser
+jc - JSON CLI output utility `crontab -l` command output and crontab file parser
 
-Usage:
+Supports `crontab -l` command output and crontab files.
 
-    specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
+Usage (cli):
+
+    $ crontab -l | jc --crontab
+
+    or
+
+    $ jc crontab -l
+
+Usage (module):
+
+    import jc.parsers.crontab
+    result = jc.parsers.crontab.parse(crontab_output)
 
 Compatibility:
 
@@ -128,11 +140,13 @@ Examples:
       ]
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -178,6 +192,7 @@ Returns:
     }
 
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/crontab_u.md

@@ -1,9 +1,17 @@
+
 # jc.parsers.crontab_u
-jc - JSON CLI output utility crontab file Parser
+jc - JSON CLI output utility `crontab -l` command output and crontab file parser
 
-Usage:
+This version of the `crontab -l` parser supports output that contains user information for processes.
 
-    specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
+Usage (cli):
+
+    $ crontab -l | jc --crontab-u
+
+Usage (module):
+
+    import jc.parsers.crontab_u
+    result = jc.parsers.crontab_u.parse(crontab_u_output)
 
 Compatibility:
 
@@ -129,11 +137,13 @@ Examples:
 
 
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -180,6 +190,7 @@ Returns:
     }
 
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/csv.md

@@ -1,12 +1,17 @@
+
 # jc.parsers.csv
-jc - JSON CLI output utility csv Parser
+jc - JSON CLI output utility `csv` file parser
 
-Usage:
+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.
 
-    specify --csv as the first argument if the piped input is coming from a csv file.
-    the csv parser will attempt to automatically detect the 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):
+
+    $ cat file.csv | jc --csv
+
+Usage (module):
+
+    import jc.parsers.csv
+    result = jc.parsers.csv.parse(csv_output)
 
 Compatibility:
 
@@ -59,11 +64,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -86,6 +93,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/date.md

@@ -0,0 +1,102 @@
+
+# jc.parsers.date
+jc - JSON CLI output utility `date` command output parser
+
+Usage (cli):
+
+    $ date | jc --date
+
+    or
+
+    $ jc date
+
+Usage (module):
+
+    import jc.parsers.date
+    result = jc.parsers.date.parse(date_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'freebsd'
+
+Examples:
+
+    $ date | jc --date -p
+    {
+      "year": 2020,
+      "month_num": 7,
+      "day": 31,
+      "hour": 16,
+      "minute": 48,
+      "second": 11,
+      "month": "Jul",
+      "weekday": "Fri",
+      "weekday_num": 6,
+      "timezone": "PDT"
+    }
+
+    $ date | jc --date -p -r
+    {
+      "year": "2020",
+      "month": "Jul",
+      "day": "31",
+      "weekday": "Fri",
+      "hour": "16",
+      "minute": "50",
+      "second": "01",
+      "timezone": "PDT"
+    }
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    Dictionary. Structured data with the following schema:
+
+    {
+      "year":         integer,
+      "month_num":    integer,
+      "day":          integer,
+      "hour":         integer,
+      "minute":       integer,
+      "second":       integer,
+      "month":        string,
+      "weekday":      string,
+      "weekday_num":  integer,
+      "timezone":     string
+    }
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+

docs/parsers/df.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.df
-jc - JSON CLI output utility df Parser
+jc - JSON CLI output utility `df` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --df as the first argument if the piped input is coming from df
+    $ df | jc --df
+
+    or
+
+    $ jc df
+
+Usage (module):
+
+    import jc.parsers.df
+    result = jc.parsers.df.parse(df_command_output)
 
 Compatibility:
 
@@ -69,11 +79,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -106,6 +118,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/dig.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.dig
-jc - JSON CLI output utility dig Parser
+jc - JSON CLI output utility `dig` command output parser
 
-Usage:
+Usage (cli):
 
-    Specify --dig as the first argument if the piped input is coming from dig
+    $ dig example.com | jc --dig
+
+    or
+
+    $ jc dig example.com
+
+Usage (module):
+
+    import jc.parsers.dig
+    result = jc.parsers.dig.parse(dig_command_output)
 
 Compatibility:
 
@@ -321,11 +331,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -393,6 +405,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/dmidecode.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.dmidecode
-jc - JSON CLI output utility dmidecode Parser
+jc - JSON CLI output utility `dmidecode` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --dmidecode as the first argument if the piped input is coming from dmidecode
+    $ dmidecode | jc --dmidecode
+
+    or
+
+    $ jc dmidecode
+
+Usage (module):
+
+    import jc.parsers.dmidecode
+    result = jc.parsers.dmidecode.parse(dmidecode_command_output)
 
 Compatibility:
 
@@ -99,11 +109,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -134,6 +146,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/du.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.du
-jc - JSON CLI output utility du Parser
+jc - JSON CLI output utility `du` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --du as the first argument if the piped input is coming from du
+    $ du | jc --du
+
+    or
+
+    $ jc du
+
+Usage (module):
+
+    import jc.parsers.du
+    result = jc.parsers.du.parse(du_command_output)
 
 Compatibility:
 
@@ -69,11 +79,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -96,6 +108,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/env.md

@@ -1,9 +1,21 @@
+
 # jc.parsers.env
-jc - JSON CLI output utility env Parser
+jc - JSON CLI output utility `env` and `printenv` command output parser
 
-Usage:
+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.
 
-    specify --env as the first argument if the piped input is coming from env
+Usage (cli):
+
+    $ env | jc --env
+
+    or
+
+    $ jc env
+
+Usage (module):
+
+    import jc.parsers.env
+    result = jc.parsers.env.parse(env_command_output)
 
 Compatibility:
 
@@ -49,11 +61,13 @@ Examples:
       "_": "/usr/bin/env"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -76,6 +90,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/file.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.file
-jc - JSON CLI output utility file command Parser
+jc - JSON CLI output utility `file` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --file as the first argument if the piped input is coming from file.
+    $ file * | jc --file
+
+    or
+
+    $ jc file *
+
+Usage (module):
+
+    import jc.parsers.file
+    result = jc.parsers.file.parse(file_command_output)
 
 Compatibility:
 
@@ -44,11 +54,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -71,6 +83,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/free.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.free
-jc - JSON CLI output utility free Parser
+jc - JSON CLI output utility `free` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --free as the first argument if the piped input is coming from free
+    $ free | jc --free
+
+    or
+
+    $ jc free
+
+Usage (module):
+
+    import jc.parsers.free
+    result = jc.parsers.free.parse(free_command_output)
 
 Compatibility:
 
@@ -49,11 +59,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -81,6 +93,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/fstab.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.fstab
-jc - JSON CLI output utility fstab Parser
+jc - JSON CLI output utility `fstab` file parser
 
-Usage:
+Usage (cli):
 
-    specify --fstab as the first argument if the piped input is coming from a fstab file
+    $ cat /etc/fstab | jc --fstab
+
+Usage (module):
+
+    import jc.parsers.fstab
+    result = jc.parsers.fstab.parse(fstab_command_output)
 
 Compatibility:
 
@@ -67,11 +73,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -98,6 +106,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/group.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.group
-jc - JSON CLI output utility /etc/group file Parser
+jc - JSON CLI output utility `/etc/group` file parser
 
-Usage:
+Usage (cli):
 
-    specify --group as the first argument if the piped input is coming from /etc/group
+    $ cat /etc/group | jc --group
+
+Usage (module):
+
+    import jc.parsers.group
+    result = jc.parsers.group.parse(group_file_output)
 
 Compatibility:
 
@@ -91,11 +97,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -122,6 +130,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/gshadow.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.gshadow
-jc - JSON CLI output utility /etc/gshadow file Parser
+jc - JSON CLI output utility `/etc/gshadow` file parser
 
-Usage:
+Usage (cli):
 
-    specify --gshadow as the first argument if the piped input is coming from /etc/gshadow
+    $ cat /etc/gshadow | jc --gshadow
+
+Usage (module):
+
+    import jc.parsers.gshadow
+    result = jc.parsers.gshadow.parse(gshadow_file_output)
 
 Compatibility:
 
@@ -57,11 +63,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -90,6 +98,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/hash.md

@@ -0,0 +1,78 @@
+
+# jc.parsers.hash
+jc - JSON CLI output utility `hash` command output parser
+
+Usage (cli):
+
+    $ hash | jc --hash
+
+Usage (module):
+
+    import jc.parsers.hash
+    result = jc.parsers.hash.parse(hash_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ hash | jc --hash -p
+    [
+      {
+        "hits": 2,
+        "command": "/bin/cat"
+      },
+      {
+        "hits": 1,
+        "command": "/bin/ls"
+      }
+    ]
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Structured data with the following schema:
+
+    [
+      {
+        "command":       string,
+        "hits":          integer
+      }
+    ]
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+

docs/parsers/hashsum.md

@@ -0,0 +1,109 @@
+
+# jc.parsers.hashsum
+jc - JSON CLI output utility `hash sum` command output parser
+
+This parser works with the following hash calculation utilities:
+- `md5`
+- `md5sum`
+- `shasum`
+- `sha1sum`
+- `sha224sum`
+- `sha256sum`
+- `sha384sum`
+- `sha512sum`
+
+Usage (cli):
+
+    $ md5sum file.txt | jc --hashsum
+
+    or
+
+    $ jc md5sum file.txt
+
+Usage (module):
+
+    import jc.parsers.hashsum
+    result = jc.parsers.hashsum.parse(md5sum_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ md5sum * | jc --hashsum -p
+    [
+      {
+        "filename": "devtoolset-3-gcc-4.9.2-6.el7.x86_64.rpm",
+        "hash": "65fc958c1add637ec23c4b137aecf3d3"
+      },
+      {
+        "filename": "digout",
+        "hash": "5b9312ee5aff080927753c63a347707d"
+      },
+      {
+        "filename": "dmidecode.out",
+        "hash": "716fd11c2ac00db109281f7110b8fb9d"
+      },
+      {
+        "filename": "file with spaces in the name",
+        "hash": "d41d8cd98f00b204e9800998ecf8427e"
+      },
+      {
+        "filename": "id-centos.out",
+        "hash": "4295be239a14ad77ef3253103de976d2"
+      },
+      {
+        "filename": "ifcfg.json",
+        "hash": "01fda0d9ba9a75618b072e64ff512b43"
+      },
+      ...
+    ]
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Structured data with the following schema:
+
+    [
+      {
+        "filename":     string,
+        "hash":         string,
+      }
+    ]
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+

docs/parsers/history.md

@@ -1,9 +1,17 @@
+
 # jc.parsers.history
-jc - JSON CLI output utility history Parser
+jc - JSON CLI output utility `history` command output parser
 
-Usage:
+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.
 
-    specify --history as the first argument if the piped input is coming from history
+Usage (cli):
+
+    $ history | jc --history
+
+Usage (module):
+
+    import jc.parsers.history
+    result = jc.parsers.history.parse(history_command_output)
 
 Compatibility:
 
@@ -41,11 +49,13 @@ Examples:
       ...
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -68,6 +78,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/hosts.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.hosts
-jc - JSON CLI output utility hosts Parser
+jc - JSON CLI output utility `/etc/hosts` file parser
 
-Usage:
+Usage (cli):
 
-    specify --hosts as the first argument if the piped input is coming from a hosts file
+    $ cat /etc/hosts | jc --hosts
+
+Usage (module):
+
+    import jc.parsers.hosts
+    result = jc.parsers.hosts.parse(hosts_file_output)
 
 Compatibility:
 
@@ -58,11 +64,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -87,6 +95,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/id.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.id
-jc - JSON CLI output utility id Parser
+jc - JSON CLI output utility `id` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --id as the first argument if the piped input is coming from id
+    $ id | jc --id
+
+    or
+
+    $ jc id
+
+Usage (module):
+
+    import jc.parsers.id
+    result = jc.parsers.id.parse(id_command_output)
 
 Compatibility:
 
@@ -67,11 +77,13 @@ Examples:
       }
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -114,6 +126,7 @@ Returns:
       }
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ifconfig.md

@@ -1,11 +1,21 @@
+
 # jc.parsers.ifconfig
-jc - JSON CLI output utility ifconfig Parser
+jc - JSON CLI output utility `ifconfig` command output parser
 
-Usage:
+Note: No `ifconfig` options are supported.
 
-    specify --ifconfig as the first argument if the piped input is coming from ifconfig
+Usage (cli):
 
-    no ifconfig options are supported.
+    $ ifconfig | jc --ifconfig
+
+    or
+
+    $ jc ifconfig
+
+Usage (module):
+
+    import jc.parsers.ifconfig
+    result = jc.parsers.ifconfig.parse(ifconfig_command_output)
 
 Compatibility:
 
@@ -142,19 +152,16 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## IfconfigParser
 ```python
-IfconfigParser(self, console_output)
-```
-
-## InterfaceNotFound
-```python
-InterfaceNotFound(self, /, *args, **kwargs)
+IfconfigParser(console_output)
 ```
 
 
@@ -206,6 +213,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ini.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.ini
-jc - JSON CLI output utility INI Parser
+jc - JSON CLI output utility `INI` file parser
 
-Usage:
+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.
 
-    specify --ini as the first argument if the piped input is coming from an INI file
+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):
+
+    $ cat foo.ini | jc --ini
+
+Usage (module):
+
+    import jc.parsers.ini
+    result = jc.parsers.ini.parse(ini_file_output)
 
 Compatibility:
 
@@ -43,11 +53,13 @@ Examples:
       }
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -61,13 +73,17 @@ Parameters:
 
 Returns:
 
-    Dictionary representing an ini document:
+    Dictionary representing an ini or simple key/value pair document:
 
     {
-      ini document converted to a dictionary
-      see configparser standard library documentation for more details
+      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.
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/iptables.md

@@ -1,11 +1,21 @@
+
 # jc.parsers.iptables
-jc - JSON CLI output utility ipables Parser
+jc - JSON CLI output utility `ipables` command output parser
 
-Usage:
+Supports `-vLn` and `--line-numbers` for all tables.
 
-    Specify --iptables as the first argument if the piped input is coming from iptables
+Usage (cli):
 
-    Supports -vLn and --line-numbers for all tables
+    $ sudo iptables -L -t nat | jc --iptables
+
+    or
+
+    $ jc iptables -L -t nat
+
+Usage (module):
+
+    import jc.parsers.iptables
+    result = jc.parsers.iptables.parse(iptables_command_output)
 
 Compatibility:
 
@@ -131,11 +141,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -172,6 +184,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/jobs.md

@@ -1,11 +1,21 @@
+
 # jc.parsers.jobs
-jc - JSON CLI output utility jobs Parser
+jc - JSON CLI output utility `jobs` command output parser
 
-Usage:
+Also supports the `-l` option.
 
-    specify --jobs as the first argument if the piped input is coming from jobs
+Usage (cli):
 
-    Also supports the -l option
+    $ jobs | jc --jobs
+
+    or
+
+    $ jc jobs
+
+Usage (module):
+
+    import jc.parsers.jobs
+    result = jc.parsers.jobs.parse(jobs_command_output)
 
 Compatibility:
 
@@ -73,11 +83,13 @@ Example:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -103,6 +115,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/kv.md

@@ -0,0 +1,69 @@
+
+# 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.
+
+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):
+
+    $ cat foo.txt | jc --kv
+
+Usage (module):
+
+    import jc.parsers.kv
+    result = jc.parsers.kv.parse(kv_file_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+
+Examples:
+
+    $ cat keyvalue.txt
+    # this file contains key/value pairs
+    name = John Doe
+    address=555 California Drive
+    age: 34
+    ; comments can include # or ;
+    # delimiter can be = or :
+    # quoted values have quotation marks stripped by default
+    # but can be preserved with the -r argument
+    occupation:"Engineer"
+
+    $ cat keyvalue.txt | jc --ini -p
+    {
+      "name": "John Doe",
+      "address": "555 California Drive",
+      "age": "34",
+      "occupation": "Engineer"
+    }
+
+
+## info
+```python
+info()
+```
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+    Note: this is just a wrapper for jc.parsers.ini
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary representing the key/value file
+

docs/parsers/last.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.last
-jc - JSON CLI output utility last Parser
+jc - JSON CLI output utility `last` and `lastb` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --last as the first argument if the piped input is coming from last or lastb
+    $ last | jc --last
+
+    or
+
+    $ jc last
+
+Usage (module):
+
+    import jc.parsers.last
+    result = jc.parsers.last.parse(last_command_output)
 
 Compatibility:
 
@@ -68,11 +78,13 @@ Examples:
     ]
 
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -99,6 +111,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ls.md

@@ -1,21 +1,26 @@
+
 # jc.parsers.ls
-jc - JSON CLI output utility ls Parser
+jc - JSON CLI output utility `ls` and `vdir` command output parser
 
-Note: The -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 -l or -b is not used.
+Options supported:
+- `lbaR`
+- `--time-style=full-iso`
+- `-h`: File sizes will be available in text form with `-r` but larger file sizes with human readable suffixes will be converted to `Null` in the default view since the parser attempts to convert this field to an integer.
 
-Usage:
+Note: The `-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 `-l` or `-b` is not used. Alternatively, `vdir` can be used, which is the same as running `ls -lb`.
 
-    specify --ls as the first argument if the piped input is coming from ls
+Usage (cli):
 
-    ls options supported:
+    $ ls | jc --ls
 
-                    -lbaR
-    --time-style=full-iso
-                       -h  file sizes will be available in text form with -r but larger file sizes
-                               with human readable suffixes will be converted to Null in default view
-                               since the parser attempts to convert this field to an integer.
+    or
+
+    $ jc ls
+
+Usage (module):
+
+    import jc.parsers.ls
+    result = jc.parsers.ls.parse(ls_command_output)
 
 Compatibility:
 
@@ -145,11 +150,13 @@ Examples:
       "date": "May 3 2019"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -178,6 +185,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/lsblk.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.lsblk
-jc - JSON CLI output utility lsblk Parser
+jc - JSON CLI output utility `lsblk` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --lsblk as the first argument if the piped input is coming from lsblk
+    $ lsblk | jc --lsblk
+
+    or
+
+    $ jc lsblk
+
+Usage (module):
+
+    import jc.parsers.lsblk
+    result = jc.parsers.lsblk.parse(lsblk_command_output)
 
 Compatibility:
 
@@ -212,11 +222,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -277,6 +289,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/lsmod.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.lsmod
-jc - JSON CLI output utility lsmod Parser
+jc - JSON CLI output utility `lsmod` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --lsmod as the first argument if the piped input is coming from lsmod
+    $ lsmod | jc --lsmod
+
+    or
+
+    $ jc lsmod
+
+Usage (module):
+
+    import jc.parsers.lsmod
+    result = jc.parsers.lsmod.parse(lsmod_command_output)
 
 Compatibility:
 
@@ -103,11 +113,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -134,6 +146,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/lsof.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.lsof
-jc - JSON CLI output utility lsof Parser
+jc - JSON CLI output utility `lsof` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --lsof as the first argument if the piped input is coming from lsof
+    $ lsof | jc --lsof
+
+    or
+
+    $ jc lsof
+
+Usage (module):
+
+    import jc.parsers.lsof
+    result = jc.parsers.lsof.parse(lsof_command_output)
 
 Compatibility:
 
@@ -93,11 +103,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -128,6 +140,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/mount.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.mount
-jc - JSON CLI output utility mount Parser
+jc - JSON CLI output utility `mount` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --mount as the first argument if the piped input is coming from mount
+    $ mount | jc --mount
+
+    or
+
+    $ jc mount
+
+Usage (module):
+
+    import jc.parsers.mount
+    result = jc.parsers.mount.parse(mount_command_output)
 
 Compatibility:
 
@@ -53,11 +63,13 @@ Example:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -84,6 +96,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/netstat.md

@@ -1,14 +1,23 @@
+
 # jc.parsers.netstat
-jc - JSON CLI output utility netstat Parser
-
-Usage:
-
-    Specify --netstat as the first argument if the piped input is coming from 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 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)
+Usage (cli):
+
+    $ netstat | jc --netstat
+
+    or
+
+    $ jc netstat
+
+Usage (module):
+
+    import jc.parsers.netstat
+    result = jc.parsers.netstat.parse(netstat_command_output)
 
 Compatibility:
 
@@ -245,11 +254,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -364,6 +375,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ntpq.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.ntpq
-jc - JSON CLI output utility ntpq Parser
+jc - JSON CLI output utility `ntpq -p` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --ntpq as the first argument if the piped input is coming from ntpq -p
+    $ ntpq -p | jc --ntpq
+
+    or
+
+    $ jc ntpq -p
+
+Usage (module):
+
+    import jc.parsers.ntpq
+    result = jc.parsers.ntpq.parse(ntpq_command_output)
 
 Compatibility:
 
@@ -179,11 +189,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -216,6 +228,7 @@ Returns:
     ]
 
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/passwd.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.passwd
-jc - JSON CLI output utility /etc/passwd file Parser
+jc - JSON CLI output utility `/etc/passwd` file Parser
 
-Usage:
+Usage (cli):
 
-    specify --passwd as the first argument if the piped input is coming from /etc/passwd
+    $ cat /etc/passwd | jc --passwd
+
+Usage (module):
+
+    import jc.parsers.passwd
+    result = jc.parsers.passwd.parse(passwd_file_output)
 
 Compatibility:
 
@@ -75,11 +81,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -107,6 +115,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ping.md

@@ -0,0 +1,186 @@
+
+# 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`.
+
+    $ ping -c 3 1.2.3.4 | jc --ping
+
+    or
+
+    $ jc ping -c 3 1.2.3.4
+
+Usage (module):
+
+    import jc.parsers.ping
+    result = jc.parsers.ping.parse(ping_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'freebsd'
+
+Examples:
+
+    $ ping -c 3 -p ff cnn.com | jc --ping -p
+    {
+      "destination_ip": "151.101.1.67",
+      "data_bytes": 56,
+      "pattern": "0xff",
+      "destination": "cnn.com",
+      "packets_transmitted": 3,
+      "packets_received": 3,
+      "packet_loss_percent": 0.0,
+      "duplicates": 0,
+      "round_trip_ms_min": 28.015,
+      "round_trip_ms_avg": 32.848,
+      "round_trip_ms_max": 39.376,
+      "round_trip_ms_stddev": 4.79,
+      "responses": [
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 0,
+          "ttl": 59,
+          "time_ms": 28.015,
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 1,
+          "ttl": 59,
+          "time_ms": 39.376,
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 2,
+          "ttl": 59,
+          "time_ms": 31.153,
+          "duplicate": false
+        }
+      ]
+    }
+
+
+    $ ping -c 3 -p ff cnn.com | jc --ping -p -r
+    {
+      "destination_ip": "151.101.129.67",
+      "data_bytes": "56",
+      "pattern": "0xff",
+      "destination": "cnn.com",
+      "packets_transmitted": "3",
+      "packets_received": "3",
+      "packet_loss_percent": "0.0",
+      "duplicates": "0",
+      "round_trip_ms_min": "25.078",
+      "round_trip_ms_avg": "29.543",
+      "round_trip_ms_max": "32.553",
+      "round_trip_ms_stddev": "3.221",
+      "responses": [
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "0",
+          "ttl": "59",
+          "time_ms": "25.078",
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "1",
+          "ttl": "59",
+          "time_ms": "30.999",
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "2",
+          "ttl": "59",
+          "time_ms": "32.553",
+          "duplicate": false
+        }
+      ]
+    }
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    Dictionary. Structured data with the following schema:
+
+    {
+      "source_ip":                   string,
+      "destination_ip":              string,
+      "data_bytes":                  integer,
+      "pattern":                     string,        (null if not set)
+      "destination":                 string,
+      "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,
+      "responses": [
+        {
+          "type":                    string,        ('reply' or 'timeout')
+          "timestamp":               float,
+          "bytes":                   integer,
+          "response_ip":             string,
+          "icmp_seq":                integer,
+          "ttl":                     integer,
+          "time_ms":                 float,
+          "duplicate":               boolean
+        }
+      ]
+    }
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+

docs/parsers/pip_list.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.pip_list
-jc - JSON CLI output utility pip-list Parser
+jc - JSON CLI output utility `pip-list` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --pip-list as the first argument if the piped input is coming from pip list
+    $ pip list | jc --pip-list
+
+    or
+
+    $ jc pip list
+
+Usage (module):
+
+    import jc.parsers.pip_list
+    result = jc.parsers.pip_list.parse(pip_list_command_output)
 
 Compatibility:
 
@@ -28,11 +38,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -56,6 +68,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/pip_show.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.pip_show
-jc - JSON CLI output utility pip-show Parser
+jc - JSON CLI output utility `pip-show` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --pip-show as the first argument if the piped input is coming from pip show
+    $ pip show | jc --pip-show
+
+    or
+
+    $ jc pip show
+
+Usage (module):
+
+    import jc.parsers.pip_show
+    result = jc.parsers.pip_show.parse(pip_show_command_output)
 
 Compatibility:
 
@@ -39,11 +49,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -75,6 +87,7 @@ Returns:
     ]
 
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ps.md

@@ -1,13 +1,23 @@
+
 # jc.parsers.ps
-jc - JSON CLI output utility ps Parser
+jc - JSON CLI output utility `ps` command output parser
 
-Usage:
+`ps` options supported:
+- `ef`
+- `axu`
 
-    specify --ps as the first argument if the piped input is coming from ps
+Usage (cli):
 
-    ps options supported:
-    - ef
-    - axu
+    $ ps | jc --ps
+
+    or
+
+    $ jc ps
+
+Usage (module):
+
+    import jc.parsers.ps
+    result = jc.parsers.ps.parse(ps_command_output)
 
 Compatibility:
 
@@ -173,11 +183,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -215,6 +227,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/route.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.route
-jc - JSON CLI output utility route Parser
+jc - JSON CLI output utility `route` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --route as the first argument if the piped input is coming from route
+    $ route | jc --route
+
+    or
+
+    $ jc route
+
+Usage (module):
+
+    import jc.parsers.route
+    result = jc.parsers.route.parse(route_command_output)
 
 Compatibility:
 
@@ -80,11 +90,13 @@ Examples:
     ]
 
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -119,6 +131,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/shadow.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.shadow
-jc - JSON CLI output utility /etc/shadow file Parser
+jc - JSON CLI output utility `/etc/shadow` file parser
 
-Usage:
+Usage (cli):
 
-    specify --shadow as the first argument if the piped input is coming from /etc/shadow
+    $ sudo cat /etc/shadow | jc --shadow
+
+Usage (module):
+
+    import jc.parsers.shadow
+    result = jc.parsers.shadow.parse(shadow_file_output)
 
 Compatibility:
 
@@ -81,11 +87,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -114,6 +122,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/ss.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.ss
-jc - JSON CLI output utility ss Parser
+jc - JSON CLI output utility `ss` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --ss as the first argument if the piped input is coming from ss
+    $ ss | jc --ss
+
+    or
+
+    $ jc ss
+
+Usage (module):
+
+    import jc.parsers.ss
+    result = jc.parsers.ss.parse(ss_command_output)
 
 Limitations:
 
@@ -247,11 +257,13 @@ Examples:
         }
       ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -289,6 +301,7 @@ Returns:
 
     Information from https://www.cyberciti.biz/files/ss.html used to define field names
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/stat.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.stat
-jc - JSON CLI output utility stat Parser
+jc - JSON CLI output utility `stat` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --stat as the first argument if the piped input is coming from stat
+    $ stat * | jc --stat
+
+    or
+
+    $ jc stat *
+
+Usage (module):
+
+    import jc.parsers.stat
+    result = jc.parsers.stat.parse(stat_command_output)
 
 Compatibility:
 
@@ -101,11 +111,13 @@ Examples:
       ..
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -149,6 +161,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/sysctl.md

@@ -1,13 +1,21 @@
+
 # jc.parsers.sysctl
-jc - JSON CLI output utility sysctl -a Parser
+jc - JSON CLI output utility `sysctl -a` command output parser
 
-Usage:
+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()`.
 
-    specify --sysctl as the first argument if the piped input is coming from sysctl -a
+Usage (cli):
 
-    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 (raw) option.
+    $ sysctl -a | jc --sysctl
+
+    or
+
+    $ jc sysctl -a
+
+Usage (module):
+
+    import jc.parsers.sysctl
+    result = jc.parsers.sysctl.parse(sysctl_command_output)
 
 Compatibility:
 
@@ -15,7 +23,7 @@ Compatibility:
 
 Examples:
 
-    $ sysctl | jc --sysctl -p
+    $ sysctl -a | jc --sysctl -p
     {
       "user.cs_path": "/usr/bin:/bin:/usr/sbin:/sbin",
       "user.bc_base_max": 99,
@@ -27,7 +35,7 @@ Examples:
       ...
     }
 
-    $ sysctl | jc --sysctl -p -r
+    $ sysctl -a | jc --sysctl -p -r
     {
       "user.cs_path": "/usr/bin:/bin:/usr/sbin:/sbin",
       "user.bc_base_max": "99",
@@ -39,11 +47,13 @@ Examples:
       ...
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -65,6 +75,7 @@ Returns:
       "baz":     string/integer/float
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/systemctl.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.systemctl
-jc - JSON CLI output utility systemctl Parser
+jc - JSON CLI output utility `systemctl` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --systemctl as the first argument if the piped input is coming from systemctl
+    $ systemctl | jc --systemctl
+
+    or
+
+    $ jc systemctl
+
+Usage (module):
+
+    import jc.parsers.systemctl
+    result = jc.parsers.systemctl.parse(systemctl_command_output)
 
 Compatibility:
 
@@ -37,11 +47,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -67,6 +79,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/systemctl_lj.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.systemctl_lj
-jc - JSON CLI output utility systemctl-lj Parser
+jc - JSON CLI output utility `systemctl list-jobs` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs
+    $ systemctl list-jobs | jc --systemctl-lj
+
+    or
+
+    $ jc systemctl list-jobs
+
+Usage (module):
+
+    import jc.parsers.systemctl_lj
+    result = jc.parsers.systemctl_lj.parse(systemctl_lj_command_output)
 
 Compatibility:
 
@@ -56,11 +66,13 @@ Examples:
     ]
 
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -85,6 +97,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/systemctl_ls.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.systemctl_ls
-jc - JSON CLI output utility systemctl-ls Parser
+jc - JSON CLI output utility `systemctl list-sockets` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets
+    $ systemctl list-sockets | jc --systemctl-ls
+
+    or
+
+    $ jc systemctl list-sockets
+
+Usage (module):
+
+    import jc.parsers.systemctl_ls
+    result = jc.parsers.systemctl_ls.parse(systemctl_ls_command_output)
 
 Compatibility:
 
@@ -31,11 +41,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -59,6 +71,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/systemctl_luf.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.systemctl_luf
-jc - JSON CLI output utility systemctl-luf Parser
+jc - JSON CLI output utility `systemctl list-unit-files` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files
+    $ systemctl list-unit-files | jc --systemctl-luf
+
+    or
+
+    $ jc systemctl list-unit-files
+
+Usage (module):
+
+    import jc.parsers.systemctl_luf
+    result = jc.parsers.systemctl_luf.parse(systemctl_luf_command_output)
 
 Compatibility:
 
@@ -28,11 +38,13 @@ Examples:
       ...
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -55,6 +67,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/timedatectl.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.timedatectl
-jc - JSON CLI output utility timedatectl Parser
+jc - JSON CLI output utility `timedatectl` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --timedatectl as the first argument if the piped input is coming from timedatectl or timedatectl status
+    $ timedatectl | jc --timedatectl
+
+    or
+
+    $ jc timedatectl
+
+Usage (module):
+
+    import jc.parsers.timedatectl
+    result = jc.parsers.timedatectl.parse(timedatectl_command_output)
 
 Compatibility:
 
@@ -35,11 +45,13 @@ Examples:
       "dst_active": "yes"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -68,6 +80,7 @@ Returns:
       "dst_active":                        boolean
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/tracepath.md

@@ -0,0 +1,173 @@
+
+# jc.parsers.tracepath
+jc - JSON CLI output utility `tracepath` command output parser
+
+Supports `tracepath` and `tracepath6` output.
+
+Usage (cli):
+
+    $ tracepath 1.2.3.4 | jc --tracepath
+
+    or
+
+    $ jc tracepath 1.2.3.4
+
+Usage (module):
+
+    import jc.parsers.tracepath
+    result = jc.parsers.tracepath.parse(tracepath_command_output)
+
+Compatibility:
+
+    'linux'
+
+Examples:
+
+    $ tracepath6 3ffe:2400:0:109::2 | jc --tracepath -p
+    {
+      "pmtu": 1480,
+      "forward_hops": 2,
+      "return_hops": 2,
+      "hops": [
+        {
+          "ttl": 1,
+          "guess": true,
+          "host": "[LOCALHOST]",
+          "reply_ms": null,
+          "pmtu": 1500,
+          "asymmetric_difference": null,
+          "reached": false
+        },
+        {
+          "ttl": 1,
+          "guess": false,
+          "host": "dust.inr.ac.ru",
+          "reply_ms": 0.411,
+          "pmtu": null,
+          "asymmetric_difference": null,
+          "reached": false
+        },
+        {
+          "ttl": 2,
+          "guess": false,
+          "host": "dust.inr.ac.ru",
+          "reply_ms": 0.39,
+          "pmtu": 1480,
+          "asymmetric_difference": 1,
+          "reached": false
+        },
+        {
+          "ttl": 2,
+          "guess": false,
+          "host": "3ffe:2400:0:109::2",
+          "reply_ms": 463.514,
+          "pmtu": null,
+          "asymmetric_difference": null,
+          "reached": true
+        }
+      ]
+    }
+
+    $ tracepath6 3ffe:2400:0:109::2 | jc --tracepath -p -r
+    {
+      "pmtu": "1480",
+      "forward_hops": "2",
+      "return_hops": "2",
+      "hops": [
+        {
+          "ttl": "1",
+          "guess": true,
+          "host": "[LOCALHOST]",
+          "reply_ms": null,
+          "pmtu": "1500",
+          "asymmetric_difference": null,
+          "reached": false
+        },
+        {
+          "ttl": "1",
+          "guess": false,
+          "host": "dust.inr.ac.ru",
+          "reply_ms": "0.411",
+          "pmtu": null,
+          "asymmetric_difference": null,
+          "reached": false
+        },
+        {
+          "ttl": "2",
+          "guess": false,
+          "host": "dust.inr.ac.ru",
+          "reply_ms": "0.390",
+          "pmtu": "1480",
+          "asymmetric_difference": "1",
+          "reached": false
+        },
+        {
+          "ttl": "2",
+          "guess": false,
+          "host": "3ffe:2400:0:109::2",
+          "reply_ms": "463.514",
+          "pmtu": null,
+          "asymmetric_difference": null,
+          "reached": true
+        }
+      ]
+    }
+
+
+
+## info
+```python
+info()
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    Dictionary. Structured data with the following schema:
+
+    {
+      "pmtu":                       integer,
+      "forward_hops":               integer,
+      "return_hops":                integer,
+      "hops": [
+        {
+          "ttl":                    integer,
+          "guess":                  boolean,
+          "host":                   string,
+          "reply_ms":               float,
+          "pmtu":                   integer,
+          "asymmetric_difference":  integer,
+          "reached":                boolean
+        }
+      ]
+    }
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+

docs/parsers/traceroute.md

@@ -0,0 +1,164 @@
+
+# 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.
+
+e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
+
+Usage (cli):
+
+    $ traceroute 1.2.3.4 | jc --traceroute
+
+    or
+
+    $ jc traceroute 1.2.3.4
+
+Usage (module):
+
+    import jc.parsers.traceroute
+    result = jc.parsers.traceroute.parse(traceroute_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'freebsd'
+
+Examples:
+
+    $ traceroute google.com | jc --traceroute -p
+    {
+      "destination_ip": "216.58.194.46",
+      "destination_name": "google.com",
+      "hops": [
+        {
+          "hop": 1,
+          "probes": [
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": 198.574
+            },
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": null
+            },
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": 198.65
+            }
+          ]
+        },
+        ...
+      ]
+    }
+
+    $ traceroute google.com  | jc --traceroute -p -r
+    {
+      "destination_ip": "216.58.194.46",
+      "destination_name": "google.com",
+      "hops": [
+        {
+          "hop": "1",
+          "probes": [
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": "198.574"
+            },
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": null
+            },
+            {
+              "annotation": null,
+              "asn": null,
+              "ip": "216.230.231.141",
+              "name": "216-230-231-141.static.houston.tx.oplink.net",
+              "rtt": "198.650"
+            }
+          ]
+        },
+        ...
+      ]
+    }
+
+
+## info
+```python
+info()
+```
+
+
+## Hop
+```python
+Hop(idx)
+```
+
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    Dictionary. Structured data with the following schema:
+
+    {
+      "destination_ip":         string,
+      "destination_name":       string,
+      "hops": [
+        {
+          "hop":                integer,
+          "probes": [
+            {
+              "annotation":     string,
+              "asn":            integer,
+              "ip":             string,
+              "name":           string,
+              "rtt":            float
+            }
+          ]
+        }
+      ]
+    }
+
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+

docs/parsers/uname.md

@@ -1,13 +1,21 @@
+
 # jc.parsers.uname
-jc - JSON CLI output utility uname Parser
+jc - JSON CLI output utility `uname -a` command output parser
 
-Usage:
+Note: Must use `uname -a`
 
-    specify --uname as the first argument if the piped input is coming from uname
+Usage (cli):
 
-Limitations:
+    $ uname -a | jc --uname
 
-    must use 'uname -a'
+    or
+
+    $ jc uname -a
+
+Usage (module):
+
+    import jc.parsers.uname
+    result = jc.parsers.uname.parse(uname_command_output)
 
 Compatibility:
 
@@ -27,11 +35,13 @@ Example:
       "kernel_version": "#74-Ubuntu SMP Tue Sep 17 17:06:04 UTC 2019"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -58,6 +68,7 @@ Returns:
         "kernel_version":     string
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/uptime.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.uptime
-jc - JSON CLI output utility uptime Parser
+jc - JSON CLI output utility `uptime` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --uptime as the first argument if the piped input is coming from uptime
+    $ uptime | jc --uptime
+
+    or
+
+    $ jc uptime
+
+Usage (module):
+
+    import jc.parsers.uptime
+    result = jc.parsers.uptime.parse(uptime_command_output)
 
 Compatibility:
 
@@ -31,11 +41,13 @@ Example:
       "load_15m": "0.05"
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -60,6 +72,7 @@ Returns:
       "load_15m": float
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/w.md

@@ -1,9 +1,19 @@
+
 # jc.parsers.w
-jc - JSON CLI output utility w Parser
+jc - JSON CLI output utility `w` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --w as the first argument if the piped input is coming from w
+    $ w | jc --w
+
+    or
+
+    $ jc w
+
+Usage (module):
+
+    import jc.parsers.w
+    result = jc.parsers.w.parse(w_command_output)
 
 Compatibility:
 
@@ -79,11 +89,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -112,6 +124,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/who.md

@@ -1,11 +1,21 @@
+
 # jc.parsers.who
-jc - JSON CLI output utility who Parser
+jc - JSON CLI output utility `who` command output parser
 
-Usage:
+Accepts any of the following who options (or no options): `-aTH`
 
-    specify --who as the first argument if the piped input is coming from who
+Usage (cli):
 
-    accepts any of the following who options (or no options): -aTH
+    $ who | jc --who
+
+    or
+
+    $ jc who
+
+Usage (module):
+
+    import jc.parsers.who
+    result = jc.parsers.who.parse(who_command_output)
 
 Compatibility:
 
@@ -99,11 +109,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -133,6 +145,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/xml.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.xml
-jc - JSON CLI output utility XML Parser
+jc - JSON CLI output utility `XML` file parser
 
-Usage:
+Usage (cli):
 
-    specify --xml as the first argument if the piped input is coming from an XML file
+    $ cat foo.xml | jc --xml
+
+Usage (module):
+
+    import jc.parsers.xml
+    result = jc.parsers.xml.parse(xml_file_output)
 
 Compatibility:
 
@@ -55,11 +61,13 @@ Examples:
       ...
     }
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -80,6 +88,7 @@ Returns:
       See https://github.com/martinblech/xmltodict for details
     }
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/parsers/yaml.md

@@ -1,9 +1,15 @@
+
 # jc.parsers.yaml
-jc - JSON CLI output utility YAML Parser
+jc - JSON CLI output utility `YAML` file parser
 
-Usage:
+Usage (cli):
 
-    specify --yaml as the first argument if the piped input is coming from a YAML file
+    $ cat foo.yaml | jc --yaml
+
+Usage (module):
+
+    import jc.parsers.yaml
+    result = jc.parsers.yaml.parse(yaml_file_output)
 
 Compatibility:
 
@@ -67,11 +73,13 @@ Examples:
       }
     ]
 
+
 ## info
 ```python
-info(self, /, *args, **kwargs)
+info()
 ```
 
+
 ## process
 ```python
 process(proc_data)
@@ -94,6 +102,7 @@ Returns:
       }
     ]
 
+
 ## parse
 ```python
 parse(data, raw=False, quiet=False)

docs/readme.md

@@ -1,3 +1,4 @@
+
 # jc
 JC - JSON CLI output utility
 
@@ -5,6 +6,8 @@ JC - JSON CLI output utility
 
 This package serializes the output of many standard unix command line tools to JSON format.
 
+For documentation on each parser, see [docs/parsers](https://github.com/kellyjonbrazil/jc/tree/master/docs/parsers).
+
 CLI Example:
 
     $ ls -l /usr/bin | jc --ls -p

docs/utils.md

@@ -1,5 +1,7 @@
+
 # utils
 jc - JSON CLI output utility utils
+
 ## warning_message
 ```python
 warning_message(message)
@@ -15,6 +17,7 @@ Returns:
 
     no return, just prints output to STDERR
 
+
 ## error_message
 ```python
 error_message(message)
@@ -30,6 +33,7 @@ Returns:
 
     no return, just prints output to STDERR
 
+
 ## compatibility
 ```python
 compatibility(mod_name, compatible)
@@ -48,6 +52,7 @@ Returns:
 
     no return, just prints output to STDERR
 
+
 ## has_data
 ```python
 has_data(data)

jc/__init__.py

@@ -4,6 +4,8 @@
 
 This package serializes the output of many standard unix command line tools to JSON format.
 
+For documentation on each parser, see [docs/parsers](https://github.com/kellyjonbrazil/jc/tree/master/docs/parsers).
+
 CLI Example:
 
     $ ls -l /usr/bin | jc --ls -p

jc/cli.py

@@ -21,8 +21,8 @@ import jc.appdirs as appdirs
 
 
 class info():
-    version = '1.12.0'
-    description = 'JSON conversion tool for CLI output'
+    version = '1.14.0'
+    description = 'JSON CLI output utility'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
 
@@ -34,9 +34,11 @@ parsers = [
     'airport-s',
     'arp',
     'blkid',
+    'cksum',
     'crontab',
     'crontab-u',
     'csv',
+    'date',
     'df',
     'dig',
     'dmidecode',
@@ -47,6 +49,8 @@ parsers = [
     'fstab',
     'group',
     'gshadow',
+    'hash',
+    'hashsum',
     'history',
     'hosts',
     'id',
@@ -54,6 +58,7 @@ parsers = [
     'ini',
     'iptables',
     'jobs',
+    'kv',
     'last',
     'ls',
     'lsblk',
@@ -63,6 +68,7 @@ parsers = [
     'netstat',
     'ntpq',
     'passwd',
+    'ping',
     'pip-list',
     'pip-show',
     'ps',
@@ -76,9 +82,12 @@ parsers = [
     'systemctl-ls',
     'systemctl-luf',
     'timedatectl',
+    'tracepath',
+    'traceroute',
     'uname',
     'uptime',
     'w',
+    'wc',
     'who',
     'xml',
     'yaml'
@@ -291,7 +300,7 @@ def helptext(message):
             -d               debug - show traceback (-dd for verbose traceback)
             -m               monochrome output
             -p               pretty print output
-            -q               quiet - suppress warnings
+            -q               quiet - suppress parser warnings
             -r               raw JSON output
 
     Example:

jc/parsers/airport.py

@@ -1,11 +1,19 @@
-"""jc - JSON CLI output utility airport -I Parser
+"""jc - JSON CLI output utility `airport -I` command output parser
 
-Usage:
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-    specify --airport as the first argument if the piped input is coming from airport -I (OSX)
+Usage (cli):
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+    $ airport -I | jc --airport
+
+    or
+
+    $ jc airport -I
+
+Usage (module):
+
+    import jc.parsers.airport
+    result = jc.parsers.airport.parse(airport_command_output)
 
 Compatibility:
 

jc/parsers/airport_s.py

@@ -1,11 +1,19 @@
-"""jc - JSON CLI output utility airport -s Parser
+"""jc - JSON CLI output utility `airport -s` command output parser
 
-Usage:
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-    specify --airport as the first argument if the piped input is coming from airport -s (OSX)
+Usage (cli):
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+    $ airport -s | jc --airport-s
+
+    or
+
+    $ jc airport -s
+
+Usage (module):
+
+    import jc.parsers.airport_s
+    result = jc.parsers.airport_s.parse(airport_s_command_output)
 
 Compatibility:
 

jc/parsers/arp.py

@@ -1,12 +1,19 @@
-"""jc - JSON CLI output utility arp Parser
+"""jc - JSON CLI output utility `arp` command output parser
 
-Usage:
+Supports `arp` and `arp -a` output.
 
-    specify --arp as the first argument if the piped input is coming from:
+Usage (cli):
 
-    arp
-      or
-    arp -a
+    $ arp | jc --arp
+
+    or
+
+    $ jc arp
+
+Usage (module):
+
+    import jc.parsers.arp
+    result = jc.parsers.arp.parse(arp_command_output)
 
 Compatibility:
 

jc/parsers/blkid.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility blkid Parser
+"""jc - JSON CLI output utility `blkid` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --blkid as the first argument if the piped input is coming from blkid
+    $ blkid | jc --blkid
+
+    or
+
+    $ jc blkid
+
+Usage (module):
+
+    import jc.parsers.blkid
+    result = jc.parsers.blkid.parse(blkid_command_output)
 
 Compatibility:
 

jc/parsers/cksum.py

@@ -0,0 +1,128 @@
+"""jc - JSON CLI output utility `cksum` command output parser
+
+This parser works with the following checksum calculation utilities:
+- `sum`
+- `cksum`
+
+Usage (cli):
+
+    $ cksum file.txt | jc --cksum
+
+    or
+
+    $ jc cksum file.txt
+
+Usage (module):
+
+    import jc.parsers.cksum
+    result = jc.parsers.cksum.parse(cksum_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ cksum * | jc --cksum -p
+    [
+      {
+        "filename": "__init__.py",
+        "checksum": 4294967295,
+        "blocks": 0
+      },
+      {
+        "filename": "airport.py",
+        "checksum": 2208551092,
+        "blocks": 3745
+      },
+      {
+        "filename": "airport_s.py",
+        "checksum": 1113817598,
+        "blocks": 4572
+      },
+      ...
+    ]
+"""
+import jc.utils
+
+
+class info():
+    version = '1.0'
+    description = 'cksum command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    details = 'Parses cksum and sum program output'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']
+    magic_commands = ['cksum', 'sum']
+
+
+__version__ = info.version
+
+
+def process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (dictionary) raw structured data to process
+
+    Returns:
+
+        List of dictionaries. Structured data with the following schema:
+
+        [
+          {
+            "filename":     string,
+            "checksum":     integer,
+            "blocks":       integer
+          }
+        ]
+    """
+
+    for entry in proc_data:
+        int_list = ['checksum', 'blocks']
+        for key in int_list:
+            if key in entry:
+                try:
+                    entry[key] = int(entry[key])
+                except (ValueError):
+                    entry[key] = None
+    return proc_data
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of dictionaries. Raw or processed structured data.
+    """
+    if not quiet:
+        jc.utils.compatibility(__name__, info.compatible)
+
+    raw_output = []
+
+    if jc.utils.has_data(data):
+
+        for line in filter(None, data.splitlines()):
+            item = {
+                'filename': line.split(maxsplit=2)[2],
+                'checksum': line.split(maxsplit=2)[0],
+                'blocks': line.split(maxsplit=2)[1]
+            }
+            raw_output.append(item)
+
+    if raw:
+        return raw_output
+    else:
+        return process(raw_output)

jc/parsers/crontab.py

@@ -1,8 +1,19 @@
-"""jc - JSON CLI output utility crontab command and file Parser
+"""jc - JSON CLI output utility `crontab -l` command output and crontab file parser
 
-Usage:
+Supports `crontab -l` command output and crontab files.
 
-    specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
+Usage (cli):
+
+    $ crontab -l | jc --crontab
+
+    or
+
+    $ jc crontab -l
+
+Usage (module):
+
+    import jc.parsers.crontab
+    result = jc.parsers.crontab.parse(crontab_output)
 
 Compatibility:
 
@@ -235,7 +246,7 @@ def parse(data, raw=False, quiet=False):
         # Pop any variable assignment lines
         cron_var = []
         for i, line in reversed(list(enumerate(cleandata))):
-            if '=' in line:
+            if '=' in line and not line.strip()[0].isdigit() and not line.strip()[0] == '@':
                 var_line = cleandata.pop(i)
                 var_name = var_line.split('=', maxsplit=1)[0].strip()
                 var_value = var_line.split('=', maxsplit=1)[1].strip()

jc/parsers/crontab_u.py

@@ -1,8 +1,15 @@
-"""jc - JSON CLI output utility crontab file Parser
+"""jc - JSON CLI output utility `crontab -l` command output and crontab file parser
 
-Usage:
+This version of the `crontab -l` parser supports output that contains user information for processes.
 
-    specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
+Usage (cli):
+
+    $ crontab -l | jc --crontab-u
+
+Usage (module):
+
+    import jc.parsers.crontab_u
+    result = jc.parsers.crontab_u.parse(crontab_u_output)
 
 Compatibility:
 
@@ -133,7 +140,7 @@ import jc.parsers.universal
 
 
 class info():
-    version = '1.3'
+    version = '1.5'
     description = 'crontab file parser with user support'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -236,7 +243,7 @@ def parse(data, raw=False, quiet=False):
         # Pop any variable assignment lines
         cron_var = []
         for i, line in reversed(list(enumerate(cleandata))):
-            if '=' in line:
+            if '=' in line and not line.strip()[0].isdigit() and not line.strip()[0] == '@':
                 var_line = cleandata.pop(i)
                 var_name = var_line.split('=', maxsplit=1)[0].strip()
                 var_value = var_line.split('=', maxsplit=1)[1].strip()

jc/parsers/csv.py

@@ -1,11 +1,15 @@
-"""jc - JSON CLI output utility csv Parser
+"""jc - JSON CLI output utility `csv` file parser
 
-Usage:
+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.
 
-    specify --csv as the first argument if the piped input is coming from a csv file.
-    the csv parser will attempt to automatically detect the 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):
+
+    $ cat file.csv | jc --csv
+
+Usage (module):
+
+    import jc.parsers.csv
+    result = jc.parsers.csv.parse(csv_output)
 
 Compatibility:
 

jc/parsers/date.py

@@ -0,0 +1,169 @@
+"""jc - JSON CLI output utility `date` command output parser
+
+Usage (cli):
+
+    $ date | jc --date
+
+    or
+
+    $ jc date
+
+Usage (module):
+
+    import jc.parsers.date
+    result = jc.parsers.date.parse(date_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'freebsd'
+
+Examples:
+
+    $ date | jc --date -p
+    {
+      "year": 2020,
+      "month_num": 7,
+      "day": 31,
+      "hour": 16,
+      "minute": 48,
+      "second": 11,
+      "month": "Jul",
+      "weekday": "Fri",
+      "weekday_num": 6,
+      "timezone": "PDT"
+    }
+
+    $ date | jc --date -p -r
+    {
+      "year": "2020",
+      "month": "Jul",
+      "day": "31",
+      "weekday": "Fri",
+      "hour": "16",
+      "minute": "50",
+      "second": "01",
+      "timezone": "PDT"
+    }
+"""
+import jc.utils
+
+
+class info():
+    version = '1.0'
+    description = 'date command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'freebsd']
+    magic_commands = ['date']
+
+
+__version__ = info.version
+
+
+def process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (dictionary) raw structured data to process
+
+    Returns:
+
+        Dictionary. Structured data with the following schema:
+
+        {
+          "year":         integer,
+          "month_num":    integer,
+          "day":          integer,
+          "hour":         integer,
+          "minute":       integer,
+          "second":       integer,
+          "month":        string,
+          "weekday":      string,
+          "weekday_num":  integer,
+          "timezone":     string
+        }
+    """
+    month_map = {
+        "Jan": 1,
+        "Feb": 2,
+        "Mar": 3,
+        "Apr": 4,
+        "May": 5,
+        "Jun": 6,
+        "Jul": 7,
+        "Aug": 8,
+        "Sep": 9,
+        "Oct": 10,
+        "Nov": 11,
+        "Dec": 12
+    }
+
+    weekday_map = {
+        "Sun": 1,
+        "Mon": 2,
+        "Tue": 3,
+        "Wed": 4,
+        "Thu": 5,
+        "Fri": 6,
+        "Sat": 7
+    }
+
+    if proc_data:
+        return {
+            "year": int(proc_data['year']),
+            'month_num': month_map[proc_data['month']],
+            "day": int(proc_data['day']),
+            "hour": int(proc_data['hour']),
+            "minute": int(proc_data['minute']),
+            "second": int(proc_data['second']),
+            "month": proc_data['month'],
+            "weekday": proc_data['weekday'],
+            "weekday_num": weekday_map[proc_data['weekday']],
+            "timezone": proc_data['timezone']
+        }
+    else:
+        return {}
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        Dictionary. Raw or processed structured data.
+    """
+    if not quiet:
+        jc.utils.compatibility(__name__, info.compatible)
+
+    raw_output = {}
+
+    if jc.utils.has_data(data):
+        data = data.replace(':', ' ')
+        split_data = data.split()
+
+        raw_output = {
+            "year": split_data[7],
+            "month": split_data[1],
+            "day": split_data[2],
+            "weekday": split_data[0],
+            "hour": split_data[3],
+            "minute": split_data[4],
+            "second": split_data[5],
+            "timezone": split_data[6]
+        }
+
+    if raw:
+        return raw_output
+    else:
+        return process(raw_output)

jc/parsers/df.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility df Parser
+"""jc - JSON CLI output utility `df` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --df as the first argument if the piped input is coming from df
+    $ df | jc --df
+
+    or
+
+    $ jc df
+
+Usage (module):
+
+    import jc.parsers.df
+    result = jc.parsers.df.parse(df_command_output)
 
 Compatibility:
 

jc/parsers/dig.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility dig Parser
+"""jc - JSON CLI output utility `dig` command output parser
 
-Usage:
+Usage (cli):
 
-    Specify --dig as the first argument if the piped input is coming from dig
+    $ dig example.com | jc --dig
+
+    or
+
+    $ jc dig example.com
+
+Usage (module):
+
+    import jc.parsers.dig
+    result = jc.parsers.dig.parse(dig_command_output)
 
 Compatibility:
 

jc/parsers/dmidecode.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility dmidecode Parser
+"""jc - JSON CLI output utility `dmidecode` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --dmidecode as the first argument if the piped input is coming from dmidecode
+    $ dmidecode | jc --dmidecode
+
+    or
+
+    $ jc dmidecode
+
+Usage (module):
+
+    import jc.parsers.dmidecode
+    result = jc.parsers.dmidecode.parse(dmidecode_command_output)
 
 Compatibility:
 

jc/parsers/du.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility du Parser
+"""jc - JSON CLI output utility `du` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --du as the first argument if the piped input is coming from du
+    $ du | jc --du
+
+    or
+
+    $ jc du
+
+Usage (module):
+
+    import jc.parsers.du
+    result = jc.parsers.du.parse(du_command_output)
 
 Compatibility:
 

jc/parsers/env.py

@@ -1,8 +1,19 @@
-"""jc - JSON CLI output utility env Parser
+"""jc - JSON CLI output utility `env` and `printenv` command output parser
 
-Usage:
+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.
 
-    specify --env as the first argument if the piped input is coming from env
+Usage (cli):
+
+    $ env | jc --env
+
+    or
+
+    $ jc env
+
+Usage (module):
+
+    import jc.parsers.env
+    result = jc.parsers.env.parse(env_command_output)
 
 Compatibility:
 
@@ -59,7 +70,7 @@ class info():
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']
-    magic_commands = ['env']
+    magic_commands = ['env', 'printenv']
 
 
 __version__ = info.version

jc/parsers/file.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility file command Parser
+"""jc - JSON CLI output utility `file` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --file as the first argument if the piped input is coming from file.
+    $ file * | jc --file
+
+    or
+
+    $ jc file *
+
+Usage (module):
+
+    import jc.parsers.file
+    result = jc.parsers.file.parse(file_command_output)
 
 Compatibility:
 

jc/parsers/foo.py

@@ -1,8 +1,19 @@
-"""jc - JSON CLI output utility foo Parser
+"""jc - JSON CLI output utility `foo` command output parser
 
-Usage:
+<<Short foo description and caveats>>
 
-    specify --foo as the first argument if the piped input is coming from foo
+Usage (cli):
+
+    $ foo | jc --foo
+
+    or
+
+    $ jc foo
+
+Usage (module):
+
+    import jc.parsers.foo
+    result = jc.parsers.foo.parse(foo_command_output)
 
 Compatibility:
 

jc/parsers/free.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility free Parser
+"""jc - JSON CLI output utility `free` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --free as the first argument if the piped input is coming from free
+    $ free | jc --free
+
+    or
+
+    $ jc free
+
+Usage (module):
+
+    import jc.parsers.free
+    result = jc.parsers.free.parse(free_command_output)
 
 Compatibility:
 

jc/parsers/fstab.py

@@ -1,8 +1,13 @@
-"""jc - JSON CLI output utility fstab Parser
+"""jc - JSON CLI output utility `fstab` file parser
 
-Usage:
+Usage (cli):
 
-    specify --fstab as the first argument if the piped input is coming from a fstab file
+    $ cat /etc/fstab | jc --fstab
+
+Usage (module):
+
+    import jc.parsers.fstab
+    result = jc.parsers.fstab.parse(fstab_command_output)
 
 Compatibility:
 

jc/parsers/group.py

@@ -1,8 +1,13 @@
-"""jc - JSON CLI output utility /etc/group file Parser
+"""jc - JSON CLI output utility `/etc/group` file parser
 
-Usage:
+Usage (cli):
 
-    specify --group as the first argument if the piped input is coming from /etc/group
+    $ cat /etc/group | jc --group
+
+Usage (module):
+
+    import jc.parsers.group
+    result = jc.parsers.group.parse(group_file_output)
 
 Compatibility:
 

jc/parsers/gshadow.py

@@ -1,8 +1,13 @@
-"""jc - JSON CLI output utility /etc/gshadow file Parser
+"""jc - JSON CLI output utility `/etc/gshadow` file parser
 
-Usage:
+Usage (cli):
 
-    specify --gshadow as the first argument if the piped input is coming from /etc/gshadow
+    $ cat /etc/gshadow | jc --gshadow
+
+Usage (module):
+
+    import jc.parsers.gshadow
+    result = jc.parsers.gshadow.parse(gshadow_file_output)
 
 Compatibility:
 

jc/parsers/hash.py

@@ -0,0 +1,108 @@
+"""jc - JSON CLI output utility `hash` command output parser
+
+Usage (cli):
+
+    $ hash | jc --hash
+
+Usage (module):
+
+    import jc.parsers.hash
+    result = jc.parsers.hash.parse(hash_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ hash | jc --hash -p
+    [
+      {
+        "hits": 2,
+        "command": "/bin/cat"
+      },
+      {
+        "hits": 1,
+        "command": "/bin/ls"
+      }
+    ]
+"""
+import jc.utils
+import jc.parsers.universal
+
+
+class info():
+    version = '1.0'
+    description = 'hash command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']
+
+
+__version__ = info.version
+
+
+def process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (dictionary) raw structured data to process
+
+    Returns:
+
+        List of dictionaries. Structured data with the following schema:
+
+        [
+          {
+            "command":       string,
+            "hits":          integer
+          }
+        ]
+    """
+    for entry in proc_data:
+        # change to int
+        int_list = ['hits']
+        for key in int_list:
+            if key in entry:
+                try:
+                    key_int = int(entry[key])
+                    entry[key] = key_int
+                except (ValueError):
+                    entry[key] = None
+
+    return proc_data
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of dictionaries. Raw or processed structured data.
+    """
+    if not quiet:
+        jc.utils.compatibility(__name__, info.compatible)
+
+    cleandata = data.splitlines()
+    raw_output = []
+
+    if jc.utils.has_data(data):
+
+        cleandata[0] = cleandata[0].lower()
+        raw_output = jc.parsers.universal.simple_table_parse(cleandata)
+
+    if raw:
+        return raw_output
+    else:
+        return process(raw_output)

jc/parsers/hashsum.py

@@ -0,0 +1,145 @@
+"""jc - JSON CLI output utility `hash sum` command output parser
+
+This parser works with the following hash calculation utilities:
+- `md5`
+- `md5sum`
+- `shasum`
+- `sha1sum`
+- `sha224sum`
+- `sha256sum`
+- `sha384sum`
+- `sha512sum`
+
+Usage (cli):
+
+    $ md5sum file.txt | jc --hashsum
+
+    or
+
+    $ jc md5sum file.txt
+
+Usage (module):
+
+    import jc.parsers.hashsum
+    result = jc.parsers.hashsum.parse(md5sum_command_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ md5sum * | jc --hashsum -p
+    [
+      {
+        "filename": "devtoolset-3-gcc-4.9.2-6.el7.x86_64.rpm",
+        "hash": "65fc958c1add637ec23c4b137aecf3d3"
+      },
+      {
+        "filename": "digout",
+        "hash": "5b9312ee5aff080927753c63a347707d"
+      },
+      {
+        "filename": "dmidecode.out",
+        "hash": "716fd11c2ac00db109281f7110b8fb9d"
+      },
+      {
+        "filename": "file with spaces in the name",
+        "hash": "d41d8cd98f00b204e9800998ecf8427e"
+      },
+      {
+        "filename": "id-centos.out",
+        "hash": "4295be239a14ad77ef3253103de976d2"
+      },
+      {
+        "filename": "ifcfg.json",
+        "hash": "01fda0d9ba9a75618b072e64ff512b43"
+      },
+      ...
+    ]
+"""
+import jc.utils
+
+
+class info():
+    version = '1.0'
+    description = 'hashsum command parser (md5sum, shasum, etc.)'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    details = 'Parses MD5 and SHA hash program output'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']
+    magic_commands = ['md5sum', 'md5', 'shasum', 'sha1sum', 'sha224sum', 'sha256sum', 'sha384sum', 'sha512sum']
+
+
+__version__ = info.version
+
+
+def process(proc_data):
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (dictionary) raw structured data to process
+
+    Returns:
+
+        List of dictionaries. Structured data with the following schema:
+
+        [
+          {
+            "filename":     string,
+            "hash":         string,
+          }
+        ]
+    """
+
+    # no further processing for this parser
+    return proc_data
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of dictionaries. Raw or processed structured data.
+    """
+    if not quiet:
+        jc.utils.compatibility(__name__, info.compatible)
+
+    raw_output = []
+
+    if jc.utils.has_data(data):
+
+        for line in filter(None, data.splitlines()):
+            # check for legacy md5 command output
+            if line.startswith('MD5 ('):
+                file_hash = line.split('=', maxsplit=1)[1].strip()
+                file_name = line.split('=', maxsplit=1)[0].strip()
+                file_name = file_name[5:]
+                file_name = file_name[:-1]
+            # standard md5sum and shasum command output
+            else:
+                file_hash = line.split(maxsplit=1)[0]
+                file_name = line.split(maxsplit=1)[1]
+
+            item = {
+                'filename': file_name,
+                'hash': file_hash
+            }
+            raw_output.append(item)
+
+    if raw:
+        return raw_output
+    else:
+        return process(raw_output)

jc/parsers/history.py

@@ -1,8 +1,15 @@
-"""jc - JSON CLI output utility history Parser
+"""jc - JSON CLI output utility `history` command output parser
 
-Usage:
+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.
 
-    specify --history as the first argument if the piped input is coming from history
+Usage (cli):
+
+    $ history | jc --history
+
+Usage (module):
+
+    import jc.parsers.history
+    result = jc.parsers.history.parse(history_command_output)
 
 Compatibility:
 

jc/parsers/hosts.py

@@ -1,8 +1,13 @@
-"""jc - JSON CLI output utility hosts Parser
+"""jc - JSON CLI output utility `/etc/hosts` file parser
 
-Usage:
+Usage (cli):
 
-    specify --hosts as the first argument if the piped input is coming from a hosts file
+    $ cat /etc/hosts | jc --hosts
+
+Usage (module):
+
+    import jc.parsers.hosts
+    result = jc.parsers.hosts.parse(hosts_file_output)
 
 Compatibility:
 

jc/parsers/id.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility id Parser
+"""jc - JSON CLI output utility `id` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --id as the first argument if the piped input is coming from id
+    $ id | jc --id
+
+    or
+
+    $ jc id
+
+Usage (module):
+
+    import jc.parsers.id
+    result = jc.parsers.id.parse(id_command_output)
 
 Compatibility:
 

jc/parsers/ifconfig.py

@@ -1,10 +1,19 @@
-"""jc - JSON CLI output utility ifconfig Parser
+"""jc - JSON CLI output utility `ifconfig` command output parser
 
-Usage:
+Note: No `ifconfig` options are supported.
 
-    specify --ifconfig as the first argument if the piped input is coming from ifconfig
+Usage (cli):
 
-    no ifconfig options are supported.
+    $ ifconfig | jc --ifconfig
+
+    or
+
+    $ jc ifconfig
+
+Usage (module):
+
+    import jc.parsers.ifconfig
+    result = jc.parsers.ifconfig.parse(ifconfig_command_output)
 
 Compatibility:
 
@@ -372,8 +381,6 @@ class IfconfigParser(object):
 
 
 class InterfaceNotFound(Exception):
-    """
-    """
     pass
 
 

jc/parsers/ini.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility INI Parser
+"""jc - JSON CLI output utility `INI` file parser
 
-Usage:
+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.
 
-    specify --ini as the first argument if the piped input is coming from an INI file
+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):
+
+    $ cat foo.ini | jc --ini
+
+Usage (module):
+
+    import jc.parsers.ini
+    result = jc.parsers.ini.parse(ini_file_output)
 
 Compatibility:
 
@@ -47,7 +56,7 @@ import configparser
 
 
 class info():
-    version = '1.1'
+    version = '1.3'
     description = 'INI file parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -70,15 +79,33 @@ def process(proc_data):
 
     Returns:
 
-        Dictionary representing an ini document:
+        Dictionary representing an ini or simple key/value pair document:
 
         {
-          ini document converted to a dictionary
-          see configparser standard library documentation for more details
+          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.
         }
     """
+    # remove quotation marks from beginning and end of values
+    for heading in proc_data:
+        # standard ini files with headers
+        if isinstance(proc_data[heading], dict):
+            for key, value in proc_data[heading].items():
+                if value is not None and value.startswith('"') and value.endswith('"'):
+                    proc_data[heading][key] = value.lstrip('"').rstrip('"')
+                elif value is None:
+                    proc_data[heading][key] = ''
+
+        # simple key/value files with no headers
+        else:
+            if proc_data[heading] is not None and proc_data[heading].startswith('"') and proc_data[heading].endswith('"'):
+                proc_data[heading] = proc_data[heading].lstrip('"').rstrip('"')
+            elif proc_data[heading] is None:
+                proc_data[heading] = ''
 
-    # No further processing
     return proc_data
 
 
@@ -103,9 +130,17 @@ def parse(data, raw=False, quiet=False):
 
     if jc.utils.has_data(data):
 
-        ini = configparser.ConfigParser()
-        ini.read_string(data)
-        raw_output = {s: dict(ini.items(s)) for s in ini.sections()}
+        ini = configparser.ConfigParser(allow_no_value=True, interpolation=None)
+        try:
+            ini.read_string(data)
+            raw_output = {s: dict(ini.items(s)) for s in ini.sections()}
+
+        except configparser.MissingSectionHeaderError:
+            data = '[data]\n' + data
+            ini.read_string(data)
+            output_dict = {s: dict(ini.items(s)) for s in ini.sections()}
+            for key, value in output_dict['data'].items():
+                raw_output[key] = value
 
     if raw:
         return raw_output

jc/parsers/iptables.py

@@ -1,10 +1,19 @@
-"""jc - JSON CLI output utility ipables Parser
+"""jc - JSON CLI output utility `ipables` command output parser
 
-Usage:
+Supports `-vLn` and `--line-numbers` for all tables.
 
-    Specify --iptables as the first argument if the piped input is coming from iptables
+Usage (cli):
 
-    Supports -vLn and --line-numbers for all tables
+    $ sudo iptables -L -t nat | jc --iptables
+
+    or
+
+    $ jc iptables -L -t nat
+
+Usage (module):
+
+    import jc.parsers.iptables
+    result = jc.parsers.iptables.parse(iptables_command_output)
 
 Compatibility:
 

jc/parsers/jobs.py

@@ -1,10 +1,19 @@
-"""jc - JSON CLI output utility jobs Parser
+"""jc - JSON CLI output utility `jobs` command output parser
 
-Usage:
+Also supports the `-l` option.
 
-    specify --jobs as the first argument if the piped input is coming from jobs
+Usage (cli):
 
-    Also supports the -l option
+    $ jobs | jc --jobs
+
+    or
+
+    $ jc jobs
+
+Usage (module):
+
+    import jc.parsers.jobs
+    result = jc.parsers.jobs.parse(jobs_command_output)
 
 Compatibility:
 

jc/parsers/kv.py

@@ -0,0 +1,75 @@
+"""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.
+
+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):
+
+    $ cat foo.txt | jc --kv
+
+Usage (module):
+
+    import jc.parsers.kv
+    result = jc.parsers.kv.parse(kv_file_output)
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+
+Examples:
+
+    $ cat keyvalue.txt
+    # this file contains key/value pairs
+    name = John Doe
+    address=555 California Drive
+    age: 34
+    ; comments can include # or ;
+    # delimiter can be = or :
+    # quoted values have quotation marks stripped by default
+    # but can be preserved with the -r argument
+    occupation:"Engineer"
+
+    $ cat keyvalue.txt | jc --ini -p
+    {
+      "name": "John Doe",
+      "address": "555 California Drive",
+      "age": "34",
+      "occupation": "Engineer"
+    }
+"""
+
+
+class info():
+    version = '1.0'
+    description = 'Key/Value file parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    details = 'This is a wrapper for the INI parser'
+
+    # compatible options: linux, darwin, cygwin, win32, aix, freebsd
+    compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']
+
+
+__version__ = info.version
+
+
+def parse(data, raw=False, quiet=False):
+    """
+    Main text parsing function
+
+        Note: this is just a wrapper for jc.parsers.ini
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) output preprocessed JSON if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        Dictionary representing the key/value file
+    """
+    import jc.parsers.ini
+    return jc.parsers.ini.parse(data, raw=raw, quiet=quiet)

jc/parsers/last.py

@@ -1,8 +1,17 @@
-"""jc - JSON CLI output utility last Parser
+"""jc - JSON CLI output utility `last` and `lastb` command output parser
 
-Usage:
+Usage (cli):
 
-    specify --last as the first argument if the piped input is coming from last or lastb
+    $ last | jc --last
+
+    or
+
+    $ jc last
+
+Usage (module):
+
+    import jc.parsers.last
+    result = jc.parsers.last.parse(last_command_output)
 
 Compatibility: