1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-23 00:29:59 +02:00

fix notes

This commit is contained in:
Kelly Brazil
2022-05-26 15:54:39 -07:00
parent 04fda57cbe
commit 28ebb4e8dd
30 changed files with 78 additions and 82 deletions

View File

@ -12,8 +12,8 @@ The `csv` streaming parser will attempt to automatically detect the
delimiter character. If the delimiter cannot be detected it will default delimiter character. If the delimiter cannot be detected it will default
to comma. The first row of the file must be a header row. to comma. The first row of the file must be a header row.
Note: The first 100 rows are read into memory to enable delimiter detection, > Note: The first 100 rows are read into memory to enable delimiter
then the rest of the rows are loaded lazily. > detection, then the rest of the rows are loaded lazily.
Usage (cli): Usage (cli):

View File

@ -5,7 +5,7 @@
jc - JSON Convert `ifconfig` command output parser jc - JSON Convert `ifconfig` command output parser
Note: No `ifconfig` options are supported. > Note: No `ifconfig` options are supported.
Usage (cli): Usage (cli):

View File

@ -5,7 +5,7 @@
jc - JSON Convert `iostat` command output parser jc - JSON Convert `iostat` command output parser
Note: `iostat` version 11 and higher include a JSON output option > Note: `iostat` version 11 and higher include a JSON output option
Usage (cli): Usage (cli):

View File

@ -9,11 +9,12 @@ Options supported:
- `lbaR1` - `lbaR1`
- `--time-style=full-iso` - `--time-style=full-iso`
Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly > Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly
parse filenames that include newline characters. Since `ls` does not encode > parse filenames that include newline characters. Since `ls` does not
newlines in filenames when outputting to a pipe it will cause `jc` to see > encode newlines in filenames when outputting to a pipe it will cause `jc`
multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. > to see multiple files instead of a single file if `-1`, `-l`, or `-b` is
Alternatively, `vdir` can be used, which is the same as running `ls -lb`. > not used. Alternatively, `vdir` can be used, which is the same as running
> `ls -lb`.
The `epoch` calculated timestamp field is naive. (i.e. based on the local The `epoch` calculated timestamp field is naive. (i.e. based on the local
time of the system the parser is run on) time of the system the parser is run on)

View File

@ -22,9 +22,9 @@ Usage (module):
Schema: Schema:
Note: <item> object keynames are assigned directly from the lsusb > Note: <item> object keynames are assigned directly from the lsusb
output. If there are duplicate <item> names in a section, only the > output. If there are duplicate <item> names in a section, only the
last one is converted. > last one is converted.
[ [
{ {

View File

@ -5,7 +5,7 @@
jc - JSON Convert `mpstat` command output parser jc - JSON Convert `mpstat` command output parser
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) > Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
Usage (cli): Usage (cli):

View File

@ -8,7 +8,7 @@ jc - JSON Convert `mpstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module) > Dictionaries (module)
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) > Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
Usage (cli): Usage (cli):

View File

@ -5,8 +5,8 @@
jc - JSON Convert `ss` command output parser jc - JSON Convert `ss` command output parser
Extended information options like -e and -p are not supported and may cause Extended information options like `-e` and `-p` are not supported and may
parsing irregularities. cause parsing irregularities.
Usage (cli): Usage (cli):

View File

@ -5,10 +5,10 @@
jc - JSON Convert `sysctl -a` command output parser jc - JSON Convert `sysctl -a` command output parser
Note: Since `sysctl` output is not easily parsable only a very simple > Note: Since `sysctl` output is not easily parsable only a very simple
key/value object will be output. An attempt is made to convert obvious > key/value object will be output. An attempt is made to convert obvious
integers and floats. If no conversion is desired, use the `-r` > integers and floats. If no conversion is desired, use the `-r`
command-line argument or the `raw=True` argument in `parse()`. > command-line argument or the `raw=True` argument in `parse()`.
Usage (cli): Usage (cli):

View File

@ -5,14 +5,14 @@
jc - JSON Convert `/usr/bin/time` command output parser 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`. 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. so `jc` can receive it.
Note: `/usr/bin/time` is similar but different from the Bash builtin > Note: `/usr/bin/time` is similar but different from the Bash builtin
`time` command. > `time` command.
Usage (cli): Usage (cli):
@ -26,7 +26,7 @@ Usage (module):
Schema: Schema:
Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage,
https://man7.org/linux/man-pages/man1/time.1.html https://man7.org/linux/man-pages/man1/time.1.html
{ {

View File

@ -7,12 +7,12 @@ jc - JSON Convert `traceroute` command output parser
Supports `traceroute` and `traceroute6` output. Supports `traceroute` and `traceroute6` output.
Note: On some operating systems you will need to redirect `STDERR` to > Note: On some operating systems you will need to redirect `STDERR` to
`STDOUT` for destination info since the header line is sent to > `STDOUT` for destination info since the header line is sent to
`STDERR`. A warning message will be printed to `STDERR` if the > `STDERR`. A warning message will be printed to `STDERR` if the
header row is not found. > header row is not found.
>
e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` > e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
Usage (cli): Usage (cli):

View File

@ -5,7 +5,7 @@
jc - JSON Convert `uname -a` command output parser jc - JSON Convert `uname -a` command output parser
Note: Must use `uname -a` > Note: Must use `uname -a`
Usage (cli): Usage (cli):

View File

@ -5,7 +5,7 @@
jc - JSON Convert `YAML` file parser jc - JSON Convert `YAML` file parser
Note: datetime objects will be converted to strings. > Note: `datetime` objects will be converted to strings.
Usage (cli): Usage (cli):

View File

@ -5,10 +5,7 @@
jc - JSON Convert `zipinfo` command output parser jc - JSON Convert `zipinfo` command output parser
Options supported: > Note: No `zipinfo` options are supported.
- none
Note: The default listing format.
Usage (cli): Usage (cli):

View File

@ -7,8 +7,8 @@ The `csv` streaming parser will attempt to automatically detect the
delimiter character. If the delimiter cannot be detected it will default delimiter character. If the delimiter cannot be detected it will default
to comma. The first row of the file must be a header row. to comma. The first row of the file must be a header row.
Note: The first 100 rows are read into memory to enable delimiter detection, > Note: The first 100 rows are read into memory to enable delimiter
then the rest of the rows are loaded lazily. > detection, then the rest of the rows are loaded lazily.
Usage (cli): Usage (cli):

View File

@ -1,6 +1,6 @@
"""jc - JSON Convert `ifconfig` command output parser """jc - JSON Convert `ifconfig` command output parser
Note: No `ifconfig` options are supported. > Note: No `ifconfig` options are supported.
Usage (cli): Usage (cli):

View File

@ -1,6 +1,6 @@
"""jc - JSON Convert `iostat` command output parser """jc - JSON Convert `iostat` command output parser
Note: `iostat` version 11 and higher include a JSON output option > Note: `iostat` version 11 and higher include a JSON output option
Usage (cli): Usage (cli):

View File

@ -4,11 +4,12 @@ Options supported:
- `lbaR1` - `lbaR1`
- `--time-style=full-iso` - `--time-style=full-iso`
Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly > Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly
parse filenames that include newline characters. Since `ls` does not encode > parse filenames that include newline characters. Since `ls` does not
newlines in filenames when outputting to a pipe it will cause `jc` to see > encode newlines in filenames when outputting to a pipe it will cause `jc`
multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. > to see multiple files instead of a single file if `-1`, `-l`, or `-b` is
Alternatively, `vdir` can be used, which is the same as running `ls -lb`. > not used. Alternatively, `vdir` can be used, which is the same as running
> `ls -lb`.
The `epoch` calculated timestamp field is naive. (i.e. based on the local The `epoch` calculated timestamp field is naive. (i.e. based on the local
time of the system the parser is run on) time of the system the parser is run on)

View File

@ -17,9 +17,9 @@ Usage (module):
Schema: Schema:
Note: <item> object keynames are assigned directly from the lsusb > Note: <item> object keynames are assigned directly from the lsusb
output. If there are duplicate <item> names in a section, only the > output. If there are duplicate <item> names in a section, only the
last one is converted. > last one is converted.
[ [
{ {

View File

@ -1,6 +1,6 @@
"""jc - JSON Convert `mpstat` command output parser """jc - JSON Convert `mpstat` command output parser
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) > Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
Usage (cli): Usage (cli):

View File

@ -3,7 +3,7 @@
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module) > Dictionaries (module)
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) > Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
Usage (cli): Usage (cli):

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `ss` command output parser """jc - JSON Convert `ss` command output parser
Extended information options like -e and -p are not supported and may cause Extended information options like `-e` and `-p` are not supported and may
parsing irregularities. cause parsing irregularities.
Usage (cli): Usage (cli):

View File

@ -1,9 +1,9 @@
"""jc - JSON Convert `sysctl -a` command output parser """jc - JSON Convert `sysctl -a` command output parser
Note: Since `sysctl` output is not easily parsable only a very simple > Note: Since `sysctl` output is not easily parsable only a very simple
key/value object will be output. An attempt is made to convert obvious > key/value object will be output. An attempt is made to convert obvious
integers and floats. If no conversion is desired, use the `-r` > integers and floats. If no conversion is desired, use the `-r`
command-line argument or the `raw=True` argument in `parse()`. > command-line argument or the `raw=True` argument in `parse()`.
Usage (cli): Usage (cli):

View File

@ -1,13 +1,13 @@
"""jc - JSON Convert `/usr/bin/time` command output parser """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`. 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. so `jc` can receive it.
Note: `/usr/bin/time` is similar but different from the Bash builtin > Note: `/usr/bin/time` is similar but different from the Bash builtin
`time` command. > `time` command.
Usage (cli): Usage (cli):
@ -21,7 +21,7 @@ Usage (module):
Schema: Schema:
Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage,
https://man7.org/linux/man-pages/man1/time.1.html https://man7.org/linux/man-pages/man1/time.1.html
{ {

View File

@ -2,12 +2,12 @@
Supports `traceroute` and `traceroute6` output. Supports `traceroute` and `traceroute6` output.
Note: On some operating systems you will need to redirect `STDERR` to > Note: On some operating systems you will need to redirect `STDERR` to
`STDOUT` for destination info since the header line is sent to > `STDOUT` for destination info since the header line is sent to
`STDERR`. A warning message will be printed to `STDERR` if the > `STDERR`. A warning message will be printed to `STDERR` if the
header row is not found. > header row is not found.
>
e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` > e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute`
Usage (cli): Usage (cli):

View File

@ -1,6 +1,6 @@
"""jc - JSON Convert `uname -a` command output parser """jc - JSON Convert `uname -a` command output parser
Note: Must use `uname -a` > Note: Must use `uname -a`
Usage (cli): Usage (cli):

View File

@ -1,6 +1,6 @@
"""jc - JSON Convert `YAML` file parser """jc - JSON Convert `YAML` file parser
Note: datetime objects will be converted to strings. > Note: `datetime` objects will be converted to strings.
Usage (cli): Usage (cli):

View File

@ -1,9 +1,6 @@
"""jc - JSON Convert `zipinfo` command output parser """jc - JSON Convert `zipinfo` command output parser
Options supported: > Note: No `zipinfo` options are supported.
- none
Note: The default listing format.
Usage (cli): Usage (cli):