python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

doc formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-05-28 13:13:07 -07:00
parent d3d7fbca61
commit fec74cf305
12 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -204,8 +204,8 @@ option.
| ` --nmcli` | `nmcli` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli) | | ` --nmcli` | `nmcli` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli) |
| ` --ntpq` | `ntpq -p` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq) | | ` --ntpq` | `ntpq -p` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq) |
| ` --passwd` | `/etc/passwd` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd) | | ` --passwd` | `/etc/passwd` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd) |
| ` --pidstat` | `pidstat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) | | ` --pidstat` | `pidstat -h` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) |
| ` --pidstat-s` | `pidstat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s) | | ` --pidstat-s` | `pidstat -h` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s) |
| ` --ping` | `ping` and `ping6` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping) | | ` --ping` | `ping` and `ping6` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping) |
| ` --ping-s` | `ping` and `ping6` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s) | | ` --ping-s` | `ping` and `ping6` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s) |
| ` --pip-list` | `pip list` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list) | | ` --pip-list` | `pip list` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list) |

14
docs/parsers/nmcli.md
View File

@ -29,14 +29,14 @@ Usage (module):
Schema: Schema:
Because there are so many options, the schema is not strictly defined. Because there are so many options, the schema is not strictly defined.
Integer and Float value conversions are attempted and the original Integer and Float value conversions are attempted and the original
values are kept if they fail. If you don't want automatic conversion, values are kept if they fail. If you don't want automatic conversion,
then use the -r or raw=True option to disable it. then use the `-r` or `raw=True` option to disable it.
The structure is flat, for the most part, but there are a couple of The structure is flat, for the most part, but there are a couple of
"well-known" keys that are further parsed into objects for convenience. "well-known" keys that are further parsed into objects for convenience.
These are documented below. These are documented below.
[ [
{ {

2
docs/parsers/pidstat.md
View File

@ -3,7 +3,7 @@
# jc.parsers.pidstat # jc.parsers.pidstat
jc - JSON Convert `pidstat` command output parser jc - JSON Convert `pidstat -h` command output parser
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`.

2
docs/parsers/pidstat_s.md
View File

@ -3,7 +3,7 @@
# jc.parsers.pidstat\_s # jc.parsers.pidstat\_s
jc - JSON Convert `pidstat` command output streaming parser jc - JSON Convert `pidstat -h` 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)

2
docs/parsers/rpm_qi.md
View File

@ -10,7 +10,7 @@ Works with `rpm -qi [package]` or `rpm -qia`.
The `..._epoch` calculated timestamp fields are naive. (i.e. based on the The `..._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)
The `..._epoch_utc` calculated timestamp fields are timezone-aware and is The `..._epoch_utc` calculated timestamp fields are timezone-aware and are
only available if the timezone field is UTC. only available if the timezone field is UTC.
Usage (cli): Usage (cli):

4
docs/parsers/xml.md
View File

@ -16,8 +16,8 @@ Usage (module):
Schema: Schema:
XML Document converted to a Dictionary XML Document converted to a Dictionary. See https://github.com/martinblech/xmltodict
See https://github.com/martinblech/xmltodict for details for details.
{ {
"key1": string/object, "key1": string/object,

14
jc/parsers/nmcli.py
View File

@ -24,14 +24,14 @@ Usage (module):
Schema: Schema:
Because there are so many options, the schema is not strictly defined. Because there are so many options, the schema is not strictly defined.
Integer and Float value conversions are attempted and the original Integer and Float value conversions are attempted and the original
values are kept if they fail. If you don't want automatic conversion, values are kept if they fail. If you don't want automatic conversion,
then use the -r or raw=True option to disable it. then use the `-r` or `raw=True` option to disable it.
The structure is flat, for the most part, but there are a couple of The structure is flat, for the most part, but there are a couple of
"well-known" keys that are further parsed into objects for convenience. "well-known" keys that are further parsed into objects for convenience.
These are documented below. These are documented below.
[ [
{ {

4
jc/parsers/pidstat.py
View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pidstat` command output parser """jc - JSON Convert `pidstat -h` command output parser
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`.
@ -129,7 +129,7 @@ from jc.exceptions import ParseError
class info(): class info():
"""Provides parser metadata (version, author, etc.)""" """Provides parser metadata (version, author, etc.)"""
version = '1.0' version = '1.0'
description = '`pidstat` command parser' description = '`pidstat -h` command parser'
author = 'Kelly Brazil' author = 'Kelly Brazil'
author_email = 'kellyjonbrazil@gmail.com' author_email = 'kellyjonbrazil@gmail.com'
compatible = ['linux'] compatible = ['linux']

4
jc/parsers/pidstat_s.py
View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pidstat` command output streaming parser """jc - JSON Convert `pidstat -h` 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)
@ -84,7 +84,7 @@ from jc.exceptions import ParseError
class info(): class info():
"""Provides parser metadata (version, author, etc.)""" """Provides parser metadata (version, author, etc.)"""
version = '1.0' version = '1.0'
description = '`pidstat` command streaming parser' description = '`pidstat -h` command streaming parser'
author = 'Kelly Brazil' author = 'Kelly Brazil'
author_email = 'kellyjonbrazil@gmail.com' author_email = 'kellyjonbrazil@gmail.com'
compatible = ['linux'] compatible = ['linux']

2
jc/parsers/rpm_qi.py
View File

@ -5,7 +5,7 @@ Works with `rpm -qi [package]` or `rpm -qia`.
The `..._epoch` calculated timestamp fields are naive. (i.e. based on the The `..._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)
The `..._epoch_utc` calculated timestamp fields are timezone-aware and is The `..._epoch_utc` calculated timestamp fields are timezone-aware and are
only available if the timezone field is UTC. only available if the timezone field is UTC.
Usage (cli): Usage (cli):

4
jc/parsers/xml.py
View File

@ -11,8 +11,8 @@ Usage (module):
Schema: Schema:
XML Document converted to a Dictionary XML Document converted to a Dictionary. See https://github.com/martinblech/xmltodict
See https://github.com/martinblech/xmltodict for details for details.
{ {
"key1": string/object, "key1": string/object,

4
man/jc.1
View File

@ -310,12 +310,12 @@ Key/Value file parser
.TP .TP
.B .B
\fB--pidstat\fP \fB--pidstat\fP
`pidstat` command parser `pidstat -h` command parser
.TP .TP
.B .B
\fB--pidstat-s\fP \fB--pidstat-s\fP
`pidstat` command streaming parser `pidstat -h` command streaming parser
.TP .TP
.B .B