From 43d34461e27e3e4ac5f985786831c170b348c7c5 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 1 Dec 2021 16:12:51 -0800 Subject: [PATCH] update docs --- README.md | 1 + docs/parsers/acpi.md | 2 +- docs/parsers/airport.md | 2 +- docs/parsers/airport_s.md | 2 +- docs/parsers/arp.md | 2 +- docs/parsers/blkid.md | 2 +- docs/parsers/cksum.md | 2 +- docs/parsers/crontab.md | 2 +- docs/parsers/crontab_u.md | 2 +- docs/parsers/csv.md | 2 +- docs/parsers/csv_s.md | 2 +- docs/parsers/date.md | 2 +- docs/parsers/df.md | 2 +- docs/parsers/dig.md | 2 +- docs/parsers/dir.md | 2 +- docs/parsers/dmidecode.md | 2 +- docs/parsers/dpkg_l.md | 2 +- docs/parsers/du.md | 2 +- docs/parsers/env.md | 2 +- docs/parsers/file.md | 2 +- docs/parsers/finger.md | 2 +- docs/parsers/free.md | 2 +- docs/parsers/fstab.md | 2 +- docs/parsers/group.md | 2 +- docs/parsers/gshadow.md | 2 +- docs/parsers/hash.md | 2 +- docs/parsers/hashsum.md | 2 +- docs/parsers/hciconfig.md | 2 +- docs/parsers/history.md | 2 +- docs/parsers/hosts.md | 2 +- docs/parsers/id.md | 2 +- docs/parsers/ifconfig.md | 2 +- docs/parsers/ini.md | 2 +- docs/parsers/iostat.md | 172 ++++++++++++++++++++++++++++++++++ docs/parsers/iptables.md | 2 +- docs/parsers/iw_scan.md | 2 +- docs/parsers/jobs.md | 2 +- docs/parsers/last.md | 2 +- docs/parsers/ls.md | 2 +- docs/parsers/ls_s.md | 2 +- docs/parsers/lsblk.md | 2 +- docs/parsers/lsmod.md | 2 +- docs/parsers/lsof.md | 2 +- docs/parsers/lsusb.md | 2 +- docs/parsers/mount.md | 2 +- docs/parsers/netstat.md | 2 +- docs/parsers/ntpq.md | 2 +- docs/parsers/passwd.md | 2 +- docs/parsers/ping.md | 2 +- docs/parsers/ping_s.md | 2 +- docs/parsers/pip_list.md | 2 +- docs/parsers/pip_show.md | 2 +- docs/parsers/ps.md | 2 +- docs/parsers/route.md | 2 +- docs/parsers/rpm_qi.md | 2 +- docs/parsers/sfdisk.md | 2 +- docs/parsers/shadow.md | 2 +- docs/parsers/ss.md | 2 +- docs/parsers/stat.md | 2 +- docs/parsers/sysctl.md | 2 +- docs/parsers/systemctl.md | 2 +- docs/parsers/systemctl_lj.md | 2 +- docs/parsers/systemctl_ls.md | 2 +- docs/parsers/systemctl_luf.md | 2 +- docs/parsers/systeminfo.md | 2 +- docs/parsers/time.md | 2 +- docs/parsers/timedatectl.md | 2 +- docs/parsers/tracepath.md | 2 +- docs/parsers/traceroute.md | 2 +- docs/parsers/ufw.md | 2 +- docs/parsers/ufw_appinfo.md | 2 +- docs/parsers/uname.md | 2 +- docs/parsers/upower.md | 2 +- docs/parsers/uptime.md | 2 +- docs/parsers/vmstat.md | 2 +- docs/parsers/vmstat_s.md | 2 +- docs/parsers/w.md | 2 +- docs/parsers/wc.md | 2 +- docs/parsers/who.md | 2 +- docs/parsers/xml.md | 2 +- docs/parsers/yaml.md | 2 +- docs/utils.md | 22 ++++- man/jc.1 | 7 +- 83 files changed, 279 insertions(+), 81 deletions(-) create mode 100644 docs/parsers/iostat.md diff --git a/README.md b/README.md index 2547657a..0fa3f6fe 100644 --- a/README.md +++ b/README.md @@ -138,6 +138,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio - `--id` enables the `id` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/id)) - `--ifconfig` enables the `ifconfig` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ifconfig)) - `--ini` enables the INI file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ini)) +- `--iostat` enables the `iostat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat)) - `--iptables` enables the `iptables` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iptables)) - `--iw-scan` enables the `iw dev [device] scan` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/iw_scan)) - `--jobs` enables the `jobs` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs)) diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index cac7087c..ecf0122b 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -252,4 +252,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index 9966499c..b45bde86 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -105,4 +105,4 @@ Returns: ## Parser Information Compatibility: darwin -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index 08929c09..49fb032d 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -133,4 +133,4 @@ Returns: ## Parser Information Compatibility: darwin -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index a9a32ee1..223b5219 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -142,4 +142,4 @@ Returns: ## Parser Information Compatibility: linux, aix, freebsd, darwin -Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index f3246fb1..94ae4308 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -145,4 +145,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index 21c8c175..e278bac6 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -79,4 +79,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index 7c390176..4d920fa0 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -195,4 +195,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index b209a72c..088560ee 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -191,4 +191,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 90d1571c..2c095082 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -99,4 +99,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 983563b5..8967538a 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -74,4 +74,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/date.md b/docs/parsers/date.md index e489be92..4872bf4c 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -96,4 +96,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 2.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index a8b08ada..5db298d2 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -122,4 +122,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index 7b252b07..c4abdcd1 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -341,4 +341,4 @@ Returns: ## Parser Information Compatibility: linux, aix, freebsd, darwin, win32, cygwin -Version 2.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index ba3a19e8..a7a48e69 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -143,4 +143,4 @@ Returns: ## Parser Information Compatibility: win32 -Version 1.3 by Rasheed Elsaleh (rasheed@rebelliondefense.com) +Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index 7f85b819..5be09999 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -150,4 +150,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index f367c0f6..706847f5 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -155,4 +155,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 9d87abbb..5e795d39 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -112,4 +112,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 493a121c..e141320e 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -95,4 +95,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/file.md b/docs/parsers/file.md index 42e1ea8e..a9c7bfeb 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -87,4 +87,4 @@ Returns: ## Parser Information Compatibility: linux, aix, freebsd, darwin -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md index 118bbb02..111f4043 100644 --- a/docs/parsers/finger.md +++ b/docs/parsers/finger.md @@ -115,4 +115,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, freebsd -Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 34736377..b30a22cc 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -97,4 +97,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index a6ab9d22..bf94c524 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -110,4 +110,4 @@ Returns: ## Parser Information Compatibility: linux, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 034c80d6..a644c566 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -134,4 +134,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index d32dc91e..46709d9d 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -102,4 +102,4 @@ Returns: ## Parser Information Compatibility: linux, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hash.md b/docs/parsers/hash.md index 721e8b83..5042bf45 100644 --- a/docs/parsers/hash.md +++ b/docs/parsers/hash.md @@ -62,4 +62,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hashsum.md b/docs/parsers/hashsum.md index 5bcb6b77..bbe3b318 100644 --- a/docs/parsers/hashsum.md +++ b/docs/parsers/hashsum.md @@ -93,4 +93,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hciconfig.md b/docs/parsers/hciconfig.md index 93e34812..d86ce1d3 100644 --- a/docs/parsers/hciconfig.md +++ b/docs/parsers/hciconfig.md @@ -342,4 +342,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 22eaaaec..aec2f0cd 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -85,4 +85,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index ed652c7b..f4646d4e 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -99,4 +99,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/id.md b/docs/parsers/id.md index 303858f1..2b7a4038 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -130,4 +130,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 985be4be..568b6f28 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -211,4 +211,4 @@ Returns: ## Parser Information Compatibility: linux, aix, freebsd, darwin -Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index a0659329..775bdd39 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -90,4 +90,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md new file mode 100644 index 00000000..2903f963 --- /dev/null +++ b/docs/parsers/iostat.md @@ -0,0 +1,172 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + +# jc.parsers.iostat +jc - JSON CLI output utility `iostat` command output parser + +Usage (cli): + + $ iostat | jc --iostat + + or + + $ jc iostat + +Usage (module): + + import jc.parsers.iostat + result = jc.parsers.iostat.parse(iostat_command_output) + +Schema: + + [ + { + "type": string, + "percent_user": float, + "percent_nice": float, + "percent_system": float, + "percent_iowait": float, + "percent_steal": float, + "percent_idle": float, + "device": string, + "tps": float, + "kb_read_s": float, + "mb_read_s": float, + "kb_wrtn_s": float, + "mb_wrtn_s": float, + "kb_read": integer, + "mb_read": integer, + "kb_wrtn": integer, + "mb_wrtn": integer, + "rrqm_s": float, + "wrqm_s": float, + "r_s": float, + "w_s": float, + "rmb_s": float, + "rkb_s": float, + "wmb_s": float, + "wkb_s": float, + "avgrq_sz": float, + "avgqu_sz": float, + "await": float, + "r_await": float, + "w_await": float, + "svctm": float, + "aqu_sz": float, + "rareq_sz": float, + "wareq_sz": float, + "percent_util": float, + "percent_rrqm": float, + "percent_wrqm": float + } + ] + +Examples: + + $ iostat | jc --iostat -p + [ + { + "percent_user": 0.15, + "percent_nice": 0.0, + "percent_system": 0.18, + "percent_iowait": 0.0, + "percent_steal": 0.0, + "percent_idle": 99.67, + "type": "cpu" + }, + { + "device": "sda", + "tps": 0.29, + "kb_read_s": 7.22, + "kb_wrtn_s": 1.25, + "kb_read": 194341, + "kb_wrtn": 33590, + "type": "device" + }, + { + "device": "dm-0", + "tps": 0.29, + "kb_read_s": 5.99, + "kb_wrtn_s": 1.17, + "kb_read": 161361, + "kb_wrtn": 31522, + "type": "device" + }, + { + "device": "dm-1", + "tps": 0.0, + "kb_read_s": 0.08, + "kb_wrtn_s": 0.0, + "kb_read": 2204, + "kb_wrtn": 0, + "type": "device" + } + ] + + $ iostat | jc --iostat -p -r + [ + { + "percent_user": "0.15", + "percent_nice": "0.00", + "percent_system": "0.18", + "percent_iowait": "0.00", + "percent_steal": "0.00", + "percent_idle": "99.67", + "type": "cpu" + }, + { + "device": "sda", + "tps": "0.29", + "kb_read_s": "7.22", + "kb_wrtn_s": "1.25", + "kb_read": "194341", + "kb_wrtn": "33590", + "type": "device" + }, + { + "device": "dm-0", + "tps": "0.29", + "kb_read_s": "5.99", + "kb_wrtn_s": "1.17", + "kb_read": "161361", + "kb_wrtn": "31522", + "type": "device" + }, + { + "device": "dm-1", + "tps": "0.00", + "kb_read_s": "0.08", + "kb_wrtn_s": "0.00", + "kb_read": "2204", + "kb_wrtn": "0", + "type": "device" + } + ] + + +## info +```python +info() +``` +Provides parser metadata (version, author, etc.) + +## parse +```python +parse(data, raw=False, quiet=False) +``` + +Main text parsing function + +Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + +Returns: + + List of Dictionaries. Raw or processed structured data. + +## Parser Information +Compatibility: linux + +Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 6cbc0c60..5660af97 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -188,4 +188,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/iw_scan.md b/docs/parsers/iw_scan.md index e36d91fb..ab0533b1 100644 --- a/docs/parsers/iw_scan.md +++ b/docs/parsers/iw_scan.md @@ -145,4 +145,4 @@ Returns: ## Parser Information Compatibility: linux -Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 0.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index 81cb5641..56aebae2 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -117,4 +117,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/last.md b/docs/parsers/last.md index b5a1419c..47c8e1e8 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -128,4 +128,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 7c523c04..f09aa824 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -131,4 +131,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 85d923cc..237ff159 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -91,4 +91,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 5958575f..685d9146 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -293,4 +293,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index f914e1c6..99cfcb2e 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -150,4 +150,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 4de5fef6..165c4473 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -144,4 +144,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 0f441dfa..707e66ec 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -285,4 +285,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 77b6e4b9..b0015589 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -100,4 +100,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index daa15895..58758941 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -379,4 +379,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index a5001b67..5e389e41 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -231,4 +231,4 @@ Returns: ## Parser Information Compatibility: linux, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index f808b80d..312a9ab5 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -119,4 +119,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index ec0db5e2..1d25d05c 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -181,4 +181,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 352b3ae9..ae0e26ba 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -98,4 +98,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index 42a22b65..4b64e2d5 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -72,4 +72,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index 2fc00bda..33a58720 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -90,4 +90,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index 7d525dec..47dce780 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -231,4 +231,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/route.md b/docs/parsers/route.md index 111abbb1..119c6711 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -133,4 +133,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index 0766c222..38a08c05 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -181,4 +181,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/sfdisk.md b/docs/parsers/sfdisk.md index a8fb0365..c5eededc 100644 --- a/docs/parsers/sfdisk.md +++ b/docs/parsers/sfdisk.md @@ -225,4 +225,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index ff22a0d1..e937ab14 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -126,4 +126,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, aix, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 8bc98d89..231055cf 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -303,4 +303,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index 3e62440b..05676277 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -193,4 +193,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index a24da65d..7e51fb18 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -79,4 +79,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 050c492f..2c23c110 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -83,4 +83,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 72a5a4af..cb38e495 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -100,4 +100,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index 9270e007..e4f02318 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -75,4 +75,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index 8e1bb21a..477b2f14 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -71,4 +71,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/systeminfo.md b/docs/parsers/systeminfo.md index 625a5176..a30216f5 100644 --- a/docs/parsers/systeminfo.md +++ b/docs/parsers/systeminfo.md @@ -229,4 +229,4 @@ Returns: ## Parser Information Compatibility: win32 -Version 1.0 by Jon Smith (jon@rebelliondefense.com) +Version 1.1 by Jon Smith (jon@rebelliondefense.com) diff --git a/docs/parsers/time.md b/docs/parsers/time.md index cc8468bd..909d74ac 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -148,4 +148,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 9d740a5a..e896bef5 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -88,4 +88,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index b4ab6b43..3d621c8a 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -156,4 +156,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index e29dd8b8..5cedbc83 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -142,4 +142,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ufw.md b/docs/parsers/ufw.md index a82a4034..1aee6e3d 100644 --- a/docs/parsers/ufw.md +++ b/docs/parsers/ufw.md @@ -222,4 +222,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/ufw_appinfo.md b/docs/parsers/ufw_appinfo.md index 35a5d75f..19250d97 100644 --- a/docs/parsers/ufw_appinfo.md +++ b/docs/parsers/ufw_appinfo.md @@ -155,4 +155,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 6af337af..329711bc 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -72,4 +72,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, freebsd -Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/upower.md b/docs/parsers/upower.md index 6156d1e6..2e4fc65f 100644 --- a/docs/parsers/upower.md +++ b/docs/parsers/upower.md @@ -219,4 +219,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 1fe63384..e7cc2ed8 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -90,4 +90,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/vmstat.md b/docs/parsers/vmstat.md index c220728c..fdf5792c 100644 --- a/docs/parsers/vmstat.md +++ b/docs/parsers/vmstat.md @@ -146,4 +146,4 @@ Returns: ## Parser Information Compatibility: linux -Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 4cfdc858..214814d9 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -111,4 +111,4 @@ Returns: ## Parser Information Compatibility: linux -Version 0.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 0.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 63340390..630e942b 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -128,4 +128,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md index 130ef740..1b5b5d38 100644 --- a/docs/parsers/wc.md +++ b/docs/parsers/wc.md @@ -79,4 +79,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/who.md b/docs/parsers/who.md index f694220e..fa954387 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -157,4 +157,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd -Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index 6be25da5..2dddebc9 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -95,4 +95,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index d389c3ec..a24deacb 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -109,4 +109,4 @@ Returns: ## Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd -Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) +Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/docs/utils.md b/docs/utils.md index 0a4482f0..08938dcc 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -40,7 +40,7 @@ Returns: ## compatibility ```python -compatibility(mod_name, compatible) +compatibility(mod_name, compatible, quiet=False) ``` Checks for the parser's compatibility with the running OS platform. @@ -52,6 +52,8 @@ Parameters: compatible options: linux, darwin, cygwin, win32, aix, freebsd + quiet: (bool) supress compatibility message if True + Returns: None - just prints output to STDERR @@ -135,6 +137,24 @@ Reraise the stream exception with annotation or print an error `_jc_meta` field if `ignore_exceptions=True` +## input_type_check +```python +input_type_check(data) +``` +Ensure input data is a string + +## streaming_input_type_check +```python +streaming_input_type_check(data) +``` +Ensure input data is an iterable, but not a string or bytes + +## streaming_line_input_type_check +```python +streaming_line_input_type_check(line) +``` +Ensure each line is a string + ## timestamp ```python timestamp(datetime_string) diff --git a/man/jc.1 b/man/jc.1 index 15b35aa7..8c94ca35 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2021-11-18 1.17.2 "JSON CLI output utility" +.TH jc 1 2021-12-01 1.17.3 "JSON CLI output utility" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS @@ -177,6 +177,11 @@ hashsum command parser (`md5sum`, `shasum`, etc.) \fB--ini\fP INI file parser +.TP +.B +\fB--iostat\fP +`iostat` command parser + .TP .B \fB--iptables\fP