xml example update

README.md

@@ -1680,6 +1680,7 @@ $ cat cd_catalog.xml | jc --xml -p
         "YEAR": "1988"
       },
   ...
+}
 ```
 ### YAML
 ```

docgen.sh

@@ -37,4 +37,5 @@ pydocmd simple jc.parsers.systemctl_luf+ > ../docs/parsers/systemctl_luf.md
 pydocmd simple jc.parsers.uname+ > ../docs/parsers/uname.md
 pydocmd simple jc.parsers.uptime+ > ../docs/parsers/uptime.md
 pydocmd simple jc.parsers.w+ > ../docs/parsers/w.md
+pydocmd simple jc.parsers.xml+ > ../docs/parsers/xml.md
 pydocmd simple jc.parsers.yaml+ > ../docs/parsers/yaml.md

docs/parsers/xml.md

@@ -0,0 +1,99 @@
+# jc.parsers.xml
+jc - JSON CLI output utility XML Parser
+
+Usage:
+
+    specify --xml as the first argument if the piped input is coming from a XML file
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+
+Examples:
+
+    $ cat cd_catalog.xml
+    <?xml version="1.0" encoding="UTF-8"?>
+    <CATALOG>
+      <CD>
+        <TITLE>Empire Burlesque</TITLE>
+        <ARTIST>Bob Dylan</ARTIST>
+        <COUNTRY>USA</COUNTRY>
+        <COMPANY>Columbia</COMPANY>
+        <PRICE>10.90</PRICE>
+        <YEAR>1985</YEAR>
+      </CD>
+      <CD>
+        <TITLE>Hide your heart</TITLE>
+        <ARTIST>Bonnie Tyler</ARTIST>
+        <COUNTRY>UK</COUNTRY>
+        <COMPANY>CBS Records</COMPANY>
+        <PRICE>9.90</PRICE>
+        <YEAR>1988</YEAR>
+      </CD>
+      ...
+
+    $ cat cd_catalog.xml | jc --xml -p
+    {
+      "CATALOG": {
+        "CD": [
+          {
+            "TITLE": "Empire Burlesque",
+            "ARTIST": "Bob Dylan",
+            "COUNTRY": "USA",
+            "COMPANY": "Columbia",
+            "PRICE": "10.90",
+            "YEAR": "1985"
+          },
+          {
+            "TITLE": "Hide your heart",
+            "ARTIST": "Bonnie Tyler",
+            "COUNTRY": "UK",
+            "COMPANY": "CBS Records",
+            "PRICE": "9.90",
+            "YEAR": "1988"
+          },
+      ...
+    }
+
+## 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 representing an XML document:
+
+    {
+      XML Document converted to a Dictionary
+      See https://github.com/martinblech/xmltodict for details
+    }
+
+## 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/xml.py

@@ -52,6 +52,7 @@ Examples:
             "YEAR": "1988"
           },
       ...
+    }
 """
 import jc.utils
 import xmltodict