Merge pull request #209 from kellyjonbrazil/dev

Dev v1.18.4
kellyjonbrazil · Mar 5, 2022 · 6afb1d3 · 6afb1d3
2 parents 961968a + 9861983
commit 6afb1d3
Show file tree

Hide file tree

Showing 230 changed files with 1,764 additions and 309 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,11 @@
 jc changelog
 
+20220304 v1.18.4
+- Add nmcli command parser tested on linux
+- Enhance parse error messages at the cli
+- Add standard and streaming parser list functions to the public API
+- Enhance python developer documentation formatting
+
 20220214 v1.18.3
 - Add rsync command and log file parser tested on linux and macOS
 - Add rsync command and log file streaming parser tested on linux and macOS

diff --git a/EXAMPLES.md b/EXAMPLES.md
@@ -2387,6 +2387,47 @@ netstat -i | jc --netstat -p          # or:  jc -p netstat -i
   }
 ]
 ```
+### nmcli
+```bash
+nmcli connection show ens33 | jc --nmcli -p          # or jc -p nmcli connection show ens33
+```
+```json
+[
+      {
+        "connection_id": "ens33",
+        "connection_uuid": "d92ece08-9e02-47d5-b2d2-92c80e155744",
+        "connection_stable_id": null,
+        "connection_type": "802-3-ethernet",
+        "connection_interface_name": "ens33",
+        "connection_autoconnect": "yes",
+        "ip4_address_1": "192.168.71.180/24",
+        "ip4_gateway": "192.168.71.2",
+        "ip4_route_1": {
+          "dst": "0.0.0.0/0",
+          "nh": "192.168.71.2",
+          "mt": 100
+        },
+        "ip4_route_2": {
+          "dst": "192.168.71.0/24",
+          "nh": "0.0.0.0",
+          "mt": 100
+        },
+        "ip4_dns_1": "192.168.71.2",
+        "ip4_domain_1": "localdomain",
+        "dhcp4_option_1": {
+          "name": "broadcast_address",
+          "value": "192.168.71.255"
+        },
+        "ip6_address_1": "fe80::c1cb:715d:bc3e:b8a0/64",
+        "ip6_gateway": null,
+        "ip6_route_1": {
+          "dst": "fe80::/64",
+          "nh": "::",
+          "mt": 100
+        }
+      }
+    ]
+```
 ### ntpq
 ```bash
 ntpq -p | jc --ntpq -p          # or:  jc -p ntpq -p

diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
 ![Tests](https://github.com/kellyjonbrazil/jc/workflows/Tests/badge.svg?branch=master)
 ![Pypi](https://img.shields.io/pypi/v/jc.svg)
 
-> `jc` was recently featured in the [Console Open Source Newsletter](https://console.substack.com/p/console-89)
-
 > Check out the `jc` Python [package documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs) for developers
 
 > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/)
@@ -13,7 +11,7 @@ Ansible filter plugin in the `community.general` collection. See this
 for an example.
 
 # JC
-JSON CLI output utility
+JSON Convert
 
 `jc` JSONifies the output of many CLI tools and file-types for easier parsing in
 scripts. See the [**Parsers**](#parsers) section for supported commands and
@@ -55,16 +53,9 @@ will be a python dictionary, or list of dictionaries, instead of JSON:
 >>> cmd_output = subprocess.check_output(['dig', 'example.com'], text=True)
 >>> data = jc.parse('dig', cmd_output)
 >>>
->>> data
-[{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', 'flags': ['qr', 'rd',
-'ra'], 'query_num': 1, 'answer_num': 1, 'authority_num': 0, 'additional_num':
-1, 'opt_pseudosection': {'edns': {'version': 0, 'flags': [], 'udp': 4096}},
-'question': {'name': 'example.com.', 'class': 'IN', 'type': 'A'}, 'answer':
+>>> data[0]['answer']
 [{'name': 'example.com.', 'class': 'IN', 'type': 'A', 'ttl': 29658, 'data':
-'93.184.216.34'}], 'query_time': 52, 'server':
-'2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when':
-'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56, 'when_epoch': 1618614780,
-'when_epoch_utc': None}]
+'93.184.216.34'}]
 ```
 
 > For `jc` Python package documentation, use `help('jc')`, `help('jc.lib')`, or
@@ -199,6 +190,7 @@ option.
 - `--lsusb` enables the `lsusb` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/lsusb))
 - `--mount` enables the `mount` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/mount))
 - `--netstat` enables the `netstat` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/netstat))
+- `--nmcli` enables the `nmcli` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli))
 - `--ntpq` enables the `ntpq -p` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq))
 - `--passwd` enables the `/etc/passwd` file parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd))
 - `--ping` enables the `ping` and `ping6` command parser ([documentation](https://kellyjonbrazil.github.io/jc/docs/parsers/ping))

diff --git a/docgen.sh b/docgen.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 # Generate docs.md
-# requires pydoc-markdown 4.5.0
+# requires pydoc-markdown 4.6.1
 readme_config=$(cat <<'EOF'
 {
     "processors": [
@@ -18,7 +18,7 @@ readme_config=$(cat <<'EOF'
             "Class": 3,
             "Method": 3,
             "Function": 3,
-            "Data": 3
+            "Variable": 3
         }
     }
 }
@@ -43,7 +43,7 @@ toc_config=$(cat <<'EOF'
             "Class": 3,
             "Method": 3,
             "Function": 3,
-            "Data": 3
+            "Variable": 3
         }
     }
 }
@@ -68,7 +68,7 @@ parser_config=$(cat <<'EOF'
             "Class": 3,
             "Method": 3,
             "Function": 3,
-            "Data": 3
+            "Variable": 3
         }
     }
 }

diff --git a/docs/lib.md b/docs/lib.md
@@ -4,6 +4,8 @@
   * [parse](#jc.lib.parse)
   * [parser\_mod\_list](#jc.lib.parser_mod_list)
   * [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list)
+  * [standard\_parser\_mod\_list](#jc.lib.standard_parser_mod_list)
+  * [streaming\_parser\_mod\_list](#jc.lib.streaming_parser_mod_list)
   * [parser\_info](#jc.lib.parser_info)
   * [all\_parser\_info](#jc.lib.all_parser_info)
   * [get\_help](#jc.lib.get_help)
@@ -12,15 +14,20 @@
 
 # jc.lib
 
-jc - JSON CLI output utility
+jc - JSON Convert
 JC lib module
 
 <a id="jc.lib.parse"></a>
 
 ### parse
 
 ```python
-def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: bool = False, raw: bool = False, ignore_exceptions: bool = None, **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]]
+def parse(parser_mod_name: str,
+          data: Union[str, Iterable[str]],
+          quiet: bool = False,
+          raw: bool = False,
+          ignore_exceptions: bool = None,
+          **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]]
 ```
 
 Parse the string data using the supplied parser module.
@@ -34,9 +41,7 @@ Example:
     >>> jc.parse('date', 'Tue Jan 18 10:23:07 PST 2022')
     {'year': 2022, 'month': 'Jan', 'month_num': 1, 'day'...}
 
-To get a list of available parser module names, use `parser_mod_list()`
-or `plugin_parser_mod_list()`. `plugin_parser_mod_list()` is a subset
-of `parser_mod_list()`.
+To get a list of available parser module names, use `parser_mod_list()`.
 
 You can also use the lower-level parser modules directly:
 
@@ -100,6 +105,29 @@ def plugin_parser_mod_list() -> List[str]
 Returns a list of plugin parser module names. This function is a
 subset of `parser_mod_list()`.
 
+<a id="jc.lib.standard_parser_mod_list"></a>
+
+### standard\_parser\_mod\_list
+
+```python
+def standard_parser_mod_list() -> List[str]
+```
+
+Returns a list of standard parser module names. This function is a
+subset of `parser_mod_list()` and does not contain any streaming
+parsers.
+
+<a id="jc.lib.streaming_parser_mod_list"></a>
+
+### streaming\_parser\_mod\_list
+
+```python
+def streaming_parser_mod_list() -> List[str]
+```
+
+Returns a list of streaming parser module names. This function is a
+subset of `parser_mod_list()`.
+
 <a id="jc.lib.parser_info"></a>
 
 ### parser\_info

diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.acpi
 
-jc - JSON CLI output utility `acpi` command output parser
+jc - JSON Convert `acpi` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.airport
 
-jc - JSON CLI output utility `airport -I` command output parser
+jc - JSON Convert `airport -I` command output parser
 
 The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 

diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.airport\_s
 
-jc - JSON CLI output utility `airport -s` command output parser
+jc - JSON Convert `airport -s` command output parser
 
 The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 

diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.arp
 
-jc - JSON CLI output utility `arp` command output parser
+jc - JSON Convert `arp` command output parser
 
 Supports `arp` and `arp -a` output.
 

diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.blkid
 
-jc - JSON CLI output utility `blkid` command output parser
+jc - JSON Convert `blkid` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.cksum
 
-jc - JSON CLI output utility `cksum` command output parser
+jc - JSON Convert `cksum` command output parser
 
 This parser works with the following checksum calculation utilities:
 - `sum`

diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.crontab
 
-jc - JSON CLI output utility `crontab -l` command output and crontab
+jc - JSON Convert `crontab -l` command output and crontab
 file parser
 
 Supports `crontab -l` command output and crontab files.

diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.crontab\_u
 
-jc - JSON CLI output utility `crontab -l` command output and crontab
+jc - JSON Convert `crontab -l` command output and crontab
 file parser
 
 This version of the `crontab -l` parser supports output that contains user

diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.csv
 
-jc - JSON CLI output utility `csv` file parser
+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.

diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.csv\_s
 
-jc - JSON CLI output utility `csv` file streaming parser
+jc - JSON Convert `csv` file streaming parser
 
 > This streaming parser outputs JSON Lines
 

diff --git a/docs/parsers/date.md b/docs/parsers/date.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.date
 
-jc - JSON CLI output utility `date` command output parser
+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)

diff --git a/docs/parsers/df.md b/docs/parsers/df.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.df
 
-jc - JSON CLI output utility `df` command output parser
+jc - JSON Convert `df` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.dig
 
-jc - JSON CLI output utility `dig` command output parser
+jc - JSON Convert `dig` command output parser
 
 Options supported:
 - `+noall +answer` options are supported in cases where only the answer

diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.dir
 
-jc - JSON CLI output utility `dir` command output parser
+jc - JSON Convert `dir` command output parser
 
 Options supported:
 - `/T timefield`

diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.dmidecode
 
-jc - JSON CLI output utility `dmidecode` command output parser
+jc - JSON Convert `dmidecode` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.dpkg\_l
 
-jc - JSON CLI output utility `dpkg -l` command output parser
+jc - JSON Convert `dpkg -l` command output parser
 
 Set the `COLUMNS` environment variable to a large value to avoid field
 truncation. For example:

diff --git a/docs/parsers/du.md b/docs/parsers/du.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.du
 
-jc - JSON CLI output utility `du` command output parser
+jc - JSON Convert `du` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/env.md b/docs/parsers/env.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.env
 
-jc - JSON CLI output utility `env` and `printenv` command output parser
+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

diff --git a/docs/parsers/file.md b/docs/parsers/file.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.file
 
-jc - JSON CLI output utility `file` command output parser
+jc - JSON Convert `file` command output parser
 
 Usage (cli):
 

diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md
@@ -3,7 +3,7 @@
 
 # jc.parsers.finger
 
-jc - JSON CLI output utility `finger` command output parser
+jc - JSON Convert `finger` command output parser
 
 Supports `-s` output option. Does not support the `-l` detail option.