add hosts docs

README.md

@@ -71,6 +71,7 @@ jc PARSER [OPTIONS]
 - `--env` enables the `env` parser
 - `--free` enables the `free` parser
 - `--history` enables the `history` parser
+- `--hosts` enables the `/etc/hosts` file parser
 - `--ifconfig` enables the `ifconfig` parser
 - `--iptables` enables the `iptables` parser
 - `--jobs` enables the `jobs` parser
@@ -400,6 +401,55 @@ $ history | jc --history -p
   ...
 ]
 ```
+### /etc/hosts
+```
+$ cat /etc/hosts | jc --hosts -p
+[
+  {
+    "ip": "127.0.0.1",
+    "hostname": [
+      "localhost"
+    ]
+  },
+  {
+    "ip": "127.0.1.1",
+    "hostname": [
+      "root-ubuntu"
+    ]
+  },
+  {
+    "ip": "::1",
+    "hostname": [
+      "ip6-localhost",
+      "ip6-loopback"
+    ]
+  },
+  {
+    "ip": "fe00::0",
+    "hostname": [
+      "ip6-localnet"
+    ]
+  },
+  {
+    "ip": "ff00::0",
+    "hostname": [
+      "ip6-mcastprefix"
+    ]
+  },
+  {
+    "ip": "ff02::1",
+    "hostname": [
+      "ip6-allnodes"
+    ]
+  },
+  {
+    "ip": "ff02::2",
+    "hostname": [
+      "ip6-allrouters"
+    ]
+  }
+]
+```
 ### ifconfig
 ```
 $ ifconfig | jc --ifconfig -p
@@ -1257,7 +1307,6 @@ Future parsers:
 - nslookup
 - systemctl
 - journalctl
-- hosts file
 - fstab file
 - crontab files
 - /proc files

docgen.sh

@@ -10,6 +10,7 @@ pydocmd simple jc.parsers.dig+ > ../docs/parsers/dig.md
 pydocmd simple jc.parsers.env+ > ../docs/parsers/env.md
 pydocmd simple jc.parsers.free+ > ../docs/parsers/free.md
 pydocmd simple jc.parsers.history+ > ../docs/parsers/history.md
+pydocmd simple jc.parsers.hosts+ > ../docs/parsers/hosts.md
 pydocmd simple jc.parsers.ifconfig+ > ../docs/parsers/ifconfig.md
 pydocmd simple jc.parsers.iptables+ > ../docs/parsers/iptables.md
 pydocmd simple jc.parsers.jobs+ > ../docs/parsers/jobs.md

docs/parsers/hosts.md

@@ -0,0 +1,96 @@
+# jc.parsers.hosts
+jc - JSON CLI output utility hosts Parser
+
+Usage:
+    specify --hosts as the first argument if the piped input is coming from hosts
+
+Examples:
+
+    $ cat /etc/hosts | jc --hosts -p
+    [
+      {
+        "ip": "127.0.0.1",
+        "hostname": [
+          "localhost"
+        ]
+      },
+      {
+        "ip": "127.0.1.1",
+        "hostname": [
+          "root-ubuntu"
+        ]
+      },
+      {
+        "ip": "::1",
+        "hostname": [
+          "ip6-localhost",
+          "ip6-loopback"
+        ]
+      },
+      {
+        "ip": "fe00::0",
+        "hostname": [
+          "ip6-localnet"
+        ]
+      },
+      {
+        "ip": "ff00::0",
+        "hostname": [
+          "ip6-mcastprefix"
+        ]
+      },
+      {
+        "ip": "ff02::1",
+        "hostname": [
+          "ip6-allnodes"
+        ]
+      },
+      {
+        "ip": "ff02::2",
+        "hostname": [
+          "ip6-allrouters"
+        ]
+      }
+    ]
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    dictionary   structured data with the following schema:
+
+    [
+      {
+        "ip":           string,
+        "hostname": [
+                        string
+        ]
+      }
+    ]
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    dictionary   raw or processed structured data
+

jc/parsers/hosts.py

@@ -16,7 +16,7 @@ Examples:
       {
         "ip": "127.0.1.1",
         "hostname": [
-          "kbrazil-ubuntu"
+          "root-ubuntu"
         ]
       },
       {