python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

update docs

Browse Source
This commit is contained in:
Kelly Brazil
2021-12-01 16:12:51 -08:00
parent 4dfdc9b0f6
commit 43d34461e2
83 changed files with 279 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -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)) - `--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)) - `--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)) - `--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)) - `--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)) - `--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)) - `--jobs` enables the `jobs` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs))

2
docs/parsers/acpi.md
View File

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

2
docs/parsers/airport.md
View File

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

2
docs/parsers/airport_s.md
View File

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

2
docs/parsers/arp.md
View File

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

2
docs/parsers/blkid.md
View File

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

2
docs/parsers/cksum.md
View File

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

2
docs/parsers/crontab.md
View File

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

2
docs/parsers/crontab_u.md
View File

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

2
docs/parsers/csv.md
View File

@ -99,4 +99,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/csv_s.md
View File

@ -74,4 +74,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/date.md
View File

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

2
docs/parsers/df.md
View File

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

2
docs/parsers/dig.md
View File

@ -341,4 +341,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, aix, freebsd, darwin, win32, cygwin 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)

2
docs/parsers/dir.md
View File

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

2
docs/parsers/dmidecode.md
View File

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

2
docs/parsers/dpkg_l.md
View File

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

2
docs/parsers/du.md
View File

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

2
docs/parsers/env.md
View File

@ -95,4 +95,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/file.md
View File

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

2
docs/parsers/finger.md
View File

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

2
docs/parsers/free.md
View File

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

2
docs/parsers/fstab.md
View File

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

2
docs/parsers/group.md
View File

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

2
docs/parsers/gshadow.md
View File

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

2
docs/parsers/hash.md
View File

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

2
docs/parsers/hashsum.md
View File

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

2
docs/parsers/hciconfig.md
View File

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

2
docs/parsers/history.md
View File

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

2
docs/parsers/hosts.md
View File

@ -99,4 +99,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/id.md
View File

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

2
docs/parsers/ifconfig.md
View File

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

2
docs/parsers/ini.md
View File

@ -90,4 +90,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

172
docs/parsers/iostat.md Normal file
View File

@ -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)

2
docs/parsers/iptables.md
View File

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

2
docs/parsers/iw_scan.md
View File

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

2
docs/parsers/jobs.md
View File

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

2
docs/parsers/last.md
View File

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

2
docs/parsers/ls.md
View File

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

2
docs/parsers/ls_s.md
View File

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

2
docs/parsers/lsblk.md
View File

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

2
docs/parsers/lsmod.md
View File

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

2
docs/parsers/lsof.md
View File

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

2
docs/parsers/lsusb.md
View File

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

2
docs/parsers/mount.md
View File

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

2
docs/parsers/netstat.md
View File

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

2
docs/parsers/ntpq.md
View File

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

2
docs/parsers/passwd.md
View File

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

2
docs/parsers/ping.md
View File

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

2
docs/parsers/ping_s.md
View File

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

2
docs/parsers/pip_list.md
View File

@ -72,4 +72,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/pip_show.md
View File

@ -90,4 +90,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/ps.md
View File

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

2
docs/parsers/route.md
View File

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

2
docs/parsers/rpm_qi.md
View File

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

2
docs/parsers/sfdisk.md
View File

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

2
docs/parsers/shadow.md
View File

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

2
docs/parsers/ss.md
View File

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

2
docs/parsers/stat.md
View File

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

2
docs/parsers/sysctl.md
View File

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

2
docs/parsers/systemctl.md
View File

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

2
docs/parsers/systemctl_lj.md
View File

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

2
docs/parsers/systemctl_ls.md
View File

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

2
docs/parsers/systemctl_luf.md
View File

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

2
docs/parsers/systeminfo.md
View File

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

2
docs/parsers/time.md
View File

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

2
docs/parsers/timedatectl.md
View File

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

2
docs/parsers/tracepath.md
View File

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

2
docs/parsers/traceroute.md
View File

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

2
docs/parsers/ufw.md
View File

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

2
docs/parsers/ufw_appinfo.md
View File

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

2
docs/parsers/uname.md
View File

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

2
docs/parsers/upower.md
View File

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

2
docs/parsers/uptime.md
View File

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

2
docs/parsers/vmstat.md
View File

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

2
docs/parsers/vmstat_s.md
View File

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

2
docs/parsers/w.md
View File

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

2
docs/parsers/wc.md
View File

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

2
docs/parsers/who.md
View File

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

2
docs/parsers/xml.md
View File

@ -95,4 +95,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

2
docs/parsers/yaml.md
View File

@ -109,4 +109,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd 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)

22
docs/utils.md
View File

@ -40,7 +40,7 @@ Returns:
## compatibility ## compatibility
```python ```python
compatibility(mod_name, compatible) compatibility(mod_name, compatible, quiet=False)
``` ```
Checks for the parser's compatibility with the running OS platform. Checks for the parser's compatibility with the running OS platform.
@ -52,6 +52,8 @@ Parameters:
compatible options: compatible options:
linux, darwin, cygwin, win32, aix, freebsd linux, darwin, cygwin, win32, aix, freebsd
quiet: (bool) supress compatibility message if True
Returns: Returns:
None - just prints output to STDERR 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` 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 ## timestamp
```python ```python
timestamp(datetime_string) timestamp(datetime_string)

7
man/jc.1
View File

@ -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 .SH NAME
jc \- JSONifies the output of many CLI tools and file-types jc \- JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS .SH SYNOPSIS
@ -177,6 +177,11 @@ hashsum command parser (`md5sum`, `shasum`, etc.)
\fB--ini\fP \fB--ini\fP
INI file parser INI file parser
.TP
.B
\fB--iostat\fP
`iostat` command parser
.TP .TP
.B .B
\fB--iptables\fP \fB--iptables\fP