diff --git a/docgen.sh b/docgen.sh index 7d053fc1..16b4d268 100755 --- a/docgen.sh +++ b/docgen.sh @@ -62,6 +62,7 @@ pydocmd simple jc.parsers.traceroute+ > ../docs/parsers/traceroute.md pydocmd simple jc.parsers.uname+ > ../docs/parsers/uname.md pydocmd simple jc.parsers.uptime+ > ../docs/parsers/uptime.md pydocmd simple jc.parsers.w+ > ../docs/parsers/w.md +pydocmd simple jc.parsers.wc+ > ../docs/parsers/wc.md pydocmd simple jc.parsers.who+ > ../docs/parsers/who.md pydocmd simple jc.parsers.xml+ > ../docs/parsers/xml.md pydocmd simple jc.parsers.yaml+ > ../docs/parsers/yaml.md diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md new file mode 100644 index 00000000..c56ab9d6 --- /dev/null +++ b/docs/parsers/wc.md @@ -0,0 +1,95 @@ + +# jc.parsers.wc +jc - JSON CLI output utility `wc` command output parser + +Usage (cli): + + $ wc file.txt | jc --wc + + or + + $ jc wc file.txt + +Usage (module): + + import jc.parsers.wc + result = jc.parsers.wc.parse(wc_command_output) + +Compatibility: + + 'linux', 'darwin', 'cygwin', 'aix', 'freebsd' + +Examples: + + $ wc * | jc --wc -p + [ + { + "filename": "airport-I.json", + "lines": 1, + "words": 30, + "characters": 307 + }, + { + "filename": "airport-I.out", + "lines": 15, + "words": 33, + "characters": 348 + }, + { + "filename": "airport-s.json", + "lines": 1, + "words": 202, + "characters": 2152 + }, + ... + ] + + +## info +```python +info() +``` + + +## process +```python +process(proc_data) +``` + +Final processing to conform to the schema. + +Parameters: + + proc_data: (dictionary) raw structured data to process + +Returns: + + List of dictionaries. Structured data with the following schema: + + [ + { + "filename": string, + "lines": integer, + "words": integer, + "characters": integer + } + ] + + +## parse +```python +parse(data, raw=False, quiet=False) +``` + +Main text parsing function + +Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + +Returns: + + List of dictionaries. Raw or processed structured data. +