From eb205562bfe567ede7eae3de8b078577054822ea Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 25 Sep 2022 13:07:31 -0700 Subject: [PATCH] force docupdate --- docgen.sh | 2 +- docs/parsers/proc_net_dev.md | 127 +++++++++++++++++++++++++++++++++++ jc/parsers/proc_net_dev.py | 2 +- 3 files changed, 129 insertions(+), 2 deletions(-) create mode 100644 docs/parsers/proc_net_dev.md diff --git a/docgen.sh b/docgen.sh index dee2f9b0..ffadbe45 100755 --- a/docgen.sh +++ b/docgen.sh @@ -115,7 +115,7 @@ done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)') for parser in "${parsers[@]}"; do parser_name=$(jq -r '.name' <<< "$parser") { - if ! git diff --quiet --exit-code -- "parsers/${parser_name}.py"; then + if ! git diff --quiet --exit-code HEAD -- "parsers/${parser_name}.py"; then compatible=$(jq -r '.compatible | join(", ")' <<< "$parser") version=$(jq -r '.version' <<< "$parser") author=$(jq -r '.author' <<< "$parser") diff --git a/docs/parsers/proc_net_dev.md b/docs/parsers/proc_net_dev.md new file mode 100644 index 00000000..9f53b768 --- /dev/null +++ b/docs/parsers/proc_net_dev.md @@ -0,0 +1,127 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.proc\_net\_dev + +jc - JSON Convert `/proc/net/dev1` file parser + +Usage (cli): + + $ cat /proc/net/dev | jc --proc + +or + + $ jc /proc/net/dev + +or + + $ cat /proc/net/dev | jc --proc-net-dev + +Usage (module): + + import jc + result = jc.parse('proc', proc_net_dev_file) + +or + + import jc + result = jc.parse('proc_net_dev', proc_net_dev_file) + +Schema: + + [ + { + "interface": string, + "r_bytes": integer, + "r_packets": integer, + "r_errs": integer, + "r_drop": integer, + "r_fifo": integer, + "r_frame": integer, + "r_compressed": integer, + "r_multicast": integer, + "t_bytes": integer, + "t_packets": integer, + "t_errs": integer, + "t_drop": integer, + "t_fifo": integer, + "t_colls": integer, + "t_carrier": integer, + "t_compressed": integer + } + ] + +Examples: + + $ cat /proc/net/dev | jc --proc -p + [ + { + "interface": "lo", + "r_bytes": 13222, + "r_packets": 152, + "r_errs": 0, + "r_drop": 0, + "r_fifo": 0, + "r_frame": 0, + "r_compressed": 0, + "r_multicast": 0, + "t_bytes": 13222, + "t_packets": 152, + "t_errs": 0, + "t_drop": 0, + "t_fifo": 0, + "t_colls": 0, + "t_carrier": 0, + "t_compressed": 0 + }, + ... + ] + + $ cat /proc/net/dev | jc --proc -p -r + [ + { + "interface": "lo:", + "r_bytes": "13222", + "r_packets": "152", + "r_errs": "0", + "r_drop": "0", + "r_fifo": "0", + "r_frame": "0", + "r_compressed": "0", + "r_multicast": "0", + "t_bytes": "13222", + "t_packets": "152", + "t_errs": "0", + "t_drop": "0", + "t_fifo": "0", + "t_colls": "0", + "t_carrier": "0", + "t_compressed": "0" + }, + ... + ] + + + +### parse + +```python +def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] +``` + +Main text parsing function + +Parameters: + + data: (string) text data to parse + raw: (boolean) unprocessed output if True + quiet: (boolean) suppress warning messages if True + +Returns: + + List of Dictionaries. Raw or processed structured data. + +### Parser Information +Compatibility: linux + +Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/jc/parsers/proc_net_dev.py b/jc/parsers/proc_net_dev.py index 1b2997dd..5ca5450c 100644 --- a/jc/parsers/proc_net_dev.py +++ b/jc/parsers/proc_net_dev.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert `/proc/net/dev` file parser +"""jc - JSON Convert `/proc/net/dev1` file parser Usage (cli):