Adding a command line interface

hpxml_version_translator/__init__.py

@@ -0,0 +1,23 @@
+import argparse
+from hpxml_version_translator.converter import convert_hpxml2_to_3
+import sys
+
+
+def main(argv=sys.argv[1:]):
+    parser = argparse.ArgumentParser(description='HPXML Version Translator, convert an HPXML v2.x file to 3.0')
+    parser.add_argument(
+        'hpxml_input',
+        help='Filename of hpxml v2.x file'
+    )
+    parser.add_argument(
+        '-o', '--output',
+        type=argparse.FileType('wb'),
+        default=sys.stdout.buffer,
+        help='Filename of output HPXML v3 file. If not provided, will go to stdout'
+    )
+    args = parser.parse_args(argv)
+    convert_hpxml2_to_3(args.hpxml_input, args.output)
+
+
+if __name__ == '__main__':
+    main()

hpxml_version_translator/__main__.py

@@ -0,0 +1,3 @@
+from . import main
+
+main()

setup.py

@@ -31,4 +31,9 @@
         ]
     },
     python_requires='>=3.6',
+    entry_points={
+        'console_scripts': [
+            'hpxml_version_translator=hpxml_version_translator:main'
+        ]
+    }
 )

test/test_converter.py

@@ -1,10 +1,12 @@
+import io
 from lxml import objectify
 import pathlib
 import pytest
 import tempfile
 
 from hpxml_version_translator.converter import convert_hpxml2_to_3
 from hpxml_version_translator import exceptions as exc
+from hpxml_version_translator import main
 
 
 hpxml_dir = pathlib.Path(__file__).resolve().parent / 'hpxml_files'
@@ -613,6 +615,21 @@ def test_deprecated_items():
     assert wh2.AnnualEnergyUse.ConsumptionInfo.ConsumptionDetail.Consumption == 600
 
 
+def test_cli(capsysbinary):
+    with tempfile.TemporaryDirectory() as tmpdir:
+        tmppath = pathlib.Path(tmpdir).resolve()
+        input_filename = str(hpxml_dir / 'version_change.xml')
+        output_filename = str(tmppath / 'out.xml')
+        main([input_filename, '-o', output_filename])
+        root = objectify.parse(output_filename).getroot()
+        assert root.attrib['schemaVersion'] == '3.0'
+
+    main([input_filename])
+    f = io.BytesIO(capsysbinary.readouterr().out)
+    root = objectify.parse(f).getroot()
+    assert root.attrib['schemaVersion'] == '3.0'
+
+
 def test_desuperheater_flexibility():
     root = convert_hpxml_and_parse(hpxml_dir / 'desuperheater_flexibility.xml')