diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index ecf0122b..4fe8827d 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -13,6 +13,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('acpi', acpi_command_output) + + or + import jc.parsers.acpi result = jc.parsers.acpi.parse(acpi_command_output) diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index b45bde86..f286f9f6 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -15,6 +15,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('airport', airport_command_output) + + or + import jc.parsers.airport result = jc.parsers.airport.parse(airport_command_output) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index 49fb032d..30d81e84 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -15,6 +15,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('airport_s', airport_s_command_output) + + or + import jc.parsers.airport_s result = jc.parsers.airport_s.parse(airport_s_command_output) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 223b5219..b593a6e1 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -15,6 +15,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('arp', arp_command_output) + + or + import jc.parsers.arp result = jc.parsers.arp.parse(arp_command_output) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index 94ae4308..1b9b7b16 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -13,6 +13,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('blkid', blkid_command_output) + + or + import jc.parsers.blkid result = jc.parsers.blkid.parse(blkid_command_output) diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index e278bac6..564d28a9 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -17,6 +17,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('cksum', cksum_command_output) + + or + import jc.parsers.cksum result = jc.parsers.cksum.parse(cksum_command_output) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index 553ddf0a..09031ec0 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -15,6 +15,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('crontab', crontab_output) + + or + import jc.parsers.crontab result = jc.parsers.crontab.parse(crontab_output) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index 570b673f..58d14e0d 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -11,6 +11,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('crontab_u', crontab_u_output) + + or + import jc.parsers.crontab_u result = jc.parsers.crontab_u.parse(crontab_u_output) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 91936dc8..dcc1f81b 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -11,6 +11,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('csv', csv_output) + + or + import jc.parsers.csv result = jc.parsers.csv.parse(csv_output) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 1d462e2f..3f01a0f3 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -15,6 +15,13 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('csv_s', csv_output.splitlines()) # result is an iterable object + for item in result: + # do something + + or + import jc.parsers.csv_s result = jc.parsers.csv_s.parse(csv_output.splitlines()) # result is an iterable object for item in result: diff --git a/docs/parsers/date.md b/docs/parsers/date.md index 4872bf4c..2c3c1c26 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -17,6 +17,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('date', date_command_output) + + or + import jc.parsers.date result = jc.parsers.date.parse(date_command_output) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index 5db298d2..5d82f657 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -13,6 +13,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('df', df_command_output) + + or + import jc.parsers.df result = jc.parsers.df.parse(df_command_output) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index c4abdcd1..7b852be0 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -21,6 +21,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dig', dig_command_output) + + or + import jc.parsers.dig result = jc.parsers.dig.parse(dig_command_output) diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index a7a48e69..ed6a1e15 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -19,6 +19,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dir', dir_command_output) + + or + import jc.parsers.dir result = jc.parsers.dir.parse(dir_command_output) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index 5be09999..214b0fb1 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -13,6 +13,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dmidecode', dmidecode_command_output) + + or + import jc.parsers.dmidecode result = jc.parsers.dmidecode.parse(dmidecode_command_output) diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index 706847f5..99479e62 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -17,6 +17,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dpkg_l', dpkg_command_output) + + or + import jc.parsers.dpkg_l result = jc.parsers.dpkg_l.parse(dpkg_command_output) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 5e795d39..96233fbd 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -13,6 +13,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('du', du_command_output) + + or + import jc.parsers.du result = jc.parsers.du.parse(du_command_output) diff --git a/jc/parsers/acpi.py b/jc/parsers/acpi.py index 24225a55..30cf5b1d 100644 --- a/jc/parsers/acpi.py +++ b/jc/parsers/acpi.py @@ -10,6 +10,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('acpi', acpi_command_output) + + or + import jc.parsers.acpi result = jc.parsers.acpi.parse(acpi_command_output) diff --git a/jc/parsers/airport.py b/jc/parsers/airport.py index 174ae851..6d022850 100644 --- a/jc/parsers/airport.py +++ b/jc/parsers/airport.py @@ -12,6 +12,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('airport', airport_command_output) + + or + import jc.parsers.airport result = jc.parsers.airport.parse(airport_command_output) diff --git a/jc/parsers/airport_s.py b/jc/parsers/airport_s.py index cbf5203c..9fd18aa3 100644 --- a/jc/parsers/airport_s.py +++ b/jc/parsers/airport_s.py @@ -12,6 +12,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('airport_s', airport_s_command_output) + + or + import jc.parsers.airport_s result = jc.parsers.airport_s.parse(airport_s_command_output) diff --git a/jc/parsers/arp.py b/jc/parsers/arp.py index 664ec6e0..180c8e36 100644 --- a/jc/parsers/arp.py +++ b/jc/parsers/arp.py @@ -12,6 +12,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('arp', arp_command_output) + + or + import jc.parsers.arp result = jc.parsers.arp.parse(arp_command_output) diff --git a/jc/parsers/blkid.py b/jc/parsers/blkid.py index 0a4af511..b1d920c1 100644 --- a/jc/parsers/blkid.py +++ b/jc/parsers/blkid.py @@ -10,6 +10,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('blkid', blkid_command_output) + + or + import jc.parsers.blkid result = jc.parsers.blkid.parse(blkid_command_output) diff --git a/jc/parsers/cksum.py b/jc/parsers/cksum.py index d1004fdc..8083de92 100644 --- a/jc/parsers/cksum.py +++ b/jc/parsers/cksum.py @@ -14,6 +14,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('cksum', cksum_command_output) + + or + import jc.parsers.cksum result = jc.parsers.cksum.parse(cksum_command_output) diff --git a/jc/parsers/crontab.py b/jc/parsers/crontab.py index c2a52397..d933e771 100644 --- a/jc/parsers/crontab.py +++ b/jc/parsers/crontab.py @@ -12,6 +12,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('crontab', crontab_output) + + or + import jc.parsers.crontab result = jc.parsers.crontab.parse(crontab_output) diff --git a/jc/parsers/crontab_u.py b/jc/parsers/crontab_u.py index 93c0b6af..eeadb6cb 100644 --- a/jc/parsers/crontab_u.py +++ b/jc/parsers/crontab_u.py @@ -8,6 +8,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('crontab_u', crontab_u_output) + + or + import jc.parsers.crontab_u result = jc.parsers.crontab_u.parse(crontab_u_output) diff --git a/jc/parsers/csv.py b/jc/parsers/csv.py index 539d961b..7a32489a 100644 --- a/jc/parsers/csv.py +++ b/jc/parsers/csv.py @@ -8,6 +8,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('csv', csv_output) + + or + import jc.parsers.csv result = jc.parsers.csv.parse(csv_output) diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index f152bdc7..4e030cce 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -12,6 +12,13 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('csv_s', csv_output.splitlines()) # result is an iterable object + for item in result: + # do something + + or + import jc.parsers.csv_s result = jc.parsers.csv_s.parse(csv_output.splitlines()) # result is an iterable object for item in result: diff --git a/jc/parsers/date.py b/jc/parsers/date.py index 1e6671c2..c022d98f 100644 --- a/jc/parsers/date.py +++ b/jc/parsers/date.py @@ -14,6 +14,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('date', date_command_output) + + or + import jc.parsers.date result = jc.parsers.date.parse(date_command_output) diff --git a/jc/parsers/df.py b/jc/parsers/df.py index edc2bfae..ea69e35b 100644 --- a/jc/parsers/df.py +++ b/jc/parsers/df.py @@ -10,6 +10,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('df', df_command_output) + + or + import jc.parsers.df result = jc.parsers.df.parse(df_command_output) diff --git a/jc/parsers/dig.py b/jc/parsers/dig.py index b09dccca..d1216f66 100644 --- a/jc/parsers/dig.py +++ b/jc/parsers/dig.py @@ -18,6 +18,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dig', dig_command_output) + + or + import jc.parsers.dig result = jc.parsers.dig.parse(dig_command_output) diff --git a/jc/parsers/dir.py b/jc/parsers/dir.py index 9d5045e5..9d8954d4 100644 --- a/jc/parsers/dir.py +++ b/jc/parsers/dir.py @@ -16,6 +16,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dir', dir_command_output) + + or + import jc.parsers.dir result = jc.parsers.dir.parse(dir_command_output) diff --git a/jc/parsers/dmidecode.py b/jc/parsers/dmidecode.py index e3e8ca39..3cd408fd 100644 --- a/jc/parsers/dmidecode.py +++ b/jc/parsers/dmidecode.py @@ -10,6 +10,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dmidecode', dmidecode_command_output) + + or + import jc.parsers.dmidecode result = jc.parsers.dmidecode.parse(dmidecode_command_output) diff --git a/jc/parsers/dpkg_l.py b/jc/parsers/dpkg_l.py index 3fb26974..72328fcb 100644 --- a/jc/parsers/dpkg_l.py +++ b/jc/parsers/dpkg_l.py @@ -14,6 +14,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('dpkg_l', dpkg_command_output) + + or + import jc.parsers.dpkg_l result = jc.parsers.dpkg_l.parse(dpkg_command_output) diff --git a/jc/parsers/du.py b/jc/parsers/du.py index 37d4bb11..984c9173 100644 --- a/jc/parsers/du.py +++ b/jc/parsers/du.py @@ -10,6 +10,11 @@ Usage (cli): Usage (module): + import jc + result = jc.parse('du', du_command_output) + + or + import jc.parsers.du result = jc.parsers.du.parse(du_command_output)