Merge pull request #4 from lurch/small_tweaks

Make output file an explicit argument.

README.md

@@ -5,6 +5,9 @@ This project converts doxygen XML output to asciidoc.
 Allowed args:
 
 `-f`: the full path to the file to be converted
+
+`-o`: the full path the the output file (will print to STDOUT if not specified)
+
 `-c`: process a node other than `doxygenindex`
 
-The following attributes from the XML will be preserved in the generated asciidoc: role, tag, type.
+The following attributes from the XML will be preserved in the generated asciidoc: role, tag, type.

cli.py

@@ -8,28 +8,31 @@
 
 
 def main():
-    """Convert the given Doxygen index.xml to AsciiDoc and print the result."""
+    """Convert the given Doxygen index.xml to AsciiDoc and output the result."""
     parser = argparse.ArgumentParser()
     parser.add_argument("-f", "--file", help="The path of the file to convert", default=None)
+    parser.add_argument("-o", "--output", help="The path of the output file", default=None)
     parser.add_argument("-c", "--child", help="Is NOT the root index file", default=False, action='store_true')
     args = parser.parse_args()
     filename = args.file
+    output_filename = args.output
     is_child = args.child
     if filename:
         xmldir = os.path.dirname(filename)
         with open(filename, encoding="utf-8") as xml:
             if is_child:
-                print(
-                    Node(
-                        BeautifulSoup(xml, "xml").doxygen, xmldir=xmldir
-                    ).to_asciidoc()
-                )
+                result = Node(
+                    BeautifulSoup(xml, "xml").doxygen, xmldir=xmldir
+                ).to_asciidoc()
             else:
-                print(
-                    DoxygenindexNode(
-                        BeautifulSoup(xml, "xml").doxygenindex, xmldir=xmldir
-                    ).to_asciidoc()
-                )
-
+                result = DoxygenindexNode(
+                    BeautifulSoup(xml, "xml").doxygenindex, xmldir=xmldir
+                ).to_asciidoc()
+        if output_filename is not None:
+            with open(output_filename, "w", encoding="utf-8") as output:
+                output.write(result)
+        else:
+            print(result)
+
     else:
         sys.exit(1)

requirements.txt

@@ -1,2 +1,3 @@
 PyYAML
-beautifulsoup4
+beautifulsoup4
+lxml