wireviz · slightlynybbled · Jun 28, 2020 · Jun 28, 2020 · Jun 29, 2020 · Jun 29, 2020
diff --git a/README.md b/README.md
@@ -100,10 +100,11 @@ $ wireviz ~/path/to/file/mywire.yml
 This will output the following files
 
 ```
-mywire.gv         GraphViz output
+mywire.gv         Raw GraphViz DOT file output of wiring diagram
 mywire.svg        Wiring diagram as vector image
 mywire.png        Wiring diagram as raster image
 mywire.bom.tsv    BOM (bill of materials) as tab-separated text file
+mywire.bom.csv    BOM (bill of materials) as comma-separated, excel-format text file
 mywire.html       HTML page with wiring diagram and BOM embedded
 ```
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
 .
+click
 graphviz
 pyyaml
 setuptools
diff --git a/setup.py b/setup.py
@@ -6,13 +6,20 @@
 
 project_name = 'wireviz'
 
+# utility function to read the requirements.txt file
+with open('requirements.txt', 'r') as f:
+    requirements = f.readlines()
+    requirements = [r.strip() for r in requirements]
+    requirements = [r for r in requirements if r != '.']
+
 # Utility function to read the README file.
 # Used for the long_description.  It's nice, because now 1) we have a top level
 # README file and 2) it's easier to type in the README file than to put a raw
 # string in below ...
 def read(fname):
     return open(os.path.join(os.path.dirname(__file__), fname)).read()
 
+
 setup(
     name=project_name,
     version='0.1',
@@ -21,10 +28,7 @@ def read(fname):
     description='Easily document cables and wiring harnesses',
     long_description=read(os.path.join(os.path.dirname(__file__), 'README.md')),
     long_description_content_type='text/markdown',
-    install_requires=[
-        'pyyaml',
-        'graphviz',
-        ],
+    install_requires=requirements,
     license='GPLv3',
     keywords='cable connector hardware harness wiring wiring-diagram wiring-harness',
     url='https://github.com/formatc1702/WireViz',

diff --git a/src/wireviz/Harness.py b/src/wireviz/Harness.py
@@ -3,9 +3,9 @@
 
 from wireviz.DataClasses import Connector, Cable
 from graphviz import Graph
-from wireviz import wv_colors, wv_helper
+from wireviz import wv_colors, wv_helper, bom_helper
 from wireviz.wv_colors import get_color_hex
-from wireviz.wv_helper import awg_equiv, mm2_equiv, tuplelist2tsv, \
+from wireviz.wv_helper import awg_equiv, mm2_equiv, \
     nested_html_table, flatten2d, index_if_list, html_line_breaks, \
     graphviz_line_breaks, remove_line_breaks, open_file_read, open_file_write, \
     manufacturer_info_field
@@ -68,7 +68,7 @@ def create_graph(self) -> Graph:
         font = 'arial'
         dot.attr('graph', rankdir='LR',
                  ranksep='2',
-                 bgcolor='white',
+                 bgcolor=wv_colors.COLOR_BACKGROUND,
                  nodesep='0.33',
                  fontname=font)
         dot.attr('node', shape='record',
@@ -276,6 +276,11 @@ def create_graph(self) -> Graph:
 
         return dot
 
+    @property
+    def gv(self):
+        # self.create_graph().save()
+        raise NotImplementedError
+
     @property
     def png(self):
         from io import BytesIO
@@ -294,50 +299,80 @@ def svg(self):
         data.seek(0)
         return data.read()
 
-    def output(self, filename: (str, Path), view: bool = False, cleanup: bool = True, fmt: tuple = ('pdf', )) -> None:
-        # graphical output
-        graph = self.create_graph()
-        for f in fmt:
-            graph.format = f
-            graph.render(filename=filename, view=view, cleanup=cleanup)
-        graph.save(filename=f'{filename}.gv')
-        # bom output
-        bom_list = self.bom_list()
-        with open_file_write(f'{filename}.bom.tsv') as file:
-            file.write(tuplelist2tsv(bom_list))
-        # HTML output
-        with open_file_write(f'{filename}.html') as file:
-            file.write('<!DOCTYPE html>\n')
-            file.write('<html><head><meta charset="UTF-8"></head><body style="font-family:Arial">')
-
-            file.write('<h1>Diagram</h1>')
-            with open_file_read(f'{filename}.svg') as svg:
-                file.write(re.sub(
-                    '^<[?]xml [^?>]*[?]>[^<]*<!DOCTYPE [^>]*>',
-                    '<!-- XML and DOCTYPE declarations from SVG file removed -->',
-                    svg.read(1024), 1))
-                for svgdata in svg:
-                    file.write(svgdata)
-
-            file.write('<h1>Bill of Materials</h1>')
-            listy = flatten2d(bom_list)
-            file.write('<table style="border:1px solid #000000; font-size: 14pt; border-spacing: 0px">')
-            file.write('<tr>')
-            for item in listy[0]:
-                file.write(f'<th align="left" style="border:1px solid #000000; padding: 8px">{item}</th>')
-            file.write('</tr>')
-            for row in listy[1:]:
-                file.write('<tr>')
-                for i, item in enumerate(row):
-                    item_str = item.replace('\u00b2', '&sup2;')
-                    align = 'align="right"' if listy[0][i] == 'Qty' else ''
-                    file.write(f'<td {align} style="border:1px solid #000000; padding: 4px">{item_str}</td>')
-                file.write('</tr>')
-            file.write('</table>')
-
-            file.write('</body></html>')
-
-    def bom(self):
+    @property
+    def html(self):
+        bom_list = self._bom_list()
+        string = ''
+
+        string += '<!DOCTYPE html>\n'
+        string += f'<html><head><meta charset="UTF-8"></head><body style="font-family:Arial;background-color:{wv_colors.COLOR_BACKGROUND}">'
+
+        string += '<h1>Diagram</h1>'
+
+        svg = self.svg.decode('utf-8')
+        svg = re.sub(
+            '^<[?]xml [^?>]*[?]>[^<]*<!DOCTYPE [^>]*>',
+            '<!-- XML and DOCTYPE declarations from SVG file removed -->',
+            svg)
+        for svgdata in svg:
+            string += svgdata
+
+        string += '<h1>Bill of Materials</h1>'
+        listy = flatten2d(bom_list)
+        string += '<table style="border:1px solid #000000; font-size: 14pt; border-spacing: 0px">'
+        string += '<tr>'
+        for item in listy[0]:
+            string += f'<th align="left" style="border:1px solid #000000; padding: 8px">{item}</th>'
+        string += '</tr>'
+        for row in listy[1:]:
+            string += '<tr>'
+            for i, item in enumerate(row):
+                item_str = item.replace('\u00b2', '&sup2;')
+                align = 'align="right"' if listy[0][i] == 'Qty' else ''
+                string += f'<td {align} style="border:1px solid #000000; padding: 4px">{item_str}</td>'
+            string += '</tr>'
+        string += '</table>'
+
+        string += '</body></html>'
+
+        return bytes(string, encoding='utf-8')
+
+    @property
+    def csv(self):
+        return bom_helper.generate_bom_outputs(
+            self._bom_list(),
+            'csv'
+        )
+
+    @property
+    def csv_excel(self):
+        return bom_helper.generate_bom_outputs(
+            self._bom_list(),
+            'csv_excel'
+        )
+
+    @property
+    def csv_unix(self):
+        return bom_helper.generate_bom_outputs(
+            self._bom_list(),
+            'csv_unix'
+        )
+
+    @property
+    def tsv(self):
+        return bom_helper.generate_bom_outputs(
+            self._bom_list(),
+            'tsv'
+        )
+
+    @property
+    def tsv_excel(self):
+        return bom_helper.generate_bom_outputs(
+            self._bom_list(),
+            'tsv_excel'
+        )
+
+    def _bom(self):
         bom = []
         bom_connectors = []
         bom_cables = []
@@ -417,8 +452,8 @@ def bom(self):
         bom.extend(bom_extra)
         return bom
 
-    def bom_list(self):
-        bom = self.bom()
+    def _bom_list(self):
+        bom = self._bom()
         keys = ['item', 'qty', 'unit', 'designators'] # these BOM columns will always be included
         for fieldname in ['pn', 'manufacturer', 'mpn']: # these optional BOM columns will only be included if at least one BOM item actually uses them
             if any(fieldname in x and x.get(fieldname, None) for x in bom):

diff --git a/src/wireviz/bom_helper.py b/src/wireviz/bom_helper.py
@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import csv
+from io import StringIO
+
+from wireviz import wv_helper
+
+WIREVIZ_TSV = type('Wireviz BOM', (csv.Dialect, object), dict(
+    delimiter='\t',
+    doublequote=True,
+    escapechar=None,
+    lineterminator='\n',
+    quoting=0,
+    skipinitialspace=False,
+    strict=False,
+    quotechar='"'
+))
+csv.register_dialect('Wireviz BOM', WIREVIZ_TSV)
+
+
+def generate_bom_outputs(bomdata, dialect='tsv'):
+    dialect = dialect.strip().lower()
+    dialect_lookup = {
+        'csv': csv.unix_dialect,
+        'csv_unix': csv.unix_dialect,
+        'csv_excel': csv.excel,
+        'tsv': WIREVIZ_TSV,
+        'tsv_excel': csv.excel_tab
+    }
+    valid_dialects = [k for k in dialect_lookup.keys()]
+    if dialect not in valid_dialects:
+        raise ValueError(f'dialect "{dialect}" not supported')
+
+    output = StringIO()
+    writer = csv.writer(output, dialect=dialect_lookup[dialect])
+    writer.writerows(wv_helper.flatten2d(bomdata))
+
+    output.seek(0)
+
+    return bytes(output.read(), encoding='utf-8')
+
+# TODO: Possibly refactor other BOM output operations, such as HTML, into here?
diff --git a/src/wireviz/build_examples.py b/src/wireviz/build_examples.py
@@ -10,7 +10,7 @@
 
 sys.path.insert(0, str(script_path.parent.parent))  # to find wireviz module
 from wireviz import wireviz
-from wv_helper import open_file_write, open_file_read, open_file_append
+from wireviz.wv_helper import open_file_write, open_file_read, open_file_append
 
 
 readme = 'readme.md'
@@ -61,7 +61,7 @@ def build_generated(groupkeys):
         # collect and iterate input YAML files
         for yaml_file in collect_filenames('Building', key, input_extensions):
             print(f'  "{yaml_file}"')
-            wireviz.parse_file(yaml_file)
+            wireviz.main(yaml_file, prepend=None, out=['png', 'svg', 'html', 'csv'])
 
             if build_readme:
                 i = ''.join(filter(str.isdigit, yaml_file.stem))