From 1675aa7a59429bab9f8a8865b36ee5ecb5c6a6a3 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 15 Jun 2022 16:08:31 -0700 Subject: [PATCH 01/14] add shell completion wiki link --- README.md | 30 +++++++++++++++--------------- templates/readme_template | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index f1d2bbcb..dc1f5286 100644 --- a/README.md +++ b/README.md @@ -251,21 +251,21 @@ option. | ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | ### Options -| Short | Long | Description | -|-------|-----------------|--------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | Monochrome output | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the diff --git a/templates/readme_template b/templates/readme_template index 36fefd2a..1b01b905 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -149,21 +149,21 @@ option. | `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} ### Options -| Short | Long | Description | -|-------|-----------------|--------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | Monochrome output | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the From 9911b3fc9d33d4256f5500b702703eafdb9d69db Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 15 Jun 2022 16:11:22 -0700 Subject: [PATCH 02/14] formatting --- README.md | 30 +++++++++++++++--------------- templates/readme_template | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index dc1f5286..e47a6f32 100644 --- a/README.md +++ b/README.md @@ -251,21 +251,21 @@ option. | ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | ### Options -| Short | Long | Description | -|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | Monochrome output | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | +| Short | Long | Description | +|-------|-----------------|---------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the diff --git a/templates/readme_template b/templates/readme_template index 1b01b905..6f3e9b34 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -149,21 +149,21 @@ option. | `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} ### Options -| Short | Long | Description | -|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | Monochrome output | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script (see this [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions) for more info) | +| Short | Long | Description | +|-------|-----------------|---------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the From edef264f17027e24f099bf96beebe06238b2a377 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 15 Jun 2022 20:04:39 -0700 Subject: [PATCH 03/14] formatting --- README.md | 5 +++-- templates/readme_template | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e47a6f32..3a538188 100644 --- a/README.md +++ b/README.md @@ -144,8 +144,8 @@ option. ### Parsers -| Argument | Command or Filetype | Documentation | -|-------------------|---------------------------------------------------------|-------------------------------------------------------------------------| +| Argument | Command or Filetype | Documentation | +|-------------------|---------------------------------------------------------|------------------------------------------------------------------------| | ` --acpi` | `acpi` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/acpi) | | ` --airport` | `airport -I` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/airport) | | ` --airport-s` | `airport -s` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/airport_s) | @@ -251,6 +251,7 @@ option. | ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | ### Options + | Short | Long | Description | |-------|-----------------|---------------------------------------------------------------------------------------------------------------------| | `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | diff --git a/templates/readme_template b/templates/readme_template index 6f3e9b34..c7fb4b0d 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -144,11 +144,12 @@ option. ### Parsers -| Argument | Command or Filetype | Documentation | -|-------------------|---------------------------------------------------------|-------------------------------------------------------------------------|{% for parser in jc.parsers %} +| Argument | Command or Filetype | Documentation | +|-------------------|---------------------------------------------------------|------------------------------------------------------------------------|{% for parser in jc.parsers %} | `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} ### Options + | Short | Long | Description | |-------|-----------------|---------------------------------------------------------------------------------------------------------------------| | `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | From 6adfa15742b6069d344833f84240b9efaecea06a Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 15 Jun 2022 20:10:55 -0700 Subject: [PATCH 04/14] formatting --- README.md | 210 +++++++++++++++++++------------------- templates/readme_template | 6 +- 2 files changed, 108 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 3a538188..f5d1a478 100644 --- a/README.md +++ b/README.md @@ -144,111 +144,111 @@ option. ### Parsers -| Argument | Command or Filetype | Documentation | -|-------------------|---------------------------------------------------------|------------------------------------------------------------------------| -| ` --acpi` | `acpi` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/acpi) | -| ` --airport` | `airport -I` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/airport) | -| ` --airport-s` | `airport -s` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/airport_s) | -| ` --arp` | `arp` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/arp) | -| ` --asciitable` | ASCII and Unicode table parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable) | -| ` --asciitable-m` | multi-line ASCII and Unicode table parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable_m) | -| ` --blkid` | `blkid` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/blkid) | -| ` --chage` | `chage --list` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/chage) | -| ` --cksum` | `cksum` and `sum` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/cksum) | -| ` --crontab` | `crontab` command and file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab) | -| ` --crontab-u` | `crontab` file parser with user support | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab_u) | -| ` --csv` | CSV file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/csv) | -| ` --csv-s` | CSV file streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/csv_s) | -| ` --date` | `date` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/date) | -| ` --df` | `df` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/df) | -| ` --dig` | `dig` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/dig) | -| ` --dir` | `dir` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/dir) | -| ` --dmidecode` | `dmidecode` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/dmidecode) | -| ` --dpkg-l` | `dpkg -l` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/dpkg_l) | -| ` --du` | `du` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/du) | -| ` --env` | `env` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/env) | -| ` --file` | `file` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/file) | -| ` --finger` | `finger` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/finger) | -| ` --free` | `free` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/free) | -| ` --fstab` | `/etc/fstab` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/fstab) | -| ` --git-log` | `git log` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log) | -| ` --git-log-s` | `git log` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log_s) | -| ` --group` | `/etc/group` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/group) | -| ` --gshadow` | `/etc/gshadow` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/gshadow) | -| ` --hash` | `hash` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/hash) | -| ` --hashsum` | hashsum command parser (`md5sum`, `shasum`, etc.) | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/hashsum) | -| ` --hciconfig` | `hciconfig` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/hciconfig) | -| ` --history` | `history` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/history) | -| ` --hosts` | `/etc/hosts` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/hosts) | -| ` --id` | `id` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/id) | -| ` --ifconfig` | `ifconfig` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ifconfig) | -| ` --ini` | INI file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ini) | -| ` --iostat` | `iostat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat) | -| ` --iostat-s` | `iostat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat_s) | -| ` --iptables` | `iptables` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/iptables) | -| ` --iw-scan` | `iw dev [device] scan` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/iw_scan) | -| ` --jar-manifest` | MANIFEST.MF file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/jar_manifest) | -| ` --jobs` | `jobs` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs) | -| ` --kv` | Key/Value file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/kv) | -| ` --last` | `last` and `lastb` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/last) | -| ` --ls` | `ls` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ls) | -| ` --ls-s` | `ls` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ls_s) | -| ` --lsblk` | `lsblk` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/lsblk) | -| ` --lsmod` | `lsmod` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/lsmod) | -| ` --lsof` | `lsof` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/lsof) | -| ` --lsusb` | `lsusb` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/lsusb) | -| ` --mount` | `mount` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/mount) | -| ` --mpstat` | `mpstat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat) | -| ` --mpstat-s` | `mpstat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat_s) | -| ` --netstat` | `netstat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/netstat) | -| ` --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) | -| ` --passwd` | `/etc/passwd` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd) | -| ` --pidstat` | `pidstat -h` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) | -| ` --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-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-show` | `pip show` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_show) | -| ` --postconf` | `postconf -M` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/postconf) | -| ` --ps` | `ps` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ps) | -| ` --route` | `route` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/route) | -| ` --rpm-qi` | `rpm -qi` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/rpm_qi) | -| ` --rsync` | `rsync` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync) | -| ` --rsync-s` | `rsync` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync_s) | -| ` --sfdisk` | `sfdisk` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/sfdisk) | -| ` --shadow` | `/etc/shadow` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/shadow) | -| ` --ss` | `ss` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ss) | -| ` --stat` | `stat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/stat) | -| ` --stat-s` | `stat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/stat_s) | -| ` --sysctl` | `sysctl` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/sysctl) | -| ` --systemctl` | `systemctl` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl) | -| ` --systemctl-lj` | `systemctl list-jobs` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_lj) | -| ` --systemctl-ls` | `systemctl list-sockets` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_ls) | -| `--systemctl-luf` | `systemctl list-unit-files` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_luf) | -| ` --systeminfo` | `systeminfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/systeminfo) | -| ` --time` | `/usr/bin/time` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/time) | -| ` --timedatectl` | `timedatectl status` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/timedatectl) | -| ` --top` | `top -b` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/top) | -| ` --top-s` | `top -b` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/top_s) | -| ` --tracepath` | `tracepath` and `tracepath6` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/tracepath) | -| ` --traceroute` | `traceroute` and `traceroute6` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/traceroute) | -| ` --ufw` | `ufw status` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw) | -| ` --ufw-appinfo` | `ufw app info [application]` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw_appinfo) | -| ` --uname` | `uname -a` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/uname) | -| `--update-alt-gs` | `update-alternatives --get-selections` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/update_alt_gs) | -| ` --update-alt-q` | `update-alternatives --query` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/update_alt_q) | -| ` --upower` | `upower` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/upower) | -| ` --uptime` | `uptime` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/uptime) | -| ` --vmstat` | `vmstat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat) | -| ` --vmstat-s` | `vmstat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat_s) | -| ` --w` | `w` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/w) | -| ` --wc` | `wc` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/wc) | -| ` --who` | `who` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/who) | -| ` --xml` | XML file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/xml) | -| ` --xrandr` | `xrandr` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/xrandr) | -| ` --yaml` | YAML file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/yaml) | -| ` --zipinfo` | `zipinfo` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | +| Argument | Command or Filetype | Documentation | +|-------------------|---------------------------------------------------------|----------------------------------------------------------------------------| +| ` --acpi` | `acpi` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/acpi) | +| ` --airport` | `airport -I` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/airport) | +| ` --airport-s` | `airport -s` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/airport_s) | +| ` --arp` | `arp` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/arp) | +| ` --asciitable` | ASCII and Unicode table parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable) | +| ` --asciitable-m` | multi-line ASCII and Unicode table parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/asciitable_m) | +| ` --blkid` | `blkid` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/blkid) | +| ` --chage` | `chage --list` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/chage) | +| ` --cksum` | `cksum` and `sum` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/cksum) | +| ` --crontab` | `crontab` command and file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab) | +| ` --crontab-u` | `crontab` file parser with user support | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/crontab_u) | +| ` --csv` | CSV file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/csv) | +| ` --csv-s` | CSV file streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/csv_s) | +| ` --date` | `date` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/date) | +| ` --df` | `df` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/df) | +| ` --dig` | `dig` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dig) | +| ` --dir` | `dir` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dir) | +| ` --dmidecode` | `dmidecode` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dmidecode) | +| ` --dpkg-l` | `dpkg -l` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/dpkg_l) | +| ` --du` | `du` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/du) | +| ` --env` | `env` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/env) | +| ` --file` | `file` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/file) | +| ` --finger` | `finger` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/finger) | +| ` --free` | `free` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/free) | +| ` --fstab` | `/etc/fstab` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/fstab) | +| ` --git-log` | `git log` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log) | +| ` --git-log-s` | `git log` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/git_log_s) | +| ` --group` | `/etc/group` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/group) | +| ` --gshadow` | `/etc/gshadow` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/gshadow) | +| ` --hash` | `hash` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/hash) | +| ` --hashsum` | hashsum command parser (`md5sum`, `shasum`, etc.) | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/hashsum) | +| ` --hciconfig` | `hciconfig` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/hciconfig) | +| ` --history` | `history` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/history) | +| ` --hosts` | `/etc/hosts` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/hosts) | +| ` --id` | `id` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/id) | +| ` --ifconfig` | `ifconfig` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ifconfig) | +| ` --ini` | INI file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ini) | +| ` --iostat` | `iostat` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat) | +| ` --iostat-s` | `iostat` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iostat_s) | +| ` --iptables` | `iptables` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iptables) | +| ` --iw-scan` | `iw dev [device] scan` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/iw_scan) | +| ` --jar-manifest` | MANIFEST.MF file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jar_manifest) | +| ` --jobs` | `jobs` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/jobs) | +| ` --kv` | Key/Value file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/kv) | +| ` --last` | `last` and `lastb` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/last) | +| ` --ls` | `ls` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ls) | +| ` --ls-s` | `ls` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ls_s) | +| ` --lsblk` | `lsblk` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsblk) | +| ` --lsmod` | `lsmod` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsmod) | +| ` --lsof` | `lsof` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsof) | +| ` --lsusb` | `lsusb` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/lsusb) | +| ` --mount` | `mount` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mount) | +| ` --mpstat` | `mpstat` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat) | +| ` --mpstat-s` | `mpstat` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/mpstat_s) | +| ` --netstat` | `netstat` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/netstat) | +| ` --nmcli` | `nmcli` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli) | +| ` --ntpq` | `ntpq -p` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq) | +| ` --passwd` | `/etc/passwd` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd) | +| ` --pidstat` | `pidstat -h` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) | +| ` --pidstat-s` | `pidstat -h` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s) | +| ` --ping` | `ping` and `ping6` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ping) | +| ` --ping-s` | `ping` and `ping6` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s) | +| ` --pip-list` | `pip list` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list) | +| ` --pip-show` | `pip show` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_show) | +| ` --postconf` | `postconf -M` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/postconf) | +| ` --ps` | `ps` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ps) | +| ` --route` | `route` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/route) | +| ` --rpm-qi` | `rpm -qi` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rpm_qi) | +| ` --rsync` | `rsync` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync) | +| ` --rsync-s` | `rsync` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/rsync_s) | +| ` --sfdisk` | `sfdisk` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sfdisk) | +| ` --shadow` | `/etc/shadow` file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/shadow) | +| ` --ss` | `ss` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ss) | +| ` --stat` | `stat` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/stat) | +| ` --stat-s` | `stat` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/stat_s) | +| ` --sysctl` | `sysctl` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/sysctl) | +| ` --systemctl` | `systemctl` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl) | +| ` --systemctl-lj` | `systemctl list-jobs` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_lj) | +| ` --systemctl-ls` | `systemctl list-sockets` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_ls) | +| `--systemctl-luf` | `systemctl list-unit-files` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systemctl_luf) | +| ` --systeminfo` | `systeminfo` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/systeminfo) | +| ` --time` | `/usr/bin/time` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/time) | +| ` --timedatectl` | `timedatectl status` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/timedatectl) | +| ` --top` | `top -b` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/top) | +| ` --top-s` | `top -b` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/top_s) | +| ` --tracepath` | `tracepath` and `tracepath6` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/tracepath) | +| ` --traceroute` | `traceroute` and `traceroute6` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/traceroute) | +| ` --ufw` | `ufw status` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw) | +| ` --ufw-appinfo` | `ufw app info [application]` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/ufw_appinfo) | +| ` --uname` | `uname -a` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/uname) | +| `--update-alt-gs` | `update-alternatives --get-selections` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/update_alt_gs) | +| ` --update-alt-q` | `update-alternatives --query` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/update_alt_q) | +| ` --upower` | `upower` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/upower) | +| ` --uptime` | `uptime` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/uptime) | +| ` --vmstat` | `vmstat` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat) | +| ` --vmstat-s` | `vmstat` command streaming parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/vmstat_s) | +| ` --w` | `w` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/w) | +| ` --wc` | `wc` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/wc) | +| ` --who` | `who` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/who) | +| ` --xml` | XML file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/xml) | +| ` --xrandr` | `xrandr` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/xrandr) | +| ` --yaml` | YAML file parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/yaml) | +| ` --zipinfo` | `zipinfo` command parser | [details](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo) | ### Options diff --git a/templates/readme_template b/templates/readme_template index c7fb4b0d..d6e7f8e0 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -144,9 +144,9 @@ option. ### Parsers -| Argument | Command or Filetype | Documentation | -|-------------------|---------------------------------------------------------|------------------------------------------------------------------------|{% for parser in jc.parsers %} -| `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<70}".format("[📃](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} +| Argument | Command or Filetype | Documentation | +|-------------------|---------------------------------------------------------|----------------------------------------------------------------------------|{% for parser in jc.parsers %} +| `{{ "{:>15}".format(parser.argument) }}` | {{ "{:<55}".format(parser.description) }} | {{ "{:<74}".format("[details](https://kellyjonbrazil.github.io/jc/docs/parsers/" + parser.name + ")") }} |{% endfor %} ### Options From fe1f09f08d4d0ed2142c8af0d1abfe826bb56e0b Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 15 Jun 2022 20:15:24 -0700 Subject: [PATCH 05/14] use github markdown renderer --- _config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index c4192631..f4b41887 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,2 @@ -theme: jekyll-theme-cayman \ No newline at end of file +theme: jekyll-theme-cayman +markdown: GFM From 95189e37ba26e427306a4ca549d7dbc37edcb9f8 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 07:48:44 -0700 Subject: [PATCH 06/14] add streaming parsers link --- README.md | 3 ++- templates/readme_template | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f5d1a478..99cc750a 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' ``` The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, or list of dictionaries, instead of JSON: +will be a python dictionary, or list of dictionaries, or even a [lazy +iterable of dicionaries](#Streaming Parsers) instead of JSON: ```python >>> import subprocess >>> import jc diff --git a/templates/readme_template b/templates/readme_template index d6e7f8e0..d7fcc469 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -45,7 +45,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' ``` The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, or list of dictionaries, instead of JSON: +will be a python dictionary, or list of dictionaries, or even a [lazy +iterable of dicionaries](#Streaming Parsers) instead of JSON: ```python >>> import subprocess >>> import jc From c8a4890fc74954583c49d1c0b4b6120db90c0cfd Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 07:50:37 -0700 Subject: [PATCH 07/14] fix anchor link --- README.md | 2 +- templates/readme_template | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99cc750a..7081a823 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ $ jc dig example.com | jq -r '.[].answer[].data' The `jc` parsers can also be used as python modules. In this case the output will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#Streaming Parsers) instead of JSON: +iterable of dicionaries](#streaming-parsers) instead of JSON: ```python >>> import subprocess >>> import jc diff --git a/templates/readme_template b/templates/readme_template index d7fcc469..762e71b4 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -46,7 +46,7 @@ $ jc dig example.com | jq -r '.[].answer[].data' The `jc` parsers can also be used as python modules. In this case the output will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#Streaming Parsers) instead of JSON: +iterable of dicionaries](#streaming-parsers) instead of JSON: ```python >>> import subprocess >>> import jc From 229bef5f8274cbb9958a4c725249160e878b8d7f Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 07:52:58 -0700 Subject: [PATCH 08/14] update anchor link --- README.md | 3 ++- templates/readme_template | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7081a823..53eaf477 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' The `jc` parsers can also be used as python modules. In this case the output will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#streaming-parsers) instead of JSON: +iterable of dicionaries](#using-streaming-parsers-as-python-modules) instead +of JSON: ```python >>> import subprocess >>> import jc diff --git a/templates/readme_template b/templates/readme_template index 762e71b4..a9ed4c86 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -46,7 +46,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' The `jc` parsers can also be used as python modules. In this case the output will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#streaming-parsers) instead of JSON: +iterable of dicionaries](#using-streaming-parsers-as-python-modules) instead +of JSON: ```python >>> import subprocess >>> import jc From 992120b8613ba9d0e7709073d52a4bb4a87b694a Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 17:48:07 -0700 Subject: [PATCH 09/14] spelling --- README.md | 4 ++-- templates/readme_template | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53eaf477..ba7c40ae 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' ``` The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#using-streaming-parsers-as-python-modules) instead +will be a python dictionary, list of dictionaries, or even a [lazy +iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead of JSON: ```python >>> import subprocess diff --git a/templates/readme_template b/templates/readme_template index a9ed4c86..ceffcf79 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -45,8 +45,8 @@ $ jc dig example.com | jq -r '.[].answer[].data' ``` The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, or list of dictionaries, or even a [lazy -iterable of dicionaries](#using-streaming-parsers-as-python-modules) instead +will be a python dictionary, list of dictionaries, or even a [lazy +iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead of JSON: ```python >>> import subprocess From 9b710b0b6fb4019828717203addc67e687b37a4c Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 17:51:20 -0700 Subject: [PATCH 10/14] formatting --- README.md | 8 ++++---- templates/readme_template | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ba7c40ae..b7aba54d 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,10 @@ $ jc dig example.com | jq -r '.[].answer[].data' 93.184.216.34 ``` -The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, list of dictionaries, or even a [lazy -iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead -of JSON: +The `jc` can also be used as a python library. In this case the output will be +a python dictionary, a list of dictionaries, or even a +[lazy iterable of dictionaries](#using-streaming-parsers-as-python-modules) +instead of JSON: ```python >>> import subprocess >>> import jc diff --git a/templates/readme_template b/templates/readme_template index ceffcf79..dae90b8c 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -44,10 +44,10 @@ $ jc dig example.com | jq -r '.[].answer[].data' 93.184.216.34 ``` -The `jc` parsers can also be used as python modules. In this case the output -will be a python dictionary, list of dictionaries, or even a [lazy -iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead -of JSON: +The `jc` can also be used as a python library. In this case the output will be +a python dictionary, a list of dictionaries, or even a +[lazy iterable of dictionaries](#using-streaming-parsers-as-python-modules) +instead of JSON: ```python >>> import subprocess >>> import jc From 6f89745a58f74f9e28b5eab39bc9c6c3d8848fb3 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 17:51:59 -0700 Subject: [PATCH 11/14] formatting --- README.md | 2 +- templates/readme_template | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7aba54d..d9b8cb2f 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ $ jc dig example.com | jq -r '.[].answer[].data' 93.184.216.34 ``` -The `jc` can also be used as a python library. In this case the output will be +`jc` can also be used as a python library. In this case the output will be a python dictionary, a list of dictionaries, or even a [lazy iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead of JSON: diff --git a/templates/readme_template b/templates/readme_template index dae90b8c..8f5c6e96 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -44,7 +44,7 @@ $ jc dig example.com | jq -r '.[].answer[].data' 93.184.216.34 ``` -The `jc` can also be used as a python library. In this case the output will be +`jc` can also be used as a python library. In this case the output will be a python dictionary, a list of dictionaries, or even a [lazy iterable of dictionaries](#using-streaming-parsers-as-python-modules) instead of JSON: From 1f2e16aeeaf4eba78dc451c96a81b3f94091b46e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 17:54:40 -0700 Subject: [PATCH 12/14] formatting --- docs/readme.md | 2 +- jc/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index 8b6ef174..2335ca66 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -30,7 +30,7 @@ https://github.com/kellyjonbrazil/jc/tree/master/docs > Replace `` - e.g. `1.18.0`: -Specific versions can also be selected by tag in the branch Github dropdown +Specific versions can also be selected by tag in the Github branch dropdown menu. ## Usage Example diff --git a/jc/__init__.py b/jc/__init__.py index c19b8168..9f7522e8 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -26,7 +26,7 @@ https://github.com/kellyjonbrazil/jc/tree/master/docs > Replace `` - e.g. `1.18.0`: -Specific versions can also be selected by tag in the branch Github dropdown +Specific versions can also be selected by tag in the Github branch dropdown menu. ## Usage Example From 093c1703d76b4f7a6a469786697317dfb4e5579a Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 18:00:40 -0700 Subject: [PATCH 13/14] formatting --- docs/utils.md | 3 ++- jc/utils.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/utils.md b/docs/utils.md index bd8dc212..a73d980f 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -80,7 +80,8 @@ def compatibility(mod_name: str, ``` Checks for the parser's compatibility with the running OS platform and -prints a warning message to `STDERR` if not compatible and quiet=False. +prints a warning message to `STDERR` if not compatible and +`quiet=False.` Parameters: diff --git a/jc/utils.py b/jc/utils.py index 401c527e..70791767 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -114,7 +114,8 @@ def is_compatible(compatible: List) -> bool: def compatibility(mod_name: str, compatible: List, quiet: bool = False) -> None: """ Checks for the parser's compatibility with the running OS platform and - prints a warning message to `STDERR` if not compatible and quiet=False. + prints a warning message to `STDERR` if not compatible and + `quiet=False.` Parameters: From f1ed8035252d30e2637b6d38de740b1351b89f97 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 16 Jun 2022 18:03:51 -0700 Subject: [PATCH 14/14] formatting --- docs/utils.md | 2 +- jc/utils.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/utils.md b/docs/utils.md index a73d980f..7dac5f2e 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -106,7 +106,7 @@ def has_data(data: str) -> bool ``` Checks if the input contains data. If there are any non-whitespace -characters then return True, else return False. +characters then return `True`, else return `False`. Parameters: diff --git a/jc/utils.py b/jc/utils.py index 70791767..0504b367 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -143,7 +143,7 @@ def compatibility(mod_name: str, compatible: List, quiet: bool = False) -> None: def has_data(data: str) -> bool: """ Checks if the input contains data. If there are any non-whitespace - characters then return True, else return False. + characters then return `True`, else return `False`. Parameters: