python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

fix blockquotes

Browse Source
This commit is contained in:
Kelly Brazil
2022-05-26 15:07:54 -07:00
parent 7d3fa55571
commit b24495136c
27 changed files with 77 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/parsers/asciitable_m.md
View File

@ -30,9 +30,9 @@ headers are joined with an underscore. All values are returned as strings,
except empty strings, which are converted to None/null. except empty strings, which are converted to None/null.
> Note: table column separator characters (e.g. `|`) cannot be present > Note: table column separator characters (e.g. `|`) cannot be present
inside the cell data. If detected, a warning message will be printed to > inside the cell data. If detected, a warning message will be printed to
STDERR and the line will be skipped. The warning message can be suppressed > STDERR and the line will be skipped. The warning message can be suppressed
by using the `-q` command option or by setting `quiet=True` in `parse()`. > by using the `-q` command option or by setting `quiet=True` in `parse()`.
Usage (cli): Usage (cli):

2
docs/parsers/csv_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `csv` file streaming parser jc - JSON Convert `csv` file 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)
The `csv` streaming parser will attempt to automatically detect the 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

2
docs/parsers/git_log_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `git log` command output streaming parser jc - JSON Convert `git log` 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)
Can be used with the following format options: Can be used with the following format options:
- `oneline` - `oneline`

4
docs/parsers/ini.md
View File

@ -12,8 +12,8 @@ Parses standard `INI` files and files containing simple key/value pairs.
- If duplicate keys are found, only the last value will be used. - If duplicate keys are found, only the last value will be used.
> Note: Values starting and ending with quotation marks will have the marks > Note: Values starting and ending with quotation marks will have the marks
removed. If you would like to keep the quotation marks, use the `-r` > removed. If you would like to keep the quotation marks, 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):

14
docs/parsers/iostat_s.md
View File

@ -6,20 +6,20 @@
jc - JSON Convert `iostat` command output streaming parser jc - JSON Convert `iostat` 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: `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):
$ iostat | jc --iostat-s $ iostat | jc --iostat-s
> Note: When piping `jc` converted `iostat` output to other processes it may > Note: When piping `jc` converted `iostat` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`iostat` output is too small to quickly fill up the buffer. Use the `-u` > `iostat` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. See > option to unbuffer the `jc` output if you would like immediate output. See
the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

4
docs/parsers/kv.md
View File

@ -12,8 +12,8 @@ Supports files containing simple key/value pairs.
- If duplicate keys are found, only the last value will be used. - If duplicate keys are found, only the last value will be used.
> Note: Values starting and ending with quotation marks will have the marks > Note: Values starting and ending with quotation marks will have the marks
removed. If you would like to keep the quotation marks, use the `-r` > removed. If you would like to keep the quotation marks, 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):

2
docs/parsers/ls_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `ls` and `vdir` command output streaming parser jc - JSON Convert `ls` and `vdir` 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)
Requires the `-l` option to be used on `ls`. If there are newline characters 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`. in the filename, then make sure to use the `-b` option on `ls`.

2
docs/parsers/mpstat_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `mpstat` command output streaming parser 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+)

12
docs/parsers/pidstat_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `pidstat` command output streaming parser jc - JSON Convert `pidstat` 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)
Must use the `-h` option in `pidstat`. All other `pidstat` options are Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`. supported in combination with `-h`.
@ -16,11 +16,11 @@ Usage (cli):
$ pidstat | jc --pidstat-s $ pidstat | jc --pidstat-s
> Note: When piping `jc` converted `pidstat` output to other processes it > Note: When piping `jc` converted `pidstat` output to other processes it
may appear the output is hanging due to the OS pipe buffers. This is > may appear the output is hanging due to the OS pipe buffers. This is
because `pidstat` output is too small to quickly fill up the buffer. Use > because `pidstat` output is too small to quickly fill up the buffer. Use
the `-u` option to unbuffer the `jc` output if you would like immediate > the `-u` option to unbuffer the `jc` output if you would like immediate
output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

12
docs/parsers/ping_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `ping` command output streaming parser jc - JSON Convert `ping` 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)
Supports `ping` and `ping6` output. Supports `ping` and `ping6` output.
@ -15,11 +15,11 @@ Usage (cli):
$ ping 1.2.3.4 | jc --ping-s $ ping 1.2.3.4 | jc --ping-s
> Note: When piping `jc` converted `ping` output to other processes it may > Note: When piping `jc` converted `ping` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`ping` output is too small to quickly fill up the buffer. Use the `-u` > `ping` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. > option to unbuffer the `jc` output if you would like immediate output.
See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

2
docs/parsers/rsync_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `rsync` command output streaming parser jc - JSON Convert `rsync` 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)
Supports the `-i` or `--itemize-changes` options with all levels of Supports the `-i` or `--itemize-changes` options with all levels of
verbosity. This parser will process the STDOUT output or a log file verbosity. This parser will process the STDOUT output or a log file

2
docs/parsers/stat_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `stat` command output streaming parser jc - JSON Convert `stat` 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)
The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
local time of the system the parser is run on). local time of the system the parser is run on).

12
docs/parsers/vmstat_s.md
View File

@ -6,7 +6,7 @@
jc - JSON Convert `vmstat` command output streaming parser jc - JSON Convert `vmstat` 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)
Options supported: `-a`, `-w`, `-d`, `-t` Options supported: `-a`, `-w`, `-d`, `-t`
@ -21,11 +21,11 @@ Usage (cli):
$ vmstat | jc --vmstat-s $ vmstat | jc --vmstat-s
> Note: When piping `jc` converted `vmstat` output to other processes it may > Note: When piping `jc` converted `vmstat` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`vmstat` output is too small to quickly fill up the buffer. Use the `-u` > `vmstat` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. See > option to unbuffer the `jc` output if you would like immediate output. See
the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

6
jc/parsers/asciitable_m.py
View File

@ -25,9 +25,9 @@ headers are joined with an underscore. All values are returned as strings,
except empty strings, which are converted to None/null. except empty strings, which are converted to None/null.
> Note: table column separator characters (e.g. `|`) cannot be present > Note: table column separator characters (e.g. `|`) cannot be present
inside the cell data. If detected, a warning message will be printed to > inside the cell data. If detected, a warning message will be printed to
STDERR and the line will be skipped. The warning message can be suppressed > STDERR and the line will be skipped. The warning message can be suppressed
by using the `-q` command option or by setting `quiet=True` in `parse()`. > by using the `-q` command option or by setting `quiet=True` in `parse()`.
Usage (cli): Usage (cli):

2
jc/parsers/csv_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `csv` file streaming parser """jc - JSON Convert `csv` file 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)
The `csv` streaming parser will attempt to automatically detect the 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

2
jc/parsers/foo_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `foo` command output streaming parser """jc - JSON Convert `foo` 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)
<<Short foo description and caveats>> <<Short foo description and caveats>>

2
jc/parsers/git_log_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `git log` command output streaming parser """jc - JSON Convert `git log` 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)
Can be used with the following format options: Can be used with the following format options:
- `oneline` - `oneline`

4
jc/parsers/ini.py
View File

@ -7,8 +7,8 @@ Parses standard `INI` files and files containing simple key/value pairs.
- If duplicate keys are found, only the last value will be used. - If duplicate keys are found, only the last value will be used.
> Note: Values starting and ending with quotation marks will have the marks > Note: Values starting and ending with quotation marks will have the marks
removed. If you would like to keep the quotation marks, use the `-r` > removed. If you would like to keep the quotation marks, 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):

14
jc/parsers/iostat_s.py
View File

@ -1,20 +1,20 @@
"""jc - JSON Convert `iostat` command output streaming parser """jc - JSON Convert `iostat` 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: `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):
$ iostat | jc --iostat-s $ iostat | jc --iostat-s
> Note: When piping `jc` converted `iostat` output to other processes it may > Note: When piping `jc` converted `iostat` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`iostat` output is too small to quickly fill up the buffer. Use the `-u` > `iostat` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. See > option to unbuffer the `jc` output if you would like immediate output. See
the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

4
jc/parsers/kv.py
View File

@ -7,8 +7,8 @@ Supports files containing simple key/value pairs.
- If duplicate keys are found, only the last value will be used. - If duplicate keys are found, only the last value will be used.
> Note: Values starting and ending with quotation marks will have the marks > Note: Values starting and ending with quotation marks will have the marks
removed. If you would like to keep the quotation marks, use the `-r` > removed. If you would like to keep the quotation marks, 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):

2
jc/parsers/ls_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `ls` and `vdir` command output streaming parser """jc - JSON Convert `ls` and `vdir` 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)
Requires the `-l` option to be used on `ls`. If there are newline characters 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`. in the filename, then make sure to use the `-b` option on `ls`.

2
jc/parsers/mpstat_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `mpstat` command output streaming parser """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+)

12
jc/parsers/pidstat_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `pidstat` command output streaming parser """jc - JSON Convert `pidstat` 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)
Must use the `-h` option in `pidstat`. All other `pidstat` options are Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`. supported in combination with `-h`.
@ -11,11 +11,11 @@ Usage (cli):
$ pidstat | jc --pidstat-s $ pidstat | jc --pidstat-s
> Note: When piping `jc` converted `pidstat` output to other processes it > Note: When piping `jc` converted `pidstat` output to other processes it
may appear the output is hanging due to the OS pipe buffers. This is > may appear the output is hanging due to the OS pipe buffers. This is
because `pidstat` output is too small to quickly fill up the buffer. Use > because `pidstat` output is too small to quickly fill up the buffer. Use
the `-u` option to unbuffer the `jc` output if you would like immediate > the `-u` option to unbuffer the `jc` output if you would like immediate
output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

12
jc/parsers/ping_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `ping` command output streaming parser """jc - JSON Convert `ping` 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)
Supports `ping` and `ping6` output. Supports `ping` and `ping6` output.
@ -10,11 +10,11 @@ Usage (cli):
$ ping 1.2.3.4 | jc --ping-s $ ping 1.2.3.4 | jc --ping-s
> Note: When piping `jc` converted `ping` output to other processes it may > Note: When piping `jc` converted `ping` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`ping` output is too small to quickly fill up the buffer. Use the `-u` > `ping` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. > option to unbuffer the `jc` output if you would like immediate output.
See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):

2
jc/parsers/rsync_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `rsync` command output streaming parser """jc - JSON Convert `rsync` 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)
Supports the `-i` or `--itemize-changes` options with all levels of Supports the `-i` or `--itemize-changes` options with all levels of
verbosity. This parser will process the STDOUT output or a log file verbosity. This parser will process the STDOUT output or a log file

2
jc/parsers/stat_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `stat` command output streaming parser """jc - JSON Convert `stat` 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)
The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
local time of the system the parser is run on). local time of the system the parser is run on).

12
jc/parsers/vmstat_s.py
View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `vmstat` command output streaming parser """jc - JSON Convert `vmstat` 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)
Options supported: `-a`, `-w`, `-d`, `-t` Options supported: `-a`, `-w`, `-d`, `-t`
@ -16,11 +16,11 @@ Usage (cli):
$ vmstat | jc --vmstat-s $ vmstat | jc --vmstat-s
> Note: When piping `jc` converted `vmstat` output to other processes it may > Note: When piping `jc` converted `vmstat` output to other processes it may
appear the output is hanging due to the OS pipe buffers. This is because > appear the output is hanging due to the OS pipe buffers. This is because
`vmstat` output is too small to quickly fill up the buffer. Use the `-u` > `vmstat` output is too small to quickly fill up the buffer. Use the `-u`
option to unbuffer the `jc` output if you would like immediate output. See > option to unbuffer the `jc` output if you would like immediate output. See
the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) > the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
for more information. > for more information.
Usage (module): Usage (module):