diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index be0244e2..2b2454b7 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `csv` file streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index 711ec686..ce678e2f 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `iostat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Note: `iostat` version 11 and higher include a JSON output option diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index ee66fae6..511e61fb 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `ls` and `vdir` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`. diff --git a/docs/parsers/mpstat_s.md b/docs/parsers/mpstat_s.md index 21f17bdf..3676138a 100644 --- a/docs/parsers/mpstat_s.md +++ b/docs/parsers/mpstat_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `mpstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Note: Latest versions of `mpstat` support JSON output (v11.5.1+) diff --git a/docs/parsers/pidstat_s.md b/docs/parsers/pidstat_s.md index 826a7a3a..b0915e3f 100644 --- a/docs/parsers/pidstat_s.md +++ b/docs/parsers/pidstat_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `pidstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 5b3ab153..9ba85e53 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `ping` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Supports `ping` and `ping6` output. diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index dca88721..88a04d88 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `rsync` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 53daf93d..569e1a1e 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `stat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on). diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 96ab3861..de7c11e4 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -5,8 +5,8 @@ jc - JSON Convert `vmstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Options supported: `-a`, `-w`, `-d`, `-t` diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index 604d2e88..7671c019 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `csv` file streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py index d26f5b9f..ad819830 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `foo` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) <> diff --git a/jc/parsers/iostat_s.py b/jc/parsers/iostat_s.py index e76fdcd9..161c723f 100644 --- a/jc/parsers/iostat_s.py +++ b/jc/parsers/iostat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `iostat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Note: `iostat` version 11 and higher include a JSON output option diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index 256b8069..e727998d 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `ls` and `vdir` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`. diff --git a/jc/parsers/mpstat_s.py b/jc/parsers/mpstat_s.py index 8d9a9a02..09aaae09 100644 --- a/jc/parsers/mpstat_s.py +++ b/jc/parsers/mpstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `mpstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Note: Latest versions of `mpstat` support JSON output (v11.5.1+) diff --git a/jc/parsers/pidstat_s.py b/jc/parsers/pidstat_s.py index 2972900b..1eba0db5 100644 --- a/jc/parsers/pidstat_s.py +++ b/jc/parsers/pidstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `pidstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 64423959..85d24408 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `ping` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Supports `ping` and `ping6` output. diff --git a/jc/parsers/rsync_s.py b/jc/parsers/rsync_s.py index 8bd94236..9085aedd 100644 --- a/jc/parsers/rsync_s.py +++ b/jc/parsers/rsync_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `rsync` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file diff --git a/jc/parsers/stat_s.py b/jc/parsers/stat_s.py index 5594e647..fb19cda6 100644 --- a/jc/parsers/stat_s.py +++ b/jc/parsers/stat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `stat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on). diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index 5cbf4178..f165abc0 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `vmstat` command output streaming parser -> This streaming parser outputs JSON Lines (cli) or returns a Generator - iterator of Dictionaries (module) +> This streaming parser outputs JSON Lines (cli) or returns an Iterable of + Dictionaries (module) Options supported: `-a`, `-w`, `-d`, `-t`