add new high-level api info

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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:

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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:

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)
 

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)
 

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)
 

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)
 

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)
 

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)
 

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)