add about information to parsers

jc/cli.py

@@ -81,16 +81,42 @@ def ctrlc(signum, frame):
 
 def parsers_text():
     ptext = ''
-    for key in parser_map:
+    for parser in parser_map:
-        if hasattr(parser_map[key], 'info'):
+        if hasattr(parser_map[parser], 'info'):
-            padding = 16 - len(key)
+            padding = 16 - len(parser)
             padding_char = ' '
             padding_text = padding_char * padding
-            ptext += '            ' + key + padding_text + parser_map[key].info.description + '\n'
+            ptext += '            ' + parser + padding_text + parser_map[parser].info.description + '\n'
 
     return ptext
 
 
+def about_jc():
+    parser_list = []
+    for parser in parser_map:
+        if hasattr(parser_map[parser], 'info'):
+            parser_entry = {
+                'name': parser_map[parser].__name__.split('.')[-1],
+                'description': parser_map[parser].info.description,
+                'author': parser_map[parser].info.author,
+                'author_email': parser_map[parser].info.author_email,
+                'compatible': parser_map[parser].info.compatible,
+                'details': parser_map[parser].info.details
+            }
+        parser_list.append(parser_entry)
+
+    result = {
+        'name': __name__,
+        'version': info.version,
+        'description': info.description,
+        'author': info.author,
+        'author_email': info.author_email,
+        'parsers': parser_list
+    }
+
+    return result
+
+
 def helptext(message):
     parsers_string = parsers_text()
 
@@ -102,6 +128,7 @@ def helptext(message):
     Parsers:
 {parsers_string}
     Options:
+            -a              about jc
             -d              debug - show trace messages
             -p              pretty print output
             -q              quiet - suppress warnings
@@ -113,14 +140,17 @@ def helptext(message):
     print(textwrap.dedent(helptext_string), file=sys.stderr)
 
 
+def json_out(data, pretty=False):
+    if pretty:
+        print(json.dumps(data, indent=2))
+    else:
+        print(json.dumps(data))
+
+
 def main():
     signal.signal(signal.SIGINT, ctrlc)
 
-    if sys.stdin.isatty():
+    about = False
-        helptext('missing piped data')
-        exit()
-
-    data = sys.stdin.read()
     debug = False
     pretty = False
     quiet = False
@@ -139,15 +169,26 @@ def main():
     if '-r' in sys.argv:
         raw = True
 
+    if '-a' in sys.argv:
+        about = True
+        result = about_jc()
+
+    if sys.stdin.isatty() and not about:
+        helptext('missing piped data')
+        exit()
+
+    if not about:
+        data = sys.stdin.read()
+
     found = False
 
-    if debug:
+    if debug and not about:
         for arg in sys.argv:
             if arg in parser_map:
                 result = parser_map[arg].parse(data, raw=raw, quiet=quiet)
                 found = True
                 break
-    else:
+    elif not about:
         for arg in sys.argv:
             if arg in parser_map:
                 try:
@@ -159,15 +200,11 @@ def main():
                     jc.utils.error_message(f'{parser_name} parser could not parse the input data. Did you use the correct parser?\n         For details use the -d option.')
                     exit(1)
 
-    if not found:
+    if not found and not about:
         helptext('missing or incorrect arguments')
         exit()
 
-    # output resulting dictionary as json
+    json_out(result, pretty=pretty)
-    if pretty:
-        print(json.dumps(result, indent=2))
-    else:
-        print(json.dumps(result))
 
 
 if __name__ == '__main__':

jc/parsers/arp.py

@@ -95,6 +95,7 @@ class info():
     description = 'arp parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'aix', 'freebsd', 'darwin']

jc/parsers/df.py

@@ -77,6 +77,7 @@ class info():
     description = 'df parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin']

jc/parsers/dig.py

@@ -328,6 +328,7 @@ class info():
     description = 'dig parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'aix', 'freebsd', 'darwin']

jc/parsers/env.py

@@ -56,6 +56,7 @@ class info():
     description = 'env parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']

jc/parsers/foo.py

@@ -24,6 +24,7 @@ class info():
     description = 'foo parser'
     author = 'John Doe'
     author_email = 'johndoe@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']

jc/parsers/free.py

@@ -57,6 +57,7 @@ class info():
     description = 'free parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/fstab.py

@@ -74,6 +74,7 @@ class info():
     description = '/etc/fstab file parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/history.py

@@ -48,6 +48,7 @@ class info():
     description = 'history parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']

jc/parsers/hosts.py

@@ -65,6 +65,7 @@ class info():
     description = '/etc/hosts file parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd']

jc/parsers/iptables.py

@@ -138,6 +138,7 @@ class info():
     description = 'iptables parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/jobs.py

@@ -81,6 +81,7 @@ class info():
     description = 'jobs parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']

jc/parsers/ls.py

@@ -148,6 +148,7 @@ class info():
     description = 'ls parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']

jc/parsers/lsblk.py

@@ -220,6 +220,7 @@ class info():
     description = 'lsblk parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/lsmod.py

@@ -111,6 +111,7 @@ class info():
     description = 'lsmod parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/lsof.py

@@ -101,6 +101,7 @@ class info():
     description = 'lsof parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/mount.py

@@ -60,6 +60,7 @@ class info():
     description = 'mount parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin']

jc/parsers/netstat.py

@@ -317,6 +317,7 @@ class info():
     description = 'netstat parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/ps.py

@@ -181,6 +181,7 @@ class info():
     description = 'ps parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']

jc/parsers/route.py

@@ -105,6 +105,7 @@ class info():
     description = 'route parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/ss.py

@@ -255,6 +255,7 @@ class info():
     description = 'ss parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/stat.py

@@ -107,6 +107,7 @@ class info():
     description = 'stat parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/systemctl.py

@@ -44,6 +44,7 @@ class info():
     description = 'systemctl parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/systemctl_lj.py

@@ -63,6 +63,7 @@ class info():
     description = 'systemctl list-jobs parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/systemctl_ls.py

@@ -38,6 +38,7 @@ class info():
     description = 'systemctl list-sockets parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/systemctl_luf.py

@@ -35,6 +35,7 @@ class info():
     description = 'systemctl list-unit-files parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/uname.py

@@ -34,6 +34,7 @@ class info():
     description = 'uname -a parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux']

jc/parsers/uptime.py

@@ -38,6 +38,7 @@ class info():
     description = 'uptime parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']

jc/parsers/w.py

@@ -87,6 +87,7 @@ class info():
     description = 'w parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
+    details = None
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'darwin', 'cygwin', 'aix', 'freebsd']