Update high-level API docs

docs/parsers/env.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('env', env_command_output)
+
+    or
+
     import jc.parsers.env
     result = jc.parsers.env.parse(env_command_output)
 

docs/parsers/file.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('file', file_command_output)
+
+    or
+
     import jc.parsers.file
     result = jc.parsers.file.parse(file_command_output)
 

docs/parsers/finger.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('finger', finger_command_output)
+
+    or
+
     import jc.parsers.finger
     result = jc.parsers.finger.parse(finger_command_output)
 

docs/parsers/free.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('free', free_command_output)
+
+    or
+
     import jc.parsers.free
     result = jc.parsers.free.parse(free_command_output)
 

docs/parsers/fstab.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('fstab', fstab_command_output)
+
+    or
+
     import jc.parsers.fstab
     result = jc.parsers.fstab.parse(fstab_command_output)
 

docs/parsers/group.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('group', group_file_output)
+
+    or
+
     import jc.parsers.group
     result = jc.parsers.group.parse(group_file_output)
 

docs/parsers/gshadow.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('gshadow', gshadow_file_output)
+
+    or
+
     import jc.parsers.gshadow
     result = jc.parsers.gshadow.parse(gshadow_file_output)
 

docs/parsers/hash.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hash', hash_command_output)
+
+    or
+
     import jc.parsers.hash
     result = jc.parsers.hash.parse(hash_command_output)
 

docs/parsers/hashsum.md

@@ -23,6 +23,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hashsum', md5sum_command_output)
+
+    or
+
     import jc.parsers.hashsum
     result = jc.parsers.hashsum.parse(md5sum_command_output)
 

docs/parsers/hciconfig.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hciconfig', hciconfig_command_output)
+
+    or
+
     import jc.parsers.hciconfig
     result = jc.parsers.hciconfig.parse(hciconfig_command_output)
 

docs/parsers/history.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('history', history_command_output)
+
+    or
+
     import jc.parsers.history
     result = jc.parsers.history.parse(history_command_output)
 

docs/parsers/hosts.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hosts', hosts_file_output)
+
+    or
+
     import jc.parsers.hosts
     result = jc.parsers.hosts.parse(hosts_file_output)
 

docs/parsers/id.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('id', id_command_output)
+
+    or
+
     import jc.parsers.id
     result = jc.parsers.id.parse(id_command_output)
 

docs/parsers/ifconfig.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ifconfig', ifconfig_command_output)
+
+    or
+
     import jc.parsers.ifconfig
     result = jc.parsers.ifconfig.parse(ifconfig_command_output)
 

docs/parsers/ini.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ini', ini_file_output)
+
+    or
+
     import jc.parsers.ini
     result = jc.parsers.ini.parse(ini_file_output)
 

docs/parsers/iostat.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iostat', iostat_command_output)
+
+    or
+
     import jc.parsers.iostat
     result = jc.parsers.iostat.parse(iostat_command_output)
 

docs/parsers/iostat_s.md

@@ -13,6 +13,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iostat_s', iostat_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.iostat_s
     result = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())    # result is an iterable object
     for item in result:

docs/parsers/iptables.md

@@ -1,7 +1,7 @@
 [Home](https://kellyjonbrazil.github.io/jc/)
 
 # jc.parsers.iptables
-jc - JSON CLI output utility `ipables` command output parser
+jc - JSON CLI output utility `iptables` command output parser
 
 Supports `-vLn` and `--line-numbers` for all tables.
 
@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iptables', iptables_command_output)
+
+    or
+
     import jc.parsers.iptables
     result = jc.parsers.iptables.parse(iptables_command_output)
 

docs/parsers/iw_scan.md

@@ -15,8 +15,13 @@ Usage (cli):
 
 Usage (module):
 
-    import jc.parsers.iw-scan
-    result = jc.parsers.iw-scan.parse(iw-scan_command_output)
+    import jc
+    result = jc.parse('iw_scan', iw_scan_command_output)
+
+    or
+
+    import jc.parsers.iw_scan
+    result = jc.parsers.iw_scan.parse(iw_scan_command_output)
 
 Schema:
 

docs/parsers/jar_manifest.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('jar_manifest', jar_manifest_file_output)
+
+    or
+
     import jc.parsers.jar_manifest
     result = jc.parsers.jar_manifest.parse(jar_manifest_file_output)
 

docs/parsers/jobs.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('jobs', jobs_command_output)
+
+    or
+
     import jc.parsers.jobs
     result = jc.parsers.jobs.parse(jobs_command_output)
 

docs/parsers/kv.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('kv', kv_file_output)
+
+    or
+
     import jc.parsers.kv
     result = jc.parsers.kv.parse(kv_file_output)
 

docs/parsers/last.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('last', last_command_output)
+
+    or
+
     import jc.parsers.last
     result = jc.parsers.last.parse(last_command_output)
 

docs/parsers/ls.md

@@ -23,6 +23,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ls', ls_command_output)
+
+    or
+
     import jc.parsers.ls
     result = jc.parsers.ls.parse(ls_command_output)
 

docs/parsers/ls_s.md

@@ -19,6 +19,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ls_s', ls_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.ls_s
     result = jc.parsers.ls_s.parse(ls_command_output.splitlines())    # result is an iterable object
     for item in result:

docs/parsers/lsblk.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsblk', lsblk_command_output)
+
+    or
+
     import jc.parsers.lsblk
     result = jc.parsers.lsblk.parse(lsblk_command_output)
 

docs/parsers/lsmod.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsmod', lsmod_command_output)
+
+    or
+
     import jc.parsers.lsmod
     result = jc.parsers.lsmod.parse(lsmod_command_output)
 

docs/parsers/lsof.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsof', lsof_command_output)
+
+    or
+
     import jc.parsers.lsof
     result = jc.parsers.lsof.parse(lsof_command_output)
 

docs/parsers/lsusb.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsusb', lsusb_command_output)
+
+    or
+
     import jc.parsers.lsusb
     result = jc.parsers.lsusb.parse(lsusb_command_output)
 

docs/parsers/mount.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('mount', mount_command_output)
+
+    or
+
     import jc.parsers.mount
     result = jc.parsers.mount.parse(mount_command_output)
 

docs/parsers/netstat.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('netstat', netstat_command_output)
+
+    or
+
     import jc.parsers.netstat
     result = jc.parsers.netstat.parse(netstat_command_output)
 

docs/parsers/ntpq.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ntpq', ntpq_command_output)
+
+    or
+
     import jc.parsers.ntpq
     result = jc.parsers.ntpq.parse(ntpq_command_output)
 

docs/parsers/passwd.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('passwd', passwd_file_output)
+
+    or
+
     import jc.parsers.passwd
     result = jc.parsers.passwd.parse(passwd_file_output)
 

docs/parsers/ping.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ping', ping_command_output)
+
+    or
+
     import jc.parsers.ping
     result = jc.parsers.ping.parse(ping_command_output)
 

docs/parsers/ping_s.md

@@ -15,6 +15,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ping_s', ping_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.ping_s
     result = jc.parsers.ping_s.parse(ping_command_output.splitlines())    # result is an iterable object
     for item in result:

docs/parsers/pip_list.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('pip_list', pip_list_command_output)
+
+    or
+
     import jc.parsers.pip_list
     result = jc.parsers.pip_list.parse(pip_list_command_output)
 

docs/parsers/pip_show.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('pip_show', pip_show_command_output)
+
+    or
+
     import jc.parsers.pip_show
     result = jc.parsers.pip_show.parse(pip_show_command_output)
 

docs/parsers/ps.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ps', ps_command_output)
+
+    or
+
     import jc.parsers.ps
     result = jc.parsers.ps.parse(ps_command_output)
 

docs/parsers/route.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('route', route_command_output)
+
+    or
+
     import jc.parsers.route
     result = jc.parsers.route.parse(route_command_output)
 

docs/parsers/rpm_qi.md

@@ -19,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('rpm_qi', rpm_qi_command_output)
+
+    or
+
     import jc.parsers.rpm_qi
     result = jc.parsers.rpm_qi.parse(rpm_qi_command_output)
 

docs/parsers/sfdisk.md

@@ -22,6 +22,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('sfdisk', sfdisk_command_output)
+
+    or
+
     import jc.parsers.sfdisk
     result = jc.parsers.sfdisk.parse(sfdisk_command_output)
 

docs/parsers/shadow.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('shadow', shadow_file_output)
+
+    or
+
     import jc.parsers.shadow
     result = jc.parsers.shadow.parse(shadow_file_output)
 

docs/parsers/ss.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ss', ss_command_output)
+
+    or
+
     import jc.parsers.ss
     result = jc.parsers.ss.parse(ss_command_output)
 

docs/parsers/stat.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('stat', stat_command_output)
+
+    or
+
     import jc.parsers.stat
     result = jc.parsers.stat.parse(stat_command_output)
 

docs/parsers/stat_s.md

@@ -15,6 +15,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('stat_s', stat_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.stat_s
     result = jc.parsers.stat_s.parse(stat_command_output.splitlines())    # result is an iterable object
     for item in result:

docs/parsers/sysctl.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('sysctl', sysctl_command_output)
+
+    or
+
     import jc.parsers.sysctl
     result = jc.parsers.sysctl.parse(sysctl_command_output)
 

docs/parsers/systemctl.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl', systemctl_command_output)
+
+    or
+
     import jc.parsers.systemctl
     result = jc.parsers.systemctl.parse(systemctl_command_output)
 

docs/parsers/systemctl_lj.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_lj', systemctl_lj_command_output)
+
+    or
+
     import jc.parsers.systemctl_lj
     result = jc.parsers.systemctl_lj.parse(systemctl_lj_command_output)
 

docs/parsers/systemctl_ls.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_ls', systemctl_ls_command_output)
+
+    or
+
     import jc.parsers.systemctl_ls
     result = jc.parsers.systemctl_ls.parse(systemctl_ls_command_output)
 

docs/parsers/systemctl_luf.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systemctl_luf', systemctl_luf_command_output)
+
+    or
+
     import jc.parsers.systemctl_luf
     result = jc.parsers.systemctl_luf.parse(systemctl_luf_command_output)
 

docs/parsers/systeminfo.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('systeminfo', systeminfo_command_output)
+
+    or
+
     import jc.parsers.systeminfo
     result = jc.parsers.systeminfo.parse(systeminfo_command_output)
 

docs/parsers/time.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('time', time_command_output)
+
+    or
+
     import jc.parsers.time
     result = jc.parsers.time.parse(time_command_output)
 

docs/parsers/timedatectl.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('timedatectl', timedatectl_command_output)
+
+    or
+
     import jc.parsers.timedatectl
     result = jc.parsers.timedatectl.parse(timedatectl_command_output)
 

docs/parsers/tracepath.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('tracepath', tracepath_command_output)
+
+    or
+
     import jc.parsers.tracepath
     result = jc.parsers.tracepath.parse(tracepath_command_output)
 

docs/parsers/traceroute.md

@@ -19,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('traceroute', traceroute_command_output)
+
+    or
+
     import jc.parsers.traceroute
     result = jc.parsers.traceroute.parse(traceroute_command_output)
 

docs/parsers/ufw.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ufw', ufw_command_output)
+
+    or
+
     import jc.parsers.ufw
     result = jc.parsers.ufw.parse(ufw_command_output)
 

docs/parsers/ufw_appinfo.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ufw_appinfo', ufw_appinfo_command_output)
+
+    or
+
     import jc.parsers.ufw_appinfo
     result = jc.parsers.ufw_appinfo.parse(ufw_appinfo_command_output)
 

docs/parsers/uname.md

@@ -15,6 +15,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('uname', uname_command_output)
+
+    or
+
     import jc.parsers.uname
     result = jc.parsers.uname.parse(uname_command_output)
 

docs/parsers/upower.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('upower', upower_command_output)
+
+    or
+
     import jc.parsers.upower
     result = jc.parsers.upower.parse(upower_command_output)
 

docs/parsers/uptime.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('uptime', uptime_command_output)
+
+    or
+
     import jc.parsers.uptime
     result = jc.parsers.uptime.parse(uptime_command_output)
 

docs/parsers/vmstat.md

@@ -19,6 +19,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('vmstat', vmstat_command_output)
+
+    or
+
     import jc.parsers.vmstat
     result = jc.parsers.vmstat.parse(vmstat_command_output)
 

docs/parsers/vmstat_s.md

@@ -19,6 +19,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('vmstat_s', vmstat_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.vmstat_s
     result = jc.parsers.vmstat_s.parse(vmstat_command_output.splitlines())    # result is an iterable object
     for item in result:

docs/parsers/w.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('w', w_command_output)
+
+    or
+
     import jc.parsers.w
     result = jc.parsers.w.parse(w_command_output)
 

docs/parsers/wc.md

@@ -13,6 +13,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('wc', wc_command_output)
+
+    or
+
     import jc.parsers.wc
     result = jc.parsers.wc.parse(wc_command_output)
 

docs/parsers/who.md

@@ -17,6 +17,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('who', who_command_output)
+
+    or
+
     import jc.parsers.who
     result = jc.parsers.who.parse(who_command_output)
 

docs/parsers/xml.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('xml', xml_file_output)
+
+    or
+
     import jc.parsers.xml
     result = jc.parsers.xml.parse(xml_file_output)
 

docs/parsers/yaml.md

@@ -9,6 +9,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('yaml', yaml_file_output)
+
+    or
+
     import jc.parsers.yaml
     result = jc.parsers.yaml.parse(yaml_file_output)
 

docs/parsers/zipinfo.md

@@ -18,6 +18,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('zipinfo', zipinfo_command_output)
+
+    or
+
     import jc.parsers.zipinfo
     result = jc.parsers.zipinfo.parse(zipinfo_command_output)
 

jc/parsers/env.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('env', env_command_output)
+
+    or
+
     import jc.parsers.env
     result = jc.parsers.env.parse(env_command_output)
 

jc/parsers/file.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('file', file_command_output)
+
+    or
+
     import jc.parsers.file
     result = jc.parsers.file.parse(file_command_output)
 

jc/parsers/finger.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('finger', finger_command_output)
+
+    or
+
     import jc.parsers.finger
     result = jc.parsers.finger.parse(finger_command_output)
 

jc/parsers/foo.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('foo', foo_command_output)
+
+    or
+
     import jc.parsers.foo
     result = jc.parsers.foo.parse(foo_command_output)
 

jc/parsers/foo_s.py

@@ -10,6 +10,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('foo_s', foo_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.foo_s
     result = jc.parsers.foo_s.parse(foo_command_output.splitlines())    # result is an iterable object
     for item in result:

jc/parsers/free.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('free', free_command_output)
+
+    or
+
     import jc.parsers.free
     result = jc.parsers.free.parse(free_command_output)
 

jc/parsers/fstab.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('fstab', fstab_command_output)
+
+    or
+
     import jc.parsers.fstab
     result = jc.parsers.fstab.parse(fstab_command_output)
 

jc/parsers/group.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('group', group_file_output)
+
+    or
+
     import jc.parsers.group
     result = jc.parsers.group.parse(group_file_output)
 

jc/parsers/gshadow.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('gshadow', gshadow_file_output)
+
+    or
+
     import jc.parsers.gshadow
     result = jc.parsers.gshadow.parse(gshadow_file_output)
 

jc/parsers/hash.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hash', hash_command_output)
+
+    or
+
     import jc.parsers.hash
     result = jc.parsers.hash.parse(hash_command_output)
 

jc/parsers/hashsum.py

@@ -20,6 +20,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hashsum', md5sum_command_output)
+
+    or
+
     import jc.parsers.hashsum
     result = jc.parsers.hashsum.parse(md5sum_command_output)
 

jc/parsers/hciconfig.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hciconfig', hciconfig_command_output)
+
+    or
+
     import jc.parsers.hciconfig
     result = jc.parsers.hciconfig.parse(hciconfig_command_output)
 

jc/parsers/history.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('history', history_command_output)
+
+    or
+
     import jc.parsers.history
     result = jc.parsers.history.parse(history_command_output)
 

jc/parsers/hosts.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('hosts', hosts_file_output)
+
+    or
+
     import jc.parsers.hosts
     result = jc.parsers.hosts.parse(hosts_file_output)
 

jc/parsers/id.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('id', id_command_output)
+
+    or
+
     import jc.parsers.id
     result = jc.parsers.id.parse(id_command_output)
 

jc/parsers/ifconfig.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ifconfig', ifconfig_command_output)
+
+    or
+
     import jc.parsers.ifconfig
     result = jc.parsers.ifconfig.parse(ifconfig_command_output)
 

jc/parsers/ini.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ini', ini_file_output)
+
+    or
+
     import jc.parsers.ini
     result = jc.parsers.ini.parse(ini_file_output)
 

jc/parsers/iostat.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iostat', iostat_command_output)
+
+    or
+
     import jc.parsers.iostat
     result = jc.parsers.iostat.parse(iostat_command_output)
 

jc/parsers/iostat_s.py

@@ -10,6 +10,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iostat_s', iostat_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.iostat_s
     result = jc.parsers.iostat_s.parse(iostat_command_output.splitlines())    # result is an iterable object
     for item in result:

jc/parsers/iptables.py

@@ -1,4 +1,4 @@
-"""jc - JSON CLI output utility `ipables` command output parser
+"""jc - JSON CLI output utility `iptables` command output parser
 
 Supports `-vLn` and `--line-numbers` for all tables.
 
@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('iptables', iptables_command_output)
+
+    or
+
     import jc.parsers.iptables
     result = jc.parsers.iptables.parse(iptables_command_output)
 

jc/parsers/iw_scan.py

@@ -12,8 +12,13 @@ Usage (cli):
 
 Usage (module):
 
-    import jc.parsers.iw-scan
-    result = jc.parsers.iw-scan.parse(iw-scan_command_output)
+    import jc
+    result = jc.parse('iw_scan', iw_scan_command_output)
+
+    or
+
+    import jc.parsers.iw_scan
+    result = jc.parsers.iw_scan.parse(iw_scan_command_output)
 
 Schema:
 

jc/parsers/jar_manifest.py

@@ -6,6 +6,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('jar_manifest', jar_manifest_file_output)
+
+    or
+
     import jc.parsers.jar_manifest
     result = jc.parsers.jar_manifest.parse(jar_manifest_file_output)
 

jc/parsers/jobs.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('jobs', jobs_command_output)
+
+    or
+
     import jc.parsers.jobs
     result = jc.parsers.jobs.parse(jobs_command_output)
 

jc/parsers/kv.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('kv', kv_file_output)
+
+    or
+
     import jc.parsers.kv
     result = jc.parsers.kv.parse(kv_file_output)
 

jc/parsers/last.py

@@ -14,6 +14,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('last', last_command_output)
+
+    or
+
     import jc.parsers.last
     result = jc.parsers.last.parse(last_command_output)
 

jc/parsers/ls.py

@@ -20,6 +20,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ls', ls_command_output)
+
+    or
+
     import jc.parsers.ls
     result = jc.parsers.ls.parse(ls_command_output)
 

jc/parsers/ls_s.py

@@ -16,6 +16,13 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('ls_s', ls_command_output.splitlines())    # result is an iterable object
+    for item in result:
+        # do something
+
+    or
+
     import jc.parsers.ls_s
     result = jc.parsers.ls_s.parse(ls_command_output.splitlines())    # result is an iterable object
     for item in result:

jc/parsers/lsblk.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsblk', lsblk_command_output)
+
+    or
+
     import jc.parsers.lsblk
     result = jc.parsers.lsblk.parse(lsblk_command_output)
 

jc/parsers/lsmod.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsmod', lsmod_command_output)
+
+    or
+
     import jc.parsers.lsmod
     result = jc.parsers.lsmod.parse(lsmod_command_output)
 

jc/parsers/lsof.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsof', lsof_command_output)
+
+    or
+
     import jc.parsers.lsof
     result = jc.parsers.lsof.parse(lsof_command_output)
 

jc/parsers/lsusb.py

@@ -12,6 +12,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('lsusb', lsusb_command_output)
+
+    or
+
     import jc.parsers.lsusb
     result = jc.parsers.lsusb.parse(lsusb_command_output)
 

jc/parsers/mount.py

@@ -10,6 +10,11 @@ Usage (cli):
 
 Usage (module):
 
+    import jc
+    result = jc.parse('mount', mount_command_output)
+
+    or
+
     import jc.parsers.mount
     result = jc.parsers.mount.parse(mount_command_output)