1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00

make all summary docstrings raw

This commit is contained in:
Kelly Brazil
2024-03-15 12:17:39 -07:00
parent 3e9afca803
commit c2adc46db4
211 changed files with 652 additions and 652 deletions

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `acpi` command output parser
r"""jc - JSON Convert `acpi` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `airport -I` command output parser
r"""jc - JSON Convert `airport -I` command output parser
The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `airport -s` command output parser
r"""jc - JSON Convert `airport -s` command output parser
The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `apt-cache show` command parser
r"""jc - JSON Convert `apt-cache show` command parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `apt-get -sqq` command output parser
r"""jc - JSON Convert `apt-get -sqq` command output parser
Requires the `-sqq` options in `apt-get`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `arp` command output parser
r"""jc - JSON Convert `arp` command output parser
Supports `arp` and `arp -a` output.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `asciitable` parser
r"""jc - JSON Convert `asciitable` parser
This parser converts ASCII and Unicode text tables with single-line rows.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `bluetoothctl` command output parser
r"""jc - JSON Convert `bluetoothctl` command output parser
Supports the following `bluetoothctl` subcommands:
- `bluetoothctl list`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert broken parser - for testing purposes only"""
r"""jc - JSON Convert broken parser - for testing purposes only"""
import non_existent_library
class info():

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `cbt` command output parser (Google Bigtable)
r"""jc - JSON Convert `cbt` command output parser (Google Bigtable)
Parses the human-, but not machine-, friendly output of the cbt command (for
Google's Bigtable).

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `certbot` command output parser
r"""jc - JSON Convert `certbot` command output parser
Supports the following `certbot` commands:

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `chage --list` command output parser
r"""jc - JSON Convert `chage --list` command output parser
Supports `chage -l <username>` or `chage --list <username>`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `cksum` command output parser
r"""jc - JSON Convert `cksum` command output parser
This parser works with the following checksum calculation utilities:
- `sum`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert Common Log Format file parser
r"""jc - JSON Convert Common Log Format file parser
This parser will handle the Common Log Format standard as specified at
https://www.w3.org/Daemon/User/Config/Logging.html#common-logfile-format.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert Common Log Format file streaming parser
r"""jc - JSON Convert Common Log Format file streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `crontab -l` command output and crontab
r"""jc - JSON Convert `crontab -l` command output and crontab
file parser
Supports `crontab -l` command output and crontab files.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `crontab -l` command output and crontab
r"""jc - JSON Convert `crontab -l` command output and crontab
file parser
This version of the `crontab -l` parser supports output that contains user

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `csv` file parser
r"""jc - JSON Convert `csv` file parser
The `csv` parser will attempt to automatically detect the delimiter
character. If the delimiter cannot be detected it will default to comma.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `csv` file streaming parser
r"""jc - JSON Convert `csv` file streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `date` command output parser
r"""jc - JSON Convert `date` command output parser
The `epoch` calculated timestamp field is naive. (i.e. based on the local
time of the system the parser is run on)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert ISO 8601 Datetime string parser
r"""jc - JSON Convert ISO 8601 Datetime string parser
This parser supports standard ISO 8601 strings that include both date and
time. If no timezone or offset information is available in the string, then

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `debconf-show` command output parser
r"""jc - JSON Convert `debconf-show` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `df` command output parser
r"""jc - JSON Convert `df` command output parser
Values are normalized to bytes when using `df -h`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `dig` command output parser
r"""jc - JSON Convert `dig` command output parser
Options supported:
- `+noall +answer` options are supported in cases where only the answer

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert disabled parser
r"""jc - JSON Convert disabled parser
This parser has been disabled due to an error in the parser code.
"""

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `dmidecode` command output parser
r"""jc - JSON Convert `dmidecode` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `dpkg -l` command output parser
r"""jc - JSON Convert `dpkg -l` command output parser
Set the `COLUMNS` environment variable to a large value to avoid field
truncation. For example:

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `du` command output parser
r"""jc - JSON Convert `du` command output parser
The `du -h` option is not supported with the default output. If you
would like to use `du -h` or other options that change the output, be sure

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `efibootmgr` command output parser
r"""jc - JSON Convert `efibootmgr` command output parser
The `-v` option is also supported.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert Email Address string parser
r"""jc - JSON Convert Email Address string parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `env` and `printenv` command output parser
r"""jc - JSON Convert `env` and `printenv` command output parser
This parser will output a list of dictionaries each containing `name` and
`value` keys. If you would like a simple dictionary output, then use the

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ethtool` command output parser
r"""jc - JSON Convert `ethtool` command output parser
Supports standard `ethtool` output and the `--module-info` option.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `file` command output parser
r"""jc - JSON Convert `file` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `find` command output parser
r"""jc - JSON Convert `find` command output parser
This parser returns a list of objects by default and a list of strings if
the `--raw` option is used.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `findmnt` command output parser
r"""jc - JSON Convert `findmnt` command output parser
Supports `-a`, `-l`, or no `findmnt` options.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `finger` command output parser
r"""jc - JSON Convert `finger` command output parser
Supports `-s` output option. Does not support the `-l` detail option.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `foo` command output parser
r"""jc - JSON Convert `foo` command output parser
<<Short foo description and caveats>>

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `foo` command output streaming parser
r"""jc - JSON Convert `foo` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `free` command output parser
r"""jc - JSON Convert `free` command output parser
Values are normalized to bytes when using `free -h`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `fstab` file parser
r"""jc - JSON Convert `fstab` file parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `git log` command output parser
r"""jc - JSON Convert `git log` command output parser
Can be used with the following format options:
- `oneline`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `git log` command output streaming parser
r"""jc - JSON Convert `git log` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `git ls-remote` command output parser
r"""jc - JSON Convert `git ls-remote` command output parser
This parser outputs two schemas:

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `gpg --with-colons` command output parser
r"""jc - JSON Convert `gpg --with-colons` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `/etc/group` file parser
r"""jc - JSON Convert `/etc/group` file parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `/etc/gshadow` file parser
r"""jc - JSON Convert `/etc/gshadow` file parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `hash` command output parser
r"""jc - JSON Convert `hash` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `hash sum` command output parser
r"""jc - JSON Convert `hash sum` command output parser
This parser works with the following hash calculation utilities:
- `md5`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `hciconfig` command output parser
r"""jc - JSON Convert `hciconfig` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `host` command output parser
r"""jc - JSON Convert `host` command output parser
Supports parsing of the most commonly used RR types (A, AAAA, MX, TXT)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `/etc/hosts` file parser
r"""jc - JSON Convert `/etc/hosts` file parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `id` command output parser
r"""jc - JSON Convert `id` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ifconfig` command output parser
r"""jc - JSON Convert `ifconfig` command output parser
No `ifconfig` options are supported.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iftop` command output parser
r"""jc - JSON Convert `iftop` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert INI file parser
r"""jc - JSON Convert INI file parser
Parses standard INI files.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert INI with duplicate key file parser
r"""jc - JSON Convert INI with duplicate key file parser
Parses standard INI files and preserves duplicate values. All values are
contained in lists/arrays.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iostat` command output parser
r"""jc - JSON Convert `iostat` command output parser
> Note: `iostat` version 11 and higher include a JSON output option

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iostat` command output streaming parser
r"""jc - JSON Convert `iostat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert IP Address string parser
r"""jc - JSON Convert IP Address string parser
Accepts standard and integer IP address notation for both IPv4 and IPv6
addresses. CIDR subnet mask and Scope ID is also allowed for standard

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ip route` command output parser
r"""jc - JSON Convert `ip route` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iptables` command output parser
r"""jc - JSON Convert `iptables` command output parser
Supports `-vLn` and `--line-numbers` for all tables.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iw dev <device> scan` command output parser
r"""jc - JSON Convert `iw dev <device> scan` command output parser
This parser is considered beta quality. Not all fields are parsed and there
are not enough samples to test.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `iwconfig` command output parser
r"""jc - JSON Convert `iwconfig` command output parser
No `iwconfig` options are supported.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `jobs` command output parser
r"""jc - JSON Convert `jobs` command output parser
Also supports the `-l` option.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert JWT string parser
r"""jc - JSON Convert JWT string parser
> Note: `jc` will not check the integrity of the JWT payload.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `Key/Value` file and string parser
r"""jc - JSON Convert `Key/Value` file and string parser
Supports files containing simple key/value pairs.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `Key/Value` with duplicate key file and string parser
r"""jc - JSON Convert `Key/Value` with duplicate key file and string parser
Supports files containing simple key/value pairs and preserves duplicate
values. All values are contained in lists/arrays.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `last` and `lastb` command output parser
r"""jc - JSON Convert `last` and `lastb` command output parser
Supports `-w`, `-F`, and `-x` options.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ls` and `vdir` command output parser
r"""jc - JSON Convert `ls` and `vdir` command output parser
Options supported:
- `lbaR1`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ls` and `vdir` command output streaming parser
r"""jc - JSON Convert `ls` and `vdir` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lsattr` command output parser
r"""jc - JSON Convert `lsattr` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lsb_release` command parser
r"""jc - JSON Convert `lsb_release` command parser
This parser is an alias to the Key/Value parser (`--kv`).

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lsmod` command output parser
r"""jc - JSON Convert `lsmod` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lsof` command output parser
r"""jc - JSON Convert `lsof` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lspci -mmv` command output parser
r"""jc - JSON Convert `lspci -mmv` command output parser
This parser supports the following `lspci` options:
- `-mmv`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `lsusb` command output parser
r"""jc - JSON Convert `lsusb` command output parser
Supports the `-v` option or no options.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `mdadm` command output parser
r"""jc - JSON Convert `mdadm` command output parser
Supports the `--query` and `--examine` options in `mdadm`.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `mount` command output parser
r"""jc - JSON Convert `mount` command output parser
Usage (cli):

View File

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

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `mpstat` command output streaming parser
r"""jc - JSON Convert `mpstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `needrestart -b` command output parser
r"""jc - JSON Convert `needrestart -b` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `netstat` command output parser
r"""jc - JSON Convert `netstat` command output parser
Caveats:
- Use of multiple `l` options is not supported on OSX (e.g. `netstat -rlll`)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert FreeBSD and OSX netstat Parser"""
r"""jc - JSON Convert FreeBSD and OSX netstat Parser"""
def normalize_headers(header):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert Linux netstat Parser"""
r"""jc - JSON Convert Linux netstat Parser"""
import string

View File

@ -1,4 +1,4 @@
"""
r"""
jc - JSON Convert Windows `netstat` command output parser
"""

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `nmcli` command output parser
r"""jc - JSON Convert `nmcli` command output parser
Supports the following `nmcli` subcommands:
- `nmcli general`

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `nsd-control` command output parser
r"""jc - JSON Convert `nsd-control` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ntpq -p` command output parser
r"""jc - JSON Convert `ntpq -p` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert openvpn-status.log file parser
r"""jc - JSON Convert openvpn-status.log file parser
The `*_epoch` calculated timestamp fields are naive. (i.e. based on
the local time of the system the parser is run on)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `os-prober` command output parser
r"""jc - JSON Convert `os-prober` command output parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `/etc/passwd` file Parser
r"""jc - JSON Convert `/etc/passwd` file Parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert POSIX path string parser
r"""jc - JSON Convert POSIX path string parser
Parse a POSIX path.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert POSIX path list string parser
r"""jc - JSON Convert POSIX path list string parser
Parse a colon-separated POSIX path list, commonly found in environment
variables.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pci.ids` file parser
r"""jc - JSON Convert `pci.ids` file parser
This parser converts the pci.ids database file.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert PostgreSQL password file parser
r"""jc - JSON Convert PostgreSQL password file parser
Usage (cli):

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pidstat -H` command output parser
r"""jc - JSON Convert `pidstat -H` command output parser
Must use the `-H` (or `-h`, if `-H` is not available) option in `pidstat`.
All other `pidstat` options are supported in combination with this option.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pidstat -H` command output streaming parser
r"""jc - JSON Convert `pidstat -H` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ping` command output parser
r"""jc - JSON Convert `ping` command output parser
Supports `ping` and `ping6` output.

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `ping` command output streaming parser
r"""jc - JSON Convert `ping` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `pip-list` command output parser
r"""jc - JSON Convert `pip-list` command output parser
Usage (cli):

Some files were not shown because too many files have changed in this diff Show More