diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index 3735793d..b5022cd0 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -1,3 +1,4 @@ + # jc.parsers.airport jc - JSON CLI output utility airport -I Parser @@ -52,11 +53,13 @@ Examples: "channel": "48,80" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -90,6 +93,7 @@ Returns: "channel": string } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index 992fc78d..16fc0db3 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -1,3 +1,4 @@ + # jc.parsers.airport_s jc - JSON CLI output utility airport -s Parser @@ -84,11 +85,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -117,6 +120,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 569fdcfd..eba14ac0 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -1,3 +1,4 @@ + # jc.parsers.arp jc - JSON CLI output utility arp Parser @@ -95,11 +96,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -128,6 +131,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index ce74297e..a6399714 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -1,3 +1,4 @@ + # jc.parsers.blkid jc - JSON CLI output utility blkid Parser @@ -75,11 +76,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -129,6 +132,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index c6d63870..03513098 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -1,3 +1,4 @@ + # jc.parsers.crontab jc - JSON CLI output utility crontab command and file Parser @@ -128,11 +129,13 @@ Examples: ] } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -178,6 +181,7 @@ Returns: } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index 9dfbbe52..f58c4559 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -1,3 +1,4 @@ + # jc.parsers.crontab_u jc - JSON CLI output utility crontab file Parser @@ -129,11 +130,13 @@ Examples: + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -180,6 +183,7 @@ Returns: } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 95af2cd9..f1b1dda4 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -1,3 +1,4 @@ + # jc.parsers.csv jc - JSON CLI output utility csv Parser @@ -59,11 +60,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -86,6 +89,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index c990b202..414519c0 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -1,3 +1,4 @@ + # jc.parsers.df jc - JSON CLI output utility df Parser @@ -69,11 +70,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -106,6 +109,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index 0b6ec4c8..f60c223c 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -1,3 +1,4 @@ + # jc.parsers.dig jc - JSON CLI output utility dig Parser @@ -321,11 +322,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -393,6 +396,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index cd37e567..9e35ca34 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -1,3 +1,4 @@ + # jc.parsers.dmidecode jc - JSON CLI output utility dmidecode Parser @@ -99,11 +100,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -134,6 +137,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index b4184abe..c470cfab 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -1,3 +1,4 @@ + # jc.parsers.du jc - JSON CLI output utility du Parser @@ -69,11 +70,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -96,6 +99,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 4ce02d0d..91daa51d 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -1,3 +1,4 @@ + # jc.parsers.env jc - JSON CLI output utility env Parser @@ -49,11 +50,13 @@ Examples: "_": "/usr/bin/env" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -76,6 +79,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/file.md b/docs/parsers/file.md index f7e4e7b1..cb2db0ff 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -1,3 +1,4 @@ + # jc.parsers.file jc - JSON CLI output utility file command Parser @@ -44,11 +45,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -71,6 +74,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 7f8bcdab..98de23d9 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -1,3 +1,4 @@ + # jc.parsers.free jc - JSON CLI output utility free Parser @@ -49,11 +50,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -81,6 +84,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index 3861b180..9c80c7bd 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -1,3 +1,4 @@ + # jc.parsers.fstab jc - JSON CLI output utility fstab Parser @@ -67,11 +68,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -98,6 +101,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 9c064b93..6cc45779 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -1,3 +1,4 @@ + # jc.parsers.group jc - JSON CLI output utility /etc/group file Parser @@ -91,11 +92,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -122,6 +125,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index bb7db2b1..c21edc38 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -1,3 +1,4 @@ + # jc.parsers.gshadow jc - JSON CLI output utility /etc/gshadow file Parser @@ -57,11 +58,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -90,6 +93,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 5b828431..52de5958 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -1,3 +1,4 @@ + # jc.parsers.history jc - JSON CLI output utility history Parser @@ -41,11 +42,13 @@ Examples: ... } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -68,6 +71,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index c020b863..da0b7540 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -1,3 +1,4 @@ + # jc.parsers.hosts jc - JSON CLI output utility hosts Parser @@ -58,11 +59,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -87,6 +90,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/id.md b/docs/parsers/id.md index 66775e46..4615049c 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -1,3 +1,4 @@ + # jc.parsers.id jc - JSON CLI output utility id Parser @@ -67,11 +68,13 @@ Examples: } } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -114,6 +117,7 @@ Returns: } } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 366cdb41..7e60adc4 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -1,3 +1,4 @@ + # jc.parsers.ifconfig jc - JSON CLI output utility ifconfig Parser @@ -142,19 +143,16 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## IfconfigParser ```python -IfconfigParser(self, console_output) -``` - -## InterfaceNotFound -```python -InterfaceNotFound(self, /, *args, **kwargs) +IfconfigParser(console_output) ``` @@ -206,6 +204,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index 4067caca..542cf236 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -1,3 +1,4 @@ + # jc.parsers.ini jc - JSON CLI output utility INI Parser @@ -45,11 +46,13 @@ Examples: } } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -73,6 +76,7 @@ Returns: If you would like to keep the quotation marks, use the -r or raw=True argument. } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 5bc16633..8504b599 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -1,3 +1,4 @@ + # jc.parsers.iptables jc - JSON CLI output utility ipables Parser @@ -131,11 +132,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -172,6 +175,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index 63d6e568..8332f82a 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -1,3 +1,4 @@ + # jc.parsers.jobs jc - JSON CLI output utility jobs Parser @@ -73,11 +74,13 @@ Example: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -103,6 +106,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md new file mode 100644 index 00000000..ce75cc0c --- /dev/null +++ b/docs/parsers/kv.md @@ -0,0 +1,61 @@ + +# jc.parsers.kv +jc - JSON CLI output utility Key/Value File Parser + +Usage: + + 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. + +Compatibility: + + 'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd' + +Examples: + + $ cat keyvalue.txt + # this file contains key/value pairs + name = John Doe + address=555 California Drive + age: 34 + ; comments can include # or ; + # delimiter can be = or : + # quoted values have quotation marks stripped by default + # but can be preserved with the -r argument + occupation:"Engineer" + + $ cat keyvalue.txt | jc --ini -p + { + "name": "John Doe", + "address": "555 California Drive", + "age": "34", + "occupation": "Engineer" + } + + +## info +```python +info() +``` + + +## parse +```python +parse(data, raw=False, quiet=False) +``` + +Main text parsing function + + Note: this is just a wrapper for jc.parsers.ini + +Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + +Returns: + + Dictionary representing the key/value file + diff --git a/docs/parsers/last.md b/docs/parsers/last.md index 3b4fffe9..677c395b 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -1,3 +1,4 @@ + # jc.parsers.last jc - JSON CLI output utility last Parser @@ -68,11 +69,13 @@ Examples: ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -99,6 +102,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index d1f4ba3e..3b24c370 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -1,3 +1,4 @@ + # jc.parsers.ls jc - JSON CLI output utility ls Parser @@ -145,11 +146,13 @@ Examples: "date": "May 3 2019" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -178,6 +181,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 3c68f898..d2df5fa8 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -1,3 +1,4 @@ + # jc.parsers.lsblk jc - JSON CLI output utility lsblk Parser @@ -212,11 +213,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -277,6 +280,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index 98bd1fed..eb9753fc 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -1,3 +1,4 @@ + # jc.parsers.lsmod jc - JSON CLI output utility lsmod Parser @@ -103,11 +104,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -134,6 +137,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 5b188e6d..8ffe8704 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -1,3 +1,4 @@ + # jc.parsers.lsof jc - JSON CLI output utility lsof Parser @@ -93,11 +94,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -128,6 +131,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 50c388aa..0f0dd30b 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -1,3 +1,4 @@ + # jc.parsers.mount jc - JSON CLI output utility mount Parser @@ -53,11 +54,13 @@ Example: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -84,6 +87,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index e2bbdad4..7068f4ce 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -1,3 +1,4 @@ + # jc.parsers.netstat jc - JSON CLI output utility netstat Parser @@ -245,11 +246,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -364,6 +367,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index 9d31742a..b5ce9725 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -1,3 +1,4 @@ + # jc.parsers.ntpq jc - JSON CLI output utility ntpq Parser @@ -179,11 +180,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -216,6 +219,7 @@ Returns: ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index d1acfd64..78d9f103 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -1,3 +1,4 @@ + # jc.parsers.passwd jc - JSON CLI output utility /etc/passwd file Parser @@ -75,11 +76,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -107,6 +110,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index 59e2e50a..e9a102f5 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -1,3 +1,4 @@ + # jc.parsers.ping jc - JSON CLI output utility ping Parser @@ -104,11 +105,13 @@ Examples: ] } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -152,6 +155,7 @@ Returns: ] } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index ba21588c..e450f7a0 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -1,3 +1,4 @@ + # jc.parsers.pip_list jc - JSON CLI output utility pip-list Parser @@ -28,11 +29,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -56,6 +59,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index 95234ae1..222db7ad 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -1,3 +1,4 @@ + # jc.parsers.pip_show jc - JSON CLI output utility pip-show Parser @@ -39,11 +40,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -75,6 +78,7 @@ Returns: ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index 64f77454..61648b0f 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -1,3 +1,4 @@ + # jc.parsers.ps jc - JSON CLI output utility ps Parser @@ -173,11 +174,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -215,6 +218,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/route.md b/docs/parsers/route.md index d2206f81..bdad5dd1 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -1,3 +1,4 @@ + # jc.parsers.route jc - JSON CLI output utility route Parser @@ -80,11 +81,13 @@ Examples: ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -119,6 +122,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index 93efff94..5dd3ba2d 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -1,3 +1,4 @@ + # jc.parsers.shadow jc - JSON CLI output utility /etc/shadow file Parser @@ -81,11 +82,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -114,6 +117,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 2f97142f..ad82eb79 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -1,3 +1,4 @@ + # jc.parsers.ss jc - JSON CLI output utility ss Parser @@ -247,11 +248,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -289,6 +292,7 @@ Returns: Information from https://www.cyberciti.biz/files/ss.html used to define field names + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index 20b6f3b1..98c9debf 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -1,3 +1,4 @@ + # jc.parsers.stat jc - JSON CLI output utility stat Parser @@ -101,11 +102,13 @@ Examples: .. ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -149,6 +152,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index a511d69e..316713b9 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -1,3 +1,4 @@ + # jc.parsers.sysctl jc - JSON CLI output utility sysctl -a Parser @@ -39,11 +40,13 @@ Examples: ... } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -65,6 +68,7 @@ Returns: "baz": string/integer/float } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 013cbcf0..1b6ae7ad 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -1,3 +1,4 @@ + # jc.parsers.systemctl jc - JSON CLI output utility systemctl Parser @@ -37,11 +38,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -67,6 +70,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 52bd510d..c98c5033 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -1,3 +1,4 @@ + # jc.parsers.systemctl_lj jc - JSON CLI output utility systemctl-lj Parser @@ -56,11 +57,13 @@ Examples: ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -85,6 +88,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index 181f38ef..d40adce2 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -1,3 +1,4 @@ + # jc.parsers.systemctl_ls jc - JSON CLI output utility systemctl-ls Parser @@ -31,11 +32,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -59,6 +62,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index 59a1b5a7..0a09dc17 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -1,3 +1,4 @@ + # jc.parsers.systemctl_luf jc - JSON CLI output utility systemctl-luf Parser @@ -28,11 +29,13 @@ Examples: ... ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -55,6 +58,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 1f7f86b2..1e927c90 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -1,3 +1,4 @@ + # jc.parsers.timedatectl jc - JSON CLI output utility timedatectl Parser @@ -35,11 +36,13 @@ Examples: "dst_active": "yes" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -68,6 +71,7 @@ Returns: "dst_active": boolean } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index 16bffe7d..935cbfb9 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -1,3 +1,4 @@ + # jc.parsers.tracepath jc - JSON CLI output utility tracepath Parser @@ -102,11 +103,13 @@ Examples: } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -139,6 +142,7 @@ Returns: ] } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index 4c6a2f5b..e87757b7 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -1,3 +1,4 @@ + # jc.parsers.traceroute jc - JSON CLI output utility traceroute Parser @@ -84,16 +85,19 @@ Examples: ] } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## Hop ```python -Hop(self, idx) +Hop(idx) ``` + ## process ```python process(proc_data) @@ -128,6 +132,7 @@ Returns: ] } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 51de96d1..b91e5c60 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -1,3 +1,4 @@ + # jc.parsers.uname jc - JSON CLI output utility uname Parser @@ -27,11 +28,13 @@ Example: "kernel_version": "#74-Ubuntu SMP Tue Sep 17 17:06:04 UTC 2019" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -58,6 +61,7 @@ Returns: "kernel_version": string } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 3a86f301..31a44f91 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -1,3 +1,4 @@ + # jc.parsers.uptime jc - JSON CLI output utility uptime Parser @@ -31,11 +32,13 @@ Example: "load_15m": "0.05" } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -60,6 +63,7 @@ Returns: "load_15m": float } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 5427d7cd..1c765bcd 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -1,3 +1,4 @@ + # jc.parsers.w jc - JSON CLI output utility w Parser @@ -79,11 +80,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -112,6 +115,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/who.md b/docs/parsers/who.md index 8c2d7545..97011315 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -1,3 +1,4 @@ + # jc.parsers.who jc - JSON CLI output utility who Parser @@ -99,11 +100,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -133,6 +136,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index 96044cf1..9189f932 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -1,3 +1,4 @@ + # jc.parsers.xml jc - JSON CLI output utility XML Parser @@ -55,11 +56,13 @@ Examples: ... } + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -80,6 +83,7 @@ Returns: See https://github.com/martinblech/xmltodict for details } + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index 92a2eb16..f63843c3 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -1,3 +1,4 @@ + # jc.parsers.yaml jc - JSON CLI output utility YAML Parser @@ -67,11 +68,13 @@ Examples: } ] + ## info ```python -info(self, /, *args, **kwargs) +info() ``` + ## process ```python process(proc_data) @@ -94,6 +97,7 @@ Returns: } ] + ## parse ```python parse(data, raw=False, quiet=False) diff --git a/docs/readme.md b/docs/readme.md index 57faa5e9..c5d7401d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,3 +1,4 @@ + # jc JC - JSON CLI output utility diff --git a/docs/utils.md b/docs/utils.md index 9e8cb633..8fe5f7a9 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -1,5 +1,7 @@ + # utils jc - JSON CLI output utility utils + ## warning_message ```python warning_message(message) @@ -15,6 +17,7 @@ Returns: no return, just prints output to STDERR + ## error_message ```python error_message(message) @@ -30,6 +33,7 @@ Returns: no return, just prints output to STDERR + ## compatibility ```python compatibility(mod_name, compatible) @@ -48,6 +52,7 @@ Returns: no return, just prints output to STDERR + ## has_data ```python has_data(data)