add module usage info to docs

docs/parsers/airport.md

@@ -2,13 +2,18 @@
 # jc.parsers.airport
 jc - JSON CLI output utility airport -I Parser
 
-Usage:
+Usage (cli):
 
     specify --airport as the first argument if the piped input is coming from airport -I (OSX)
 
     This program can be found at:
     /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
 
+Usage (module):
+
+    import jc.parsers.airport
+    result = jc.parsers.airport.parse(airport_command_output)
+
 Compatibility:
 
     'darwin'

docs/parsers/airport_s.md

@@ -2,13 +2,18 @@
 # jc.parsers.airport_s
 jc - JSON CLI output utility airport -s Parser
 
-Usage:
+Usage (cli):
 
     specify --airport as the first argument if the piped input is coming from airport -s (OSX)
 
     This program can be found at:
     /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
 
+Usage (module):
+
+    import jc.parsers.airport_s
+    result = jc.parsers.airport_s.parse(airport_s_command_output)
+
 Compatibility:
 
     'darwin'

docs/parsers/arp.md

@@ -2,7 +2,7 @@
 # jc.parsers.arp
 jc - JSON CLI output utility arp Parser
 
-Usage:
+Usage (cli):
 
     specify --arp as the first argument if the piped input is coming from:
 
@@ -10,6 +10,11 @@ Usage:
       or
     arp -a
 
+Usage (module):
+
+    import jc.parsers.arp
+    result = jc.parsers.arp.parse(arp_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

docs/parsers/crontab.md

@@ -2,10 +2,15 @@
 # jc.parsers.crontab
 jc - JSON CLI output utility crontab command and file Parser
 
-Usage:
+Usage (cli):
 
     specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
 
+Usage (module):
+
+    import jc.parsers.crontab
+    result = jc.parsers.crontab.parse(crontab_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/crontab_u.md

@@ -2,10 +2,15 @@
 # jc.parsers.crontab_u
 jc - JSON CLI output utility crontab file Parser
 
-Usage:
+Usage (cli):
 
     specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
 
+Usage (module):
+
+    import jc.parsers.crontab_u
+    result = jc.parsers.crontab_u.parse(crontab_u_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/csv.md

@@ -2,13 +2,18 @@
 # jc.parsers.csv
 jc - JSON CLI output utility csv Parser
 
-Usage:
+Usage (cli):
 
     specify --csv as the first argument if the piped input is coming from a csv file.
     the csv parser will attempt to automatically detect the delimiter character.
     if the delimiter cannot be detected it will default to comma.
     the first row of the file must be a header row.
 
+Usage (module):
+
+    import jc.parsers.csv
+    result = jc.parsers.csv.parse(csv_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/date.md

@@ -2,10 +2,15 @@
 # jc.parsers.date
 jc - JSON CLI output utility date Parser
 
-Usage:
+Usage (cli):
 
     specify --date as the first argument if the piped input is coming from date
 
+Usage (module):
+
+    import jc.parsers.date
+    result = jc.parsers.date.parse(date_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/df.md

@@ -2,10 +2,15 @@
 # jc.parsers.df
 jc - JSON CLI output utility df Parser
 
-Usage:
+Usage (cli):
 
     specify --df as the first argument if the piped input is coming from df
 
+Usage (module):
+
+    import jc.parsers.df
+    result = jc.parsers.df.parse(df_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/dig.md

@@ -2,10 +2,15 @@
 # jc.parsers.dig
 jc - JSON CLI output utility dig Parser
 
-Usage:
+Usage (cli):
 
     Specify --dig as the first argument if the piped input is coming from dig
 
+Usage (module):
+
+    import jc.parsers.dig
+    result = jc.parsers.dig.parse(dig_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/dmidecode.md

@@ -2,10 +2,15 @@
 # jc.parsers.dmidecode
 jc - JSON CLI output utility dmidecode Parser
 
-Usage:
+Usage (cli):
 
     specify --dmidecode as the first argument if the piped input is coming from dmidecode
 
+Usage (module):
+
+    import jc.parsers.dmidecode
+    result = jc.parsers.dmidecode.parse(dmidecode_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/du.md

@@ -2,10 +2,15 @@
 # jc.parsers.du
 jc - JSON CLI output utility du Parser
 
-Usage:
+Usage (cli):
 
     specify --du as the first argument if the piped input is coming from du
 
+Usage (module):
+
+    import jc.parsers.du
+    result = jc.parsers.du.parse(du_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/env.md

@@ -2,10 +2,15 @@
 # jc.parsers.env
 jc - JSON CLI output utility env Parser
 
-Usage:
+Usage (cli):
 
     specify --env as the first argument if the piped input is coming from env
 
+Usage (module):
+
+    import jc.parsers.env
+    result = jc.parsers.env.parse(env_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/file.md

@@ -2,10 +2,15 @@
 # jc.parsers.file
 jc - JSON CLI output utility file command Parser
 
-Usage:
+Usage (cli):
 
     specify --file as the first argument if the piped input is coming from file.
 
+Usage (module):
+
+    import jc.parsers.file
+    result = jc.parsers.file.parse(file_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

docs/parsers/free.md

@@ -2,10 +2,15 @@
 # jc.parsers.free
 jc - JSON CLI output utility free Parser
 
-Usage:
+Usage (cli):
 
     specify --free as the first argument if the piped input is coming from free
 
+Usage (module):
+
+    import jc.parsers.free
+    result = jc.parsers.free.parse(free_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/fstab.md

@@ -2,10 +2,15 @@
 # jc.parsers.fstab
 jc - JSON CLI output utility fstab Parser
 
-Usage:
+Usage (cli):
 
     specify --fstab as the first argument if the piped input is coming from a fstab file
 
+Usage (module):
+
+    import jc.parsers.fstab
+    result = jc.parsers.fstab.parse(fstab_command_output)
+
 Compatibility:
 
     'linux', 'freebsd'

docs/parsers/group.md

@@ -2,10 +2,15 @@
 # jc.parsers.group
 jc - JSON CLI output utility /etc/group file Parser
 
-Usage:
+Usage (cli):
 
     specify --group as the first argument if the piped input is coming from /etc/group
 
+Usage (module):
+
+    import jc.parsers.group
+    result = jc.parsers.group.parse(group_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/gshadow.md

@@ -2,10 +2,15 @@
 # jc.parsers.gshadow
 jc - JSON CLI output utility /etc/gshadow file Parser
 
-Usage:
+Usage (cli):
 
     specify --gshadow as the first argument if the piped input is coming from /etc/gshadow
 
+Usage (module):
+
+    import jc.parsers.gshadow
+    result = jc.parsers.gshadow.parse(gshadow_file_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd'

docs/parsers/history.md

@@ -2,10 +2,15 @@
 # jc.parsers.history
 jc - JSON CLI output utility history Parser
 
-Usage:
+Usage (cli):
 
     specify --history as the first argument if the piped input is coming from history
 
+Usage (module):
+
+    import jc.parsers.history
+    result = jc.parsers.history.parse(history_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/hosts.md

@@ -2,10 +2,15 @@
 # jc.parsers.hosts
 jc - JSON CLI output utility hosts Parser
 
-Usage:
+Usage (cli):
 
     specify --hosts as the first argument if the piped input is coming from a hosts file
 
+Usage (module):
+
+    import jc.parsers.hosts
+    result = jc.parsers.hosts.parse(hosts_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/id.md

@@ -2,10 +2,15 @@
 # jc.parsers.id
 jc - JSON CLI output utility id Parser
 
-Usage:
+Usage (cli):
 
     specify --id as the first argument if the piped input is coming from id
 
+Usage (module):
+
+    import jc.parsers.id
+    result = jc.parsers.id.parse(id_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/ifconfig.md

@@ -2,12 +2,17 @@
 # jc.parsers.ifconfig
 jc - JSON CLI output utility ifconfig Parser
 
-Usage:
+Usage (cli):
 
     specify --ifconfig as the first argument if the piped input is coming from ifconfig
 
     no ifconfig options are supported.
 
+Usage (module):
+
+    import jc.parsers.ifconfig
+    result = jc.parsers.ifconfig.parse(ifconfig_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

docs/parsers/ini.md

@@ -2,12 +2,17 @@
 # jc.parsers.ini
 jc - JSON CLI output utility INI Parser
 
-Usage:
+Usage (cli):
 
     Specify --ini as the first argument if the piped input is coming from an INI file or any
     simple key/value pair file. Delimiter can be '=' or ':'. Missing values are supported.
     Comment prefix can be '#' or ';'. Comments must be on their own line.
 
+Usage (module):
+
+    import jc.parsers.ini
+    result = jc.parsers.ini.parse(ini_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/iptables.md

@@ -2,12 +2,17 @@
 # jc.parsers.iptables
 jc - JSON CLI output utility ipables Parser
 
-Usage:
+Usage (cli):
 
     Specify --iptables as the first argument if the piped input is coming from iptables
 
     Supports -vLn and --line-numbers for all tables
 
+Usage (module):
+
+    import jc.parsers.iptables
+    result = jc.parsers.iptables.parse(iptables_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/jobs.md

@@ -2,12 +2,17 @@
 # jc.parsers.jobs
 jc - JSON CLI output utility jobs Parser
 
-Usage:
+Usage (cli):
 
     specify --jobs as the first argument if the piped input is coming from jobs
 
     Also supports the -l option
 
+Usage (module):
+
+    import jc.parsers.jobs
+    result = jc.parsers.jobs.parse(jobs_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/kv.md

@@ -2,12 +2,17 @@
 # jc.parsers.kv
 jc - JSON CLI output utility Key/Value File Parser
 
-Usage:
+Usage (cli):
 
     Specify --kv as the first argument if the piped input is coming from a simple
     key/value pair file. Delimiter can be '=' or ':'. Missing values are supported.
     Comment prefix can be '#' or ';'. Comments must be on their own line.
 
+Usage (module):
+
+    import jc.parsers.kv
+    result = jc.parsers.kv.parse(kv_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/last.md

@@ -2,10 +2,15 @@
 # jc.parsers.last
 jc - JSON CLI output utility last Parser
 
-Usage:
+Usage (cli):
 
     specify --last as the first argument if the piped input is coming from last or lastb
 
+Usage (module):
+
+    import jc.parsers.last
+    result = jc.parsers.last.parse(last_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/ls.md

@@ -6,7 +6,7 @@ Note: The -l or -b option of ls should be used to correctly parse filenames that
       Since ls does not encode newlines in filenames when outputting to a pipe it will cause jc to see
       multiple files instead of a single file if -l or -b is not used.
 
-Usage:
+Usage (cli):
 
     specify --ls as the first argument if the piped input is coming from ls
 
@@ -18,6 +18,11 @@ Usage:
                                with human readable suffixes will be converted to Null in default view
                                since the parser attempts to convert this field to an integer.
 
+Usage (module):
+
+    import jc.parsers.ls
+    result = jc.parsers.ls.parse(ls_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/lsblk.md

@@ -2,10 +2,15 @@
 # jc.parsers.lsblk
 jc - JSON CLI output utility lsblk Parser
 
-Usage:
+Usage (cli):
 
     specify --lsblk as the first argument if the piped input is coming from lsblk
 
+Usage (module):
+
+    import jc.parsers.lsblk
+    result = jc.parsers.lsblk.parse(lsblk_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/lsmod.md

@@ -2,10 +2,15 @@
 # jc.parsers.lsmod
 jc - JSON CLI output utility lsmod Parser
 
-Usage:
+Usage (cli):
 
     specify --lsmod as the first argument if the piped input is coming from lsmod
 
+Usage (module):
+
+    import jc.parsers.lsmod
+    result = jc.parsers.lsmod.parse(lsmod_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/lsof.md

@@ -2,10 +2,15 @@
 # jc.parsers.lsof
 jc - JSON CLI output utility lsof Parser
 
-Usage:
+Usage (cli):
 
     specify --lsof as the first argument if the piped input is coming from lsof
 
+Usage (module):
+
+    import jc.parsers.lsof
+    result = jc.parsers.lsof.parse(lsof_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/mount.md

@@ -2,10 +2,15 @@
 # jc.parsers.mount
 jc - JSON CLI output utility mount Parser
 
-Usage:
+Usage (cli):
 
     specify --mount as the first argument if the piped input is coming from mount
 
+Usage (module):
+
+    import jc.parsers.mount
+    result = jc.parsers.mount.parse(mount_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/netstat.md

@@ -2,10 +2,15 @@
 # jc.parsers.netstat
 jc - JSON CLI output utility netstat Parser
 
-Usage:
+Usage (cli):
 
     Specify --netstat as the first argument if the piped input is coming from netstat
 
+Usage (module):
+
+    import jc.parsers.netstat
+    result = jc.parsers.netstat.parse(netstat_command_output)
+
 Caveats:
 
     - Use of multiple 'l' options is not supported on OSX (e.g. 'netstat -rlll')

docs/parsers/ntpq.md

@@ -2,10 +2,15 @@
 # jc.parsers.ntpq
 jc - JSON CLI output utility ntpq Parser
 
-Usage:
+Usage (cli):
 
     specify --ntpq as the first argument if the piped input is coming from ntpq -p
 
+Usage (module):
+
+    import jc.parsers.ntpq
+    result = jc.parsers.ntpq.parse(ntpq_command_output)
+
 Compatibility:
 
     'linux', 'freebsd'

docs/parsers/passwd.md

@@ -2,10 +2,15 @@
 # jc.parsers.passwd
 jc - JSON CLI output utility /etc/passwd file Parser
 
-Usage:
+Usage (cli):
 
     specify --passwd as the first argument if the piped input is coming from /etc/passwd
 
+Usage (module):
+
+    import jc.parsers.passwd
+    result = jc.parsers.passwd.parse(passwd_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/ping.md

@@ -2,12 +2,17 @@
 # jc.parsers.ping
 jc - JSON CLI output utility ping Parser
 
-Usage:
+Usage (cli):
 
     specify --ping as the first argument if the piped input is coming from ping
 
     Note:  Use the ping -c (count) option, otherwise data will not be piped to jc.
 
+Usage (module):
+
+    import jc.parsers.ping
+    result = jc.parsers.ping.parse(ping_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/pip_list.md

@@ -2,10 +2,15 @@
 # jc.parsers.pip_list
 jc - JSON CLI output utility pip-list Parser
 
-Usage:
+Usage (cli):
 
     specify --pip-list as the first argument if the piped input is coming from pip list
 
+Usage (module):
+
+    import jc.parsers.pip_list
+    result = jc.parsers.pip_list.parse(pip_list_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/pip_show.md

@@ -2,10 +2,15 @@
 # jc.parsers.pip_show
 jc - JSON CLI output utility pip-show Parser
 
-Usage:
+Usage (cli):
 
     specify --pip-show as the first argument if the piped input is coming from pip show
 
+Usage (module):
+
+    import jc.parsers.pip_show
+    result = jc.parsers.pip_show.parse(pip_show_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/ps.md

@@ -2,7 +2,7 @@
 # jc.parsers.ps
 jc - JSON CLI output utility ps Parser
 
-Usage:
+Usage (cli):
 
     specify --ps as the first argument if the piped input is coming from ps
 
@@ -10,6 +10,11 @@ Usage:
     - ef
     - axu
 
+Usage (module):
+
+    import jc.parsers.ps
+    result = jc.parsers.ps.parse(ps_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/route.md

@@ -2,10 +2,15 @@
 # jc.parsers.route
 jc - JSON CLI output utility route Parser
 
-Usage:
+Usage (cli):
 
     specify --route as the first argument if the piped input is coming from route
 
+Usage (module):
+
+    import jc.parsers.route
+    result = jc.parsers.route.parse(route_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/shadow.md

@@ -2,10 +2,15 @@
 # jc.parsers.shadow
 jc - JSON CLI output utility /etc/shadow file Parser
 
-Usage:
+Usage (cli):
 
     specify --shadow as the first argument if the piped input is coming from /etc/shadow
 
+Usage (module):
+
+    import jc.parsers.shadow
+    result = jc.parsers.shadow.parse(shadow_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

docs/parsers/ss.md

@@ -2,10 +2,15 @@
 # jc.parsers.ss
 jc - JSON CLI output utility ss Parser
 
-Usage:
+Usage (cli):
 
     specify --ss as the first argument if the piped input is coming from ss
 
+Usage (module):
+
+    import jc.parsers.ss
+    result = jc.parsers.ss.parse(ss_command_output)
+
 Limitations:
 
     Extended information options like -e and -p are not supported and may cause parsing irregularities

docs/parsers/stat.md

@@ -2,10 +2,15 @@
 # jc.parsers.stat
 jc - JSON CLI output utility stat Parser
 
-Usage:
+Usage (cli):
 
     specify --stat as the first argument if the piped input is coming from stat
 
+Usage (module):
+
+    import jc.parsers.stat
+    result = jc.parsers.stat.parse(stat_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/sysctl.md

@@ -2,7 +2,7 @@
 # jc.parsers.sysctl
 jc - JSON CLI output utility sysctl -a Parser
 
-Usage:
+Usage (cli):
 
     specify --sysctl as the first argument if the piped input is coming from sysctl -a
 
@@ -10,6 +10,11 @@ Usage:
           will be output. An attempt is made to convert obvious integers and floats. If no
           conversion is desired, use the -r (raw) option.
 
+Usage (module):
+
+    import jc.parsers.sysctl
+    result = jc.parsers.sysctl.parse(sysctl_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/systemctl.md

@@ -2,10 +2,15 @@
 # jc.parsers.systemctl
 jc - JSON CLI output utility systemctl Parser
 
-Usage:
+Usage (cli):
 
     specify --systemctl as the first argument if the piped input is coming from systemctl
 
+Usage (module):
+
+    import jc.parsers.systemctl
+    result = jc.parsers.systemctl.parse(systemctl_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/systemctl_lj.md

@@ -2,10 +2,15 @@
 # jc.parsers.systemctl_lj
 jc - JSON CLI output utility systemctl-lj Parser
 
-Usage:
+Usage (cli):
 
     specify --systemctl-lj as the first argument if the piped input is coming from systemctl list-jobs
 
+Usage (module):
+
+    import jc.parsers.systemctl_lj
+    result = jc.parsers.systemctl_lj.parse(systemctl_lj_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/systemctl_ls.md

@@ -2,10 +2,15 @@
 # jc.parsers.systemctl_ls
 jc - JSON CLI output utility systemctl-ls Parser
 
-Usage:
+Usage (cli):
 
     specify --systemctl-ls as the first argument if the piped input is coming from systemctl list-sockets
 
+Usage (module):
+
+    import jc.parsers.systemctl_ls
+    result = jc.parsers.systemctl_ls.parse(systemctl_ls_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/systemctl_luf.md

@@ -2,10 +2,15 @@
 # jc.parsers.systemctl_luf
 jc - JSON CLI output utility systemctl-luf Parser
 
-Usage:
+Usage (cli):
 
     specify --systemctl-luf as the first argument if the piped input is coming from systemctl list-unit-files
 
+Usage (module):
+
+    import jc.parsers.systemctl_luf
+    result = jc.parsers.systemctl_luf.parse(systemctl_luf_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/timedatectl.md

@@ -2,10 +2,15 @@
 # jc.parsers.timedatectl
 jc - JSON CLI output utility timedatectl Parser
 
-Usage:
+Usage (cli):
 
     specify --timedatectl as the first argument if the piped input is coming from timedatectl or timedatectl status
 
+Usage (module):
+
+    import jc.parsers.timedatectl
+    result = jc.parsers.timedatectl.parse(timedatectl_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/tracepath.md

@@ -2,10 +2,15 @@
 # jc.parsers.tracepath
 jc - JSON CLI output utility tracepath Parser
 
-Usage:
+Usage (cli):
 
     specify --tracepath as the first argument if the piped input is coming from tracepath
 
+Usage (module):
+
+    import jc.parsers.tracepath
+    result = jc.parsers.tracepath.parse(tracepath_command_output)
+
 Compatibility:
 
     'linux'

docs/parsers/traceroute.md

@@ -2,7 +2,7 @@
 # jc.parsers.traceroute
 jc - JSON CLI output utility traceroute Parser
 
-Usage:
+Usage (cli):
 
     specify --traceroute as the first argument if the piped input is coming from traceroute
 
@@ -12,6 +12,11 @@ Usage:
 
           e.g. $ traceroute 8.8.8.8 2>&1 | jc --traceroute
 
+Usage (module):
+
+    import jc.parsers.traceroute
+    result = jc.parsers.traceroute.parse(traceroute_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

docs/parsers/uname.md

@@ -2,9 +2,14 @@
 # jc.parsers.uname
 jc - JSON CLI output utility uname Parser
 
-Usage:
+Usage (cli):
 
-    specify --uname as the first argument if the piped input is coming from uname
+    specify --uname as the first argument if the piped input is coming from uname -a
+
+Usage (module):
+
+    import jc.parsers.uname
+    result = jc.parsers.uname.parse(uname_command_output)
 
 Limitations:
 

docs/parsers/uptime.md

@@ -2,10 +2,15 @@
 # jc.parsers.uptime
 jc - JSON CLI output utility uptime Parser
 
-Usage:
+Usage (cli):
 
     specify --uptime as the first argument if the piped input is coming from uptime
 
+Usage (module):
+
+    import jc.parsers.uptime
+    result = jc.parsers.uptime.parse(uptime_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/w.md

@@ -2,10 +2,15 @@
 # jc.parsers.w
 jc - JSON CLI output utility w Parser
 
-Usage:
+Usage (cli):
 
     specify --w as the first argument if the piped input is coming from w
 
+Usage (module):
+
+    import jc.parsers.w
+    result = jc.parsers.w.parse(w_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/who.md

@@ -2,12 +2,17 @@
 # jc.parsers.who
 jc - JSON CLI output utility who Parser
 
-Usage:
+Usage (cli):
 
     specify --who as the first argument if the piped input is coming from who
 
     accepts any of the following who options (or no options): -aTH
 
+Usage (module):
+
+    import jc.parsers.who
+    result = jc.parsers.who.parse(who_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

docs/parsers/xml.md

@@ -2,10 +2,15 @@
 # jc.parsers.xml
 jc - JSON CLI output utility XML Parser
 
-Usage:
+Usage (cli):
 
     specify --xml as the first argument if the piped input is coming from an XML file
 
+Usage (module):
+
+    import jc.parsers.xml
+    result = jc.parsers.xml.parse(xml_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

docs/parsers/yaml.md

@@ -2,10 +2,15 @@
 # jc.parsers.yaml
 jc - JSON CLI output utility YAML Parser
 
-Usage:
+Usage (cli):
 
     specify --yaml as the first argument if the piped input is coming from a YAML file
 
+Usage (module):
+
+    import jc.parsers.yaml
+    result = jc.parsers.yaml.parse(yaml_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/airport.py

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

jc/parsers/airport_s.py

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

jc/parsers/arp.py

@@ -1,6 +1,6 @@
 """jc - JSON CLI output utility arp Parser
 
-Usage:
+Usage (cli):
 
     specify --arp as the first argument if the piped input is coming from:
 
@@ -8,6 +8,11 @@ Usage:
       or
     arp -a
 
+Usage (module):
+
+    import jc.parsers.arp
+    result = jc.parsers.arp.parse(arp_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

jc/parsers/blkid.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility blkid Parser
 
-Usage:
+Usage (cli):
 
     specify --blkid as the first argument if the piped input is coming from blkid
 
+Usage (module):
+
+    import jc.parsers.blkid
+    result = jc.parsers.blkid.parse(blkid_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/crontab.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility crontab command and file Parser
 
-Usage:
+Usage (cli):
 
     specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
 
+Usage (module):
+
+    import jc.parsers.crontab
+    result = jc.parsers.crontab.parse(crontab_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/crontab_u.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility crontab file Parser
 
-Usage:
+Usage (cli):
 
     specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
 
+Usage (module):
+
+    import jc.parsers.crontab_u
+    result = jc.parsers.crontab_u.parse(crontab_u_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/csv.py

@@ -1,12 +1,17 @@
 """jc - JSON CLI output utility csv Parser
 
-Usage:
+Usage (cli):
 
     specify --csv as the first argument if the piped input is coming from a csv file.
     the csv parser will attempt to automatically detect the delimiter character.
     if the delimiter cannot be detected it will default to comma.
     the first row of the file must be a header row.
 
+Usage (module):
+
+    import jc.parsers.csv
+    result = jc.parsers.csv.parse(csv_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/date.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility date Parser
 
-Usage:
+Usage (cli):
 
     specify --date as the first argument if the piped input is coming from date
 
+Usage (module):
+
+    import jc.parsers.date
+    result = jc.parsers.date.parse(date_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

jc/parsers/df.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility df Parser
 
-Usage:
+Usage (cli):
 
     specify --df as the first argument if the piped input is coming from df
 
+Usage (module):
+
+    import jc.parsers.df
+    result = jc.parsers.df.parse(df_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

jc/parsers/dig.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility dig Parser
 
-Usage:
+Usage (cli):
 
     Specify --dig as the first argument if the piped input is coming from dig
 
+Usage (module):
+
+    import jc.parsers.dig
+    result = jc.parsers.dig.parse(dig_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/dmidecode.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility dmidecode Parser
 
-Usage:
+Usage (cli):
 
     specify --dmidecode as the first argument if the piped input is coming from dmidecode
 
+Usage (module):
+
+    import jc.parsers.dmidecode
+    result = jc.parsers.dmidecode.parse(dmidecode_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/du.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility du Parser
 
-Usage:
+Usage (cli):
 
     specify --du as the first argument if the piped input is coming from du
 
+Usage (module):
+
+    import jc.parsers.du
+    result = jc.parsers.du.parse(du_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/env.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility env Parser
 
-Usage:
+Usage (cli):
 
     specify --env as the first argument if the piped input is coming from env
 
+Usage (module):
+
+    import jc.parsers.env
+    result = jc.parsers.env.parse(env_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/file.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility file command Parser
 
-Usage:
+Usage (cli):
 
     specify --file as the first argument if the piped input is coming from file.
 
+Usage (module):
+
+    import jc.parsers.file
+    result = jc.parsers.file.parse(file_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

jc/parsers/foo.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility foo Parser
 
-Usage:
+Usage (cli):
 
     specify --foo as the first argument if the piped input is coming from foo
 
+Usage (module):
+
+    import jc.parsers.foo
+    result = jc.parsers.foo.parse(foo_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/free.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility free Parser
 
-Usage:
+Usage (cli):
 
     specify --free as the first argument if the piped input is coming from free
 
+Usage (module):
+
+    import jc.parsers.free
+    result = jc.parsers.free.parse(free_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/fstab.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility fstab Parser
 
-Usage:
+Usage (cli):
 
     specify --fstab as the first argument if the piped input is coming from a fstab file
 
+Usage (module):
+
+    import jc.parsers.fstab
+    result = jc.parsers.fstab.parse(fstab_command_output)
+
 Compatibility:
 
     'linux', 'freebsd'

jc/parsers/group.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility /etc/group file Parser
 
-Usage:
+Usage (cli):
 
     specify --group as the first argument if the piped input is coming from /etc/group
 
+Usage (module):
+
+    import jc.parsers.group
+    result = jc.parsers.group.parse(group_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/gshadow.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility /etc/gshadow file Parser
 
-Usage:
+Usage (cli):
 
     specify --gshadow as the first argument if the piped input is coming from /etc/gshadow
 
+Usage (module):
+
+    import jc.parsers.gshadow
+    result = jc.parsers.gshadow.parse(gshadow_file_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd'

jc/parsers/history.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility history Parser
 
-Usage:
+Usage (cli):
 
     specify --history as the first argument if the piped input is coming from history
 
+Usage (module):
+
+    import jc.parsers.history
+    result = jc.parsers.history.parse(history_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

jc/parsers/hosts.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility hosts Parser
 
-Usage:
+Usage (cli):
 
     specify --hosts as the first argument if the piped input is coming from a hosts file
 
+Usage (module):
+
+    import jc.parsers.hosts
+    result = jc.parsers.hosts.parse(hosts_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/id.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility id Parser
 
-Usage:
+Usage (cli):
 
     specify --id as the first argument if the piped input is coming from id
 
+Usage (module):
+
+    import jc.parsers.id
+    result = jc.parsers.id.parse(id_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/ifconfig.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility ifconfig Parser
 
-Usage:
+Usage (cli):
 
     specify --ifconfig as the first argument if the piped input is coming from ifconfig
 
     no ifconfig options are supported.
 
+Usage (module):
+
+    import jc.parsers.ifconfig
+    result = jc.parsers.ifconfig.parse(ifconfig_command_output)
+
 Compatibility:
 
     'linux', 'aix', 'freebsd', 'darwin'

jc/parsers/ini.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility INI Parser
 
-Usage:
+Usage (cli):
 
     Specify --ini as the first argument if the piped input is coming from an INI file or any
     simple key/value pair file. Delimiter can be '=' or ':'. Missing values are supported.
     Comment prefix can be '#' or ';'. Comments must be on their own line.
 
+Usage (module):
+
+    import jc.parsers.ini
+    result = jc.parsers.ini.parse(ini_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/iptables.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility ipables Parser
 
-Usage:
+Usage (cli):
 
     Specify --iptables as the first argument if the piped input is coming from iptables
 
     Supports -vLn and --line-numbers for all tables
 
+Usage (module):
+
+    import jc.parsers.iptables
+    result = jc.parsers.iptables.parse(iptables_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/jobs.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility jobs Parser
 
-Usage:
+Usage (cli):
 
     specify --jobs as the first argument if the piped input is coming from jobs
 
     Also supports the -l option
 
+Usage (module):
+
+    import jc.parsers.jobs
+    result = jc.parsers.jobs.parse(jobs_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

jc/parsers/kv.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility Key/Value File Parser
 
-Usage:
+Usage (cli):
 
     Specify --kv as the first argument if the piped input is coming from a simple
     key/value pair file. Delimiter can be '=' or ':'. Missing values are supported.
     Comment prefix can be '#' or ';'. Comments must be on their own line.
 
+Usage (module):
+
+    import jc.parsers.kv
+    result = jc.parsers.kv.parse(kv_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/last.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility last Parser
 
-Usage:
+Usage (cli):
 
     specify --last as the first argument if the piped input is coming from last or lastb
 
+Usage (module):
+
+    import jc.parsers.last
+    result = jc.parsers.last.parse(last_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/ls.py

@@ -4,7 +4,7 @@ Note: The -l or -b option of ls should be used to correctly parse filenames that
       Since ls does not encode newlines in filenames when outputting to a pipe it will cause jc to see
       multiple files instead of a single file if -l or -b is not used.
 
-Usage:
+Usage (cli):
 
     specify --ls as the first argument if the piped input is coming from ls
 
@@ -16,6 +16,11 @@ Usage:
                                with human readable suffixes will be converted to Null in default view
                                since the parser attempts to convert this field to an integer.
 
+Usage (module):
+
+    import jc.parsers.ls
+    result = jc.parsers.ls.parse(ls_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

jc/parsers/lsblk.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility lsblk Parser
 
-Usage:
+Usage (cli):
 
     specify --lsblk as the first argument if the piped input is coming from lsblk
 
+Usage (module):
+
+    import jc.parsers.lsblk
+    result = jc.parsers.lsblk.parse(lsblk_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/lsmod.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility lsmod Parser
 
-Usage:
+Usage (cli):
 
     specify --lsmod as the first argument if the piped input is coming from lsmod
 
+Usage (module):
+
+    import jc.parsers.lsmod
+    result = jc.parsers.lsmod.parse(lsmod_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/lsof.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility lsof Parser
 
-Usage:
+Usage (cli):
 
     specify --lsof as the first argument if the piped input is coming from lsof
 
+Usage (module):
+
+    import jc.parsers.lsof
+    result = jc.parsers.lsof.parse(lsof_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/mount.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility mount Parser
 
-Usage:
+Usage (cli):
 
     specify --mount as the first argument if the piped input is coming from mount
 
+Usage (module):
+
+    import jc.parsers.mount
+    result = jc.parsers.mount.parse(mount_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

jc/parsers/netstat.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility netstat Parser
 
-Usage:
+Usage (cli):
 
     Specify --netstat as the first argument if the piped input is coming from netstat
 
+Usage (module):
+
+    import jc.parsers.netstat
+    result = jc.parsers.netstat.parse(netstat_command_output)
+
 Caveats:
 
     - Use of multiple 'l' options is not supported on OSX (e.g. 'netstat -rlll')

jc/parsers/ntpq.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility ntpq Parser
 
-Usage:
+Usage (cli):
 
     specify --ntpq as the first argument if the piped input is coming from ntpq -p
 
+Usage (module):
+
+    import jc.parsers.ntpq
+    result = jc.parsers.ntpq.parse(ntpq_command_output)
+
 Compatibility:
 
     'linux', 'freebsd'

jc/parsers/passwd.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility /etc/passwd file Parser
 
-Usage:
+Usage (cli):
 
     specify --passwd as the first argument if the piped input is coming from /etc/passwd
 
+Usage (module):
+
+    import jc.parsers.passwd
+    result = jc.parsers.passwd.parse(passwd_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/ping.py

@@ -1,11 +1,16 @@
 """jc - JSON CLI output utility ping Parser
 
-Usage:
+Usage (cli):
 
     specify --ping as the first argument if the piped input is coming from ping
 
     Note:  Use the ping -c (count) option, otherwise data will not be piped to jc.
 
+Usage (module):
+
+    import jc.parsers.ping
+    result = jc.parsers.ping.parse(ping_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'

jc/parsers/pip_list.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility pip-list Parser
 
-Usage:
+Usage (cli):
 
     specify --pip-list as the first argument if the piped input is coming from pip list
 
+Usage (module):
+
+    import jc.parsers.pip_list
+    result = jc.parsers.pip_list.parse(pip_list_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/pip_show.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility pip-show Parser
 
-Usage:
+Usage (cli):
 
     specify --pip-show as the first argument if the piped input is coming from pip show
 
+Usage (module):
+
+    import jc.parsers.pip_show
+    result = jc.parsers.pip_show.parse(pip_show_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

jc/parsers/ps.py

@@ -1,6 +1,6 @@
 """jc - JSON CLI output utility ps Parser
 
-Usage:
+Usage (cli):
 
     specify --ps as the first argument if the piped input is coming from ps
 
@@ -8,6 +8,11 @@ Usage:
     - ef
     - axu
 
+Usage (module):
+
+    import jc.parsers.ps
+    result = jc.parsers.ps.parse(ps_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

jc/parsers/route.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility route Parser
 
-Usage:
+Usage (cli):
 
     specify --route as the first argument if the piped input is coming from route
 
+Usage (module):
+
+    import jc.parsers.route
+    result = jc.parsers.route.parse(route_command_output)
+
 Compatibility:
 
     'linux'

jc/parsers/shadow.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility /etc/shadow file Parser
 
-Usage:
+Usage (cli):
 
     specify --shadow as the first argument if the piped input is coming from /etc/shadow
 
+Usage (module):
+
+    import jc.parsers.shadow
+    result = jc.parsers.shadow.parse(shadow_file_output)
+
 Compatibility:
 
     'linux', 'darwin', 'aix', 'freebsd'

jc/parsers/ss.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility ss Parser
 
-Usage:
+Usage (cli):
 
     specify --ss as the first argument if the piped input is coming from ss
 
+Usage (module):
+
+    import jc.parsers.ss
+    result = jc.parsers.ss.parse(ss_command_output)
+
 Limitations:
 
     Extended information options like -e and -p are not supported and may cause parsing irregularities

jc/parsers/stat.py

@@ -1,9 +1,14 @@
 """jc - JSON CLI output utility stat Parser
 
-Usage:
+Usage (cli):
 
     specify --stat as the first argument if the piped input is coming from stat
 
+Usage (module):
+
+    import jc.parsers.stat
+    result = jc.parsers.stat.parse(stat_command_output)
+
 Compatibility:
 
     'linux', 'darwin', 'freebsd'