doc update

docs/parsers/id.md

@@ -0,0 +1,133 @@
+# jc.parsers.id
+jc - JSON CLI output utility id Parser
+
+Usage:
+
+    specify --id as the first argument if the piped input is coming from id
+
+Compatibility:
+
+    'linux', 'darwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ id | jc --id -p
+    {
+      "uid": {
+        "id": 1000,
+        "name": "joeuser"
+      },
+      "gid": {
+        "id": 1000,
+        "name": "joeuser"
+      },
+      "groups": [
+        {
+          "id": 1000,
+          "name": "joeuser"
+        },
+        {
+          "id": 10,
+          "name": "wheel"
+        }
+      ],
+      "context": {
+        "user": "unconfined_u",
+        "role": "unconfined_r",
+        "type": "unconfined_t",
+        "level": "s0-s0:c0.c1023"
+      }
+    }
+
+    $ id | jc --id -p -r
+    {
+      "uid": {
+        "id": "1000",
+        "name": "joeuser"
+      },
+      "gid": {
+        "id": "1000",
+        "name": "joeuser"
+      },
+      "groups": [
+        {
+          "id": "1000",
+          "name": "joeuser"
+        },
+        {
+          "id": "10",
+          "name": "wheel"
+        }
+      ],
+      "context": {
+        "user": "unconfined_u",
+        "role": "unconfined_r",
+        "type": "unconfined_t",
+        "level": "s0-s0:c0.c1023"
+      }
+    }
+
+## info
+```python
+info(self, /, *args, **kwargs)
+```
+
+## 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:
+
+    {
+      "uid": {
+        "id":       integer,
+        "name":     string
+      },
+      "gid": {
+        "id":       integer,
+        "name":     string
+      },
+      "groups": [
+        {
+          "id":     integer,
+          "name":   string
+        },
+        {
+          "id":     integer,
+          "name":   string
+        }
+      ],
+      "context": {
+        "user":     string,
+        "role":     string,
+        "type":     string,
+        "level":    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:
+
+    List of dictionaries. Raw or processed structured data.
+