diff --git a/docs/parsers/git_log.md b/docs/parsers/git_log.md index 292a9e6f..3ed00fab 100644 --- a/docs/parsers/git_log.md +++ b/docs/parsers/git_log.md @@ -43,8 +43,8 @@ Schema: "author": string, "author_email": string, "date": string, - "epoch": integer, [0] - "epoch_utc": integer, [1] + "epoch": integer, # [0] + "epoch_utc": integer, # [1] "commit_by": string, "commit_by_email": string, "commit_by_date": string, diff --git a/docs/parsers/git_log_s.md b/docs/parsers/git_log_s.md index 676fd7a8..2be64543 100644 --- a/docs/parsers/git_log_s.md +++ b/docs/parsers/git_log_s.md @@ -44,8 +44,8 @@ Schema: "author": string, "author_email": string, "date": string, - "epoch": integer, [0] - "epoch_utc": integer, [1] + "epoch": integer, # [0] + "epoch_utc": integer, # [1] "commit_by": string, "commit_by_email": string, "commit_by_date": string, diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index bf1caccc..c45145c3 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -26,8 +26,8 @@ Usage (module): Schema: - ini or key/value document converted to a dictionary - see the - configparser standard library documentation for more details. +ini or key/value document converted to a dictionary - see the configparser +standard library documentation for more details. { "key1": string, diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 2742ae01..ec0b79c8 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -26,8 +26,8 @@ Usage (module): Schema: - key/value document converted to a dictionary - see the - configparser standard library documentation for more details. +key/value document converted to a dictionary - see the configparser standard +library documentation for more details. { "key1": string, diff --git a/docs/parsers/nmcli.md b/docs/parsers/nmcli.md index 6c4b3793..f522969c 100644 --- a/docs/parsers/nmcli.md +++ b/docs/parsers/nmcli.md @@ -40,7 +40,7 @@ Schema: [ { - "": string/integer/float, [0] + "": string/integer/float, # [0] "dhcp4_option_x": { "name": string, "value": string/integer/float, diff --git a/docs/parsers/route.md b/docs/parsers/route.md index 0012fd84..14c4b7af 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -22,20 +22,20 @@ Schema: [ { - "destination": string, - "gateway": string, - "genmask": string, - "flags": string, + "destination": string, + "gateway": string, + "genmask": string, + "flags": string, "flags_pretty": [ - string + string ] - "metric": integer, - "ref": integer, - "use": integer, - "mss": integer, - "window": integer, - "irtt": integer, - "iface": string + "metric": integer, + "ref": integer, + "use": integer, + "mss": integer, + "window": integer, + "irtt": integer, + "iface": string } ] diff --git a/docs/parsers/rsync.md b/docs/parsers/rsync.md index ce9045fd..78070a46 100644 --- a/docs/parsers/rsync.md +++ b/docs/parsers/rsync.md @@ -51,8 +51,8 @@ Schema: "time": string, "process": integer, "metadata": string, - "update_type": string/null, [0] - "file_type": string/null, [1] + "update_type": string/null, # [0] + "file_type": string/null, # [1] "checksum_or_value_different": bool/null, "size_different": bool/null, "modification_time_different": bool/null, @@ -61,7 +61,7 @@ Schema: "group_different": bool/null, "acl_different": bool/null, "extended_attribute_different": bool/null, - "epoch": integer, [2] + "epoch": integer, # [2] } ] } diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index be7be22e..fd27e7c5 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -49,8 +49,8 @@ Schema: "time": string, "process": integer, "metadata": string, - "update_type": string/null, [0] - "file_type": string/null, [1] + "update_type": string/null, # [0] + "file_type": string/null, # [1] "checksum_or_value_different": bool/null, "size_different": bool/null, "modification_time_different": bool/null, @@ -59,7 +59,7 @@ Schema: "group_different": bool/null, "acl_different": bool/null, "extended_attribute_different": bool/null, - "epoch": integer, [2] + "epoch": integer, # [2] # below object only exists if using -qq or ignore_exceptions=True "_jc_meta": { diff --git a/docs/parsers/time.md b/docs/parsers/time.md index 25185ec3..028e9b47 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -5,10 +5,10 @@ jc - JSON Convert `/usr/bin/time` command output parser -Output from `/usr/bin/time` is sent to STDERR, so the `-o` option can be +Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. -Alternatively, the output from `/usr/bin/time` can be redirected to STDOUT +Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT` so `jc` can receive it. > Note: `/usr/bin/time` is similar but different from the Bash builtin diff --git a/docs/parsers/top.md b/docs/parsers/top.md index eca13780..a8cf605f 100644 --- a/docs/parsers/top.md +++ b/docs/parsers/top.md @@ -50,23 +50,23 @@ All `-` values are converted to `null` "cpu_hardware": float, "cpu_software": float, "cpu_steal": float, - "mem_total": float, [0] - "mem_free": float, [0] - "mem_used": float, [0] - "mem_buff_cache": float, [0] - "swap_total": float, [0] - "swap_free": float, [0] - "swap_used": float, [0] - "mem_available": float, [0] + "mem_total": float, # [0] + "mem_free": float, # [0] + "mem_used": float, # [0] + "mem_buff_cache": float, # [0] + "swap_total": float, # [0] + "swap_free": float, # [0] + "swap_used": float, # [0] + "mem_available": float, # [0] "processes": [ { "pid": integer, "user": string, "priority": integer, "nice": integer, - "virtual_mem": float, [1] - "resident_mem": float, [1] - "shared_mem": float, [1] + "virtual_mem": float, # [1] + "resident_mem": float, # [1] + "shared_mem": float, # [1] "status": string, "percent_cpu": float, "percent_mem": float, @@ -87,9 +87,9 @@ All `-` values are converted to `null` "thread_count": integer, "last_used_processor": integer, "time": string, - "swap": float, [1] - "code": float, [1] - "data": float, [1] + "swap": float, # [1] + "code": float, # [1] + "data": float, # [1] "major_page_fault_count": integer, "minor_page_fault_count": integer, "dirty_pages_count": integer, @@ -108,7 +108,7 @@ All `-` values are converted to `null` ] "major_page_fault_count_delta": integer, "minor_page_fault_count_delta": integer, - "used": float, [1] + "used": float, # [1] "ipc_namespace_inode": integer, "mount_namespace_inode": integer, "net_namespace_inode": integer, diff --git a/docs/parsers/top_s.md b/docs/parsers/top_s.md index 452656e1..467c8228 100644 --- a/docs/parsers/top_s.md +++ b/docs/parsers/top_s.md @@ -48,23 +48,23 @@ Schema: "cpu_hardware": float, "cpu_software": float, "cpu_steal": float, - "mem_total": float, [0] - "mem_free": float, [0] - "mem_used": float, [0] - "mem_buff_cache": float, [0] - "swap_total": float, [0] - "swap_free": float, [0] - "swap_used": float, [0] - "mem_available": float, [0] + "mem_total": float, # [0] + "mem_free": float, # [0] + "mem_used": float, # [0] + "mem_buff_cache": float, # [0] + "swap_total": float, # [0] + "swap_free": float, # [0] + "swap_used": float, # [0] + "mem_available": float, # [0] "processes": [ { "pid": integer, "user": string, "priority": integer, "nice": integer, - "virtual_mem": float, [1] - "resident_mem": float, [1] - "shared_mem": float, [1] + "virtual_mem": float, # [1] + "resident_mem": float, # [1] + "shared_mem": float, # [1] "status": string, "percent_cpu": float, "percent_mem": float, @@ -85,9 +85,9 @@ Schema: "thread_count": integer, "last_used_processor": integer, "time": string, - "swap": float, [1] - "code": float, [1] - "data": float, [1] + "swap": float, # [1] + "code": float, # [1] + "data": float, # [1] "major_page_fault_count": integer, "minor_page_fault_count": integer, "dirty_pages_count": integer, @@ -106,7 +106,7 @@ Schema: ] "major_page_fault_count_delta": integer, "minor_page_fault_count_delta": integer, - "used": float, [1] + "used": float, # [1] "ipc_namespace_inode": integer, "mount_namespace_inode": integer, "net_namespace_inode": integer, diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index ab794fbd..b911f4cd 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -75,9 +75,9 @@ Schema: # below object only exists if using -qq or ignore_exceptions=True "_jc_meta": { - "success": boolean, # [2] - "error": string, # [3] - "line": string # [3] + "success": boolean, # [2] + "error": string, # [3] + "line": string # [3] } } diff --git a/jc/parsers/git_log.py b/jc/parsers/git_log.py index bfadcf08..3e205a0d 100644 --- a/jc/parsers/git_log.py +++ b/jc/parsers/git_log.py @@ -38,8 +38,8 @@ Schema: "author": string, "author_email": string, "date": string, - "epoch": integer, [0] - "epoch_utc": integer, [1] + "epoch": integer, # [0] + "epoch_utc": integer, # [1] "commit_by": string, "commit_by_email": string, "commit_by_date": string, diff --git a/jc/parsers/git_log_s.py b/jc/parsers/git_log_s.py index abd6199c..1bd3ef5a 100644 --- a/jc/parsers/git_log_s.py +++ b/jc/parsers/git_log_s.py @@ -39,8 +39,8 @@ Schema: "author": string, "author_email": string, "date": string, - "epoch": integer, [0] - "epoch_utc": integer, [1] + "epoch": integer, # [0] + "epoch_utc": integer, # [1] "commit_by": string, "commit_by_email": string, "commit_by_date": string, diff --git a/jc/parsers/ini.py b/jc/parsers/ini.py index 2172c349..5e2d2b0b 100644 --- a/jc/parsers/ini.py +++ b/jc/parsers/ini.py @@ -21,8 +21,8 @@ Usage (module): Schema: - ini or key/value document converted to a dictionary - see the - configparser standard library documentation for more details. +ini or key/value document converted to a dictionary - see the configparser +standard library documentation for more details. { "key1": string, diff --git a/jc/parsers/kv.py b/jc/parsers/kv.py index a03b9576..6e368535 100644 --- a/jc/parsers/kv.py +++ b/jc/parsers/kv.py @@ -21,8 +21,8 @@ Usage (module): Schema: - key/value document converted to a dictionary - see the - configparser standard library documentation for more details. +key/value document converted to a dictionary - see the configparser standard +library documentation for more details. { "key1": string, diff --git a/jc/parsers/nmcli.py b/jc/parsers/nmcli.py index cacbbad2..78e6f4db 100644 --- a/jc/parsers/nmcli.py +++ b/jc/parsers/nmcli.py @@ -35,7 +35,7 @@ Schema: [ { - "": string/integer/float, [0] + "": string/integer/float, # [0] "dhcp4_option_x": { "name": string, "value": string/integer/float, diff --git a/jc/parsers/route.py b/jc/parsers/route.py index 169aca62..4814d628 100644 --- a/jc/parsers/route.py +++ b/jc/parsers/route.py @@ -17,20 +17,20 @@ Schema: [ { - "destination": string, - "gateway": string, - "genmask": string, - "flags": string, + "destination": string, + "gateway": string, + "genmask": string, + "flags": string, "flags_pretty": [ - string + string ] - "metric": integer, - "ref": integer, - "use": integer, - "mss": integer, - "window": integer, - "irtt": integer, - "iface": string + "metric": integer, + "ref": integer, + "use": integer, + "mss": integer, + "window": integer, + "irtt": integer, + "iface": string } ] diff --git a/jc/parsers/rsync.py b/jc/parsers/rsync.py index c6a15f46..f80bd451 100644 --- a/jc/parsers/rsync.py +++ b/jc/parsers/rsync.py @@ -46,8 +46,8 @@ Schema: "time": string, "process": integer, "metadata": string, - "update_type": string/null, [0] - "file_type": string/null, [1] + "update_type": string/null, # [0] + "file_type": string/null, # [1] "checksum_or_value_different": bool/null, "size_different": bool/null, "modification_time_different": bool/null, @@ -56,7 +56,7 @@ Schema: "group_different": bool/null, "acl_different": bool/null, "extended_attribute_different": bool/null, - "epoch": integer, [2] + "epoch": integer, # [2] } ] } diff --git a/jc/parsers/rsync_s.py b/jc/parsers/rsync_s.py index 692f3395..f8c4ce10 100644 --- a/jc/parsers/rsync_s.py +++ b/jc/parsers/rsync_s.py @@ -44,8 +44,8 @@ Schema: "time": string, "process": integer, "metadata": string, - "update_type": string/null, [0] - "file_type": string/null, [1] + "update_type": string/null, # [0] + "file_type": string/null, # [1] "checksum_or_value_different": bool/null, "size_different": bool/null, "modification_time_different": bool/null, @@ -54,7 +54,7 @@ Schema: "group_different": bool/null, "acl_different": bool/null, "extended_attribute_different": bool/null, - "epoch": integer, [2] + "epoch": integer, # [2] # below object only exists if using -qq or ignore_exceptions=True "_jc_meta": { diff --git a/jc/parsers/time.py b/jc/parsers/time.py index ed2b6dab..badeda02 100644 --- a/jc/parsers/time.py +++ b/jc/parsers/time.py @@ -1,9 +1,9 @@ """jc - JSON Convert `/usr/bin/time` command output parser -Output from `/usr/bin/time` is sent to STDERR, so the `-o` option can be +Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. -Alternatively, the output from `/usr/bin/time` can be redirected to STDOUT +Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT` so `jc` can receive it. > Note: `/usr/bin/time` is similar but different from the Bash builtin diff --git a/jc/parsers/top.py b/jc/parsers/top.py index af910822..1af63254 100644 --- a/jc/parsers/top.py +++ b/jc/parsers/top.py @@ -45,23 +45,23 @@ All `-` values are converted to `null` "cpu_hardware": float, "cpu_software": float, "cpu_steal": float, - "mem_total": float, [0] - "mem_free": float, [0] - "mem_used": float, [0] - "mem_buff_cache": float, [0] - "swap_total": float, [0] - "swap_free": float, [0] - "swap_used": float, [0] - "mem_available": float, [0] + "mem_total": float, # [0] + "mem_free": float, # [0] + "mem_used": float, # [0] + "mem_buff_cache": float, # [0] + "swap_total": float, # [0] + "swap_free": float, # [0] + "swap_used": float, # [0] + "mem_available": float, # [0] "processes": [ { "pid": integer, "user": string, "priority": integer, "nice": integer, - "virtual_mem": float, [1] - "resident_mem": float, [1] - "shared_mem": float, [1] + "virtual_mem": float, # [1] + "resident_mem": float, # [1] + "shared_mem": float, # [1] "status": string, "percent_cpu": float, "percent_mem": float, @@ -82,9 +82,9 @@ All `-` values are converted to `null` "thread_count": integer, "last_used_processor": integer, "time": string, - "swap": float, [1] - "code": float, [1] - "data": float, [1] + "swap": float, # [1] + "code": float, # [1] + "data": float, # [1] "major_page_fault_count": integer, "minor_page_fault_count": integer, "dirty_pages_count": integer, @@ -103,7 +103,7 @@ All `-` values are converted to `null` ] "major_page_fault_count_delta": integer, "minor_page_fault_count_delta": integer, - "used": float, [1] + "used": float, # [1] "ipc_namespace_inode": integer, "mount_namespace_inode": integer, "net_namespace_inode": integer, diff --git a/jc/parsers/top_s.py b/jc/parsers/top_s.py index 5c1ac691..4be47810 100644 --- a/jc/parsers/top_s.py +++ b/jc/parsers/top_s.py @@ -43,23 +43,23 @@ Schema: "cpu_hardware": float, "cpu_software": float, "cpu_steal": float, - "mem_total": float, [0] - "mem_free": float, [0] - "mem_used": float, [0] - "mem_buff_cache": float, [0] - "swap_total": float, [0] - "swap_free": float, [0] - "swap_used": float, [0] - "mem_available": float, [0] + "mem_total": float, # [0] + "mem_free": float, # [0] + "mem_used": float, # [0] + "mem_buff_cache": float, # [0] + "swap_total": float, # [0] + "swap_free": float, # [0] + "swap_used": float, # [0] + "mem_available": float, # [0] "processes": [ { "pid": integer, "user": string, "priority": integer, "nice": integer, - "virtual_mem": float, [1] - "resident_mem": float, [1] - "shared_mem": float, [1] + "virtual_mem": float, # [1] + "resident_mem": float, # [1] + "shared_mem": float, # [1] "status": string, "percent_cpu": float, "percent_mem": float, @@ -80,9 +80,9 @@ Schema: "thread_count": integer, "last_used_processor": integer, "time": string, - "swap": float, [1] - "code": float, [1] - "data": float, [1] + "swap": float, # [1] + "code": float, # [1] + "data": float, # [1] "major_page_fault_count": integer, "minor_page_fault_count": integer, "dirty_pages_count": integer, @@ -101,7 +101,7 @@ Schema: ] "major_page_fault_count_delta": integer, "minor_page_fault_count_delta": integer, - "used": float, [1] + "used": float, # [1] "ipc_namespace_inode": integer, "mount_namespace_inode": integer, "net_namespace_inode": integer, diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index 638f924b..e7d12e34 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -70,9 +70,9 @@ Schema: # below object only exists if using -qq or ignore_exceptions=True "_jc_meta": { - "success": boolean, # [2] - "error": string, # [3] - "line": string # [3] + "success": boolean, # [2] + "error": string, # [3] + "line": string # [3] } }