bom.py now generates bom.csv to allow costed BOMs to be made using a spreadsheet.

CHANGELOG.md

@@ -3,6 +3,14 @@
 This changelog is generated by `changelog.py` using manually added semantic version tags to classify commits as breaking changes, additions or fixes.
 
 
+### [v15.15.0](https://github.com/nophead/NopSCADlib/releases/tag/v15.15.0 "show release") Additions [...](https://github.com/nophead/NopSCADlib/compare/v15.14.2...v15.15.0 "diff with v15.14.2")
+*   2021-06-03 [`823f3b9`](https://github.com/nophead/NopSCADlib/commit/823f3b936e6c33897445d3f3272b69237f013537 "show commit") [C.P.](# "Chris Palmer") Add the ability to have a target specific top level module in place of `main_assembly()`.
+
+#### [v15.14.2](https://github.com/nophead/NopSCADlib/releases/tag/v15.14.2 "show release") Fixes [...](https://github.com/nophead/NopSCADlib/compare/v15.14.1...v15.14.2 "diff with v15.14.1")
+*   2021-06-02 [`749a1f0`](https://github.com/nophead/NopSCADlib/commit/749a1f0648196bd0ae47dbe93ac1b5e3a06d78cd "show commit") [C.P.](# "Chris Palmer") Fixed male thread z-fighting bug.
+
+*   2021-06-01 [`5c898df`](https://github.com/nophead/NopSCADlib/commit/5c898df2172a7e202c9e3d8c6641a0aaf95e5d48 "show commit") [C.P.](# "Chris Palmer") More readable code in `rounded_polygon`.
+
 #### [v15.14.1](https://github.com/nophead/NopSCADlib/releases/tag/v15.14.1 "show release") Fixes [...](https://github.com/nophead/NopSCADlib/compare/v15.14.0...v15.14.1 "diff with v15.14.0")
 *   2021-06-01 [`20d799a`](https://github.com/nophead/NopSCADlib/commit/20d799a3c115d3d32f101c4419d6e9b57c3be8c7 "show commit") [C.P.](# "Chris Palmer") `IEC_320_C14_switched_fused_inlet` now shows the correct object name in the example.
 

docs/usage.md

@@ -270,6 +270,22 @@ The target config file is selected by generating `target.scad` that includes `co
 The rest of the project includes `target.scad` to use the configuration.
 Additionally all the generated file directories (assemblies, bom, stls, dxfs, etc.) are placed in a sub-directory called `<target_name>`.
 
+The build system will look for a `<target_name>_assembly` module and use it as the top level module instead of `main_assembly` if it it exists.
+That allows the project description to be target specific if the top level modules are in different scad files.
+The top level assembly instructions and assembly contents could also be different if appropriate.
+
+If the top level module is just a shell wrapper that simply includes one other assembly, with no additional parts, then it is removed from the build instructions and
+the assembly it calls becomes the top level. This allows a different project description for each target but only one set of top level instructions without repeating them.
+
+### Costed BOMs
+
+A costed bill of materials can be made by opening the generated file `bom/bom.csv` in a spreadsheet program using a single quote as the string delimiter and comma as the field separator.
+That gets a list of part descriptions and quantities to which prices can be added to get the total cost and perhaps a URL of where to buy each part.
+
+If a Python file called `parts.py` is found then `bom.py` will attempt to call functions for each part to get a price and URL.
+Any functions not found are printed, so you can see the format expected.
+The function are passed the quantity to allow them to calculate volume discounts, etc.
+
 ### Other libraries
 
 The build scripts need to be able to locate the source files where the modules to generate the STL files and assemblies reside. They will search all the scad files

examples/MainsBreakOutBox/bom/bom.csv

@@ -0,0 +1,16 @@
+'Ferrule for 1.5mm^2 wire - not shown',  3
+'Wire blue 30/0.25mm strands, length 150mm - not shown',  2
+'Wire brown 30/0.25mm strands, length 150mm - not shown',  2
+'Wire green & yellow 30/0.25mm strands, length 150mm - not shown',  2
+'IEC inlet for ATX',  1
+'Heatfit insert M3',  2
+'4mm shielded jack socket blue',  2
+'4mm shielded jack socket brown',  1
+'4mm shielded jack socket green',  2
+'Mains socket 13A',  1
+'Nut M3 x 2.4mm nyloc',  6
+'Screw M3 cs cap x 12mm',  2
+'Screw M3 cs cap x 20mm',  2
+'Screw M3 dome x 10mm',  4
+'Heatshrink sleeving ID 3.2mm x 15mm - not shown',  8
+'Washer  M3 x 7mm x 0.5mm', 10

scripts/bom.py

@@ -31,6 +31,12 @@ from set_config import *
 import json
 import re
 
+try:
+    import parts
+    got_parts_py = True
+except:
+    got_parts_py = False
+
 def find_scad_file(mname):
     for filename in os.listdir(source_dir):
         if filename[-5:] == ".scad":
@@ -46,6 +52,18 @@ def find_scad_file(mname):
                             return filename
     return None
 
+def main_assembly(target):
+    file = None
+    if target:
+        assembly = target + "_assembly"
+        file = find_scad_file(assembly)
+    if not file:
+        assembly = "main_assembly"
+        file = find_scad_file(assembly)
+    if not file:
+        raise Exception("can't find source for " + assembly)
+    return assembly, file
+
 class Part:
     def __init__(self, args):
         self.count = 1
@@ -117,6 +135,33 @@ class BOM:
             return ass
         return ass.replace("assembly", "assemblies")
 
+    def print_CSV(self,  file = None):
+        i = 0
+        for part in sorted(self.vitamins):
+            i += 1
+            if ': ' in part:
+                part_no, description = part.split(': ')
+            else:
+                part_no, description = "", part
+            qty = self.vitamins[part].count
+            if got_parts_py:
+                match = re.match(r'^.*\((.*?)[,\)].*$', part_no)
+                if match and not match.group(1).startswith('"'):
+                    part_no = part_no.replace('(' + match.group(1), '_' + match.group(1) + '(').replace('(, ', '(')
+                func = 'parts.' + part_no.replace('(', '(%d, ' % qty).replace(', )', ')')
+                func = func.replace('true',  'True').replace('false', 'False').replace('undef', 'None')
+                try:
+                    price, url = eval(func)
+                    print("'%s',%3d,%.2f,'=B%d*C%d',%s" % (description, qty, price, i, i, url), file=file)
+                except:
+                    if part_no:
+                        print("%s not found in parts.py" % func)
+                    print("'%s',%3d" % (description, qty), file=file)
+            else:
+                print("'%s',%3d" % (description, qty), file=file)
+        if got_parts_py:
+            print(",'=SUM(B1:B%d)',,'=SUM(D1:D%d)'" %(i, i), file=file)
+
     def print_bom(self, breakdown, file = None):
         if self.vitamins:
             print("Vitamins:", file=file)
@@ -221,28 +266,20 @@ def parse_bom(file = "openscad.log", name = None):
     return main
 
 def usage():
-    print("\nusage:\n\tbom [target_config] [<accessory_name>_assembly] - Generate BOMs for a project or an accessory to a project.")
+    print("\nusage:\n\tbom [target_config] - Generate BOMs for a project.")
     sys.exit(1)
 
-def boms(target = None, assembly = None):
+def boms(target = None):
     try:
         bom_dir = set_config(target, usage) + "bom"
-        if assembly:
-            bom_dir += "/accessories"
-            if not os.path.isdir(bom_dir):
-                os.makedirs(bom_dir)
-        else:
-            assembly = "main_assembly"
-            if os.path.isdir(bom_dir):
-                shutil.rmtree(bom_dir)
-                sleep(0.1)
-            os.makedirs(bom_dir)
+        if os.path.isdir(bom_dir):
+            shutil.rmtree(bom_dir)
+            sleep(0.1)
+        os.makedirs(bom_dir)
         #
-        # Find the scad file that makes the module
+        # Find the scad file that makes the main assembly
         #
-        scad_file = find_scad_file(assembly)
-        if not scad_file:
-            raise Exception("can't find source for " + assembly)
+        assembly, scad_file = main_assembly(target)
         #
         # make a file to use the module
         #
@@ -259,8 +296,9 @@ def boms(target = None, assembly = None):
 
         main = parse_bom("openscad.echo", assembly)
 
-        if assembly == "main_assembly":
-            main.print_bom(True, open(bom_dir + "/bom.txt","wt"))
+        main.print_bom(True, open(bom_dir + "/bom.txt","wt"))
+
+        main.print_CSV(open(bom_dir + "/bom.csv","wt"))
 
         for ass in main.assemblies:
             with open(bom_dir + "/" + ass + ".txt", "wt") as f:
@@ -278,20 +316,8 @@ def boms(target = None, assembly = None):
         sys.exit(1)
 
 if __name__ == '__main__':
-    if len(sys.argv) > 3: usage()
+    if len(sys.argv) > 2: usage()
 
-    if len(sys.argv) == 3:
-        target, assembly = sys.argv[1], sys.argv[2]
-    else:
-        if len(sys.argv) == 2:
-            if sys.argv[1][-9:] == "_assembly":
-                target, assembly = None, sys.argv[1]
-            else:
-                target, assembly = sys.argv[1], None
-        else:
-            target, assembly = None, None
+    target = sys.argv[1] if len(sys.argv) == 2 else None
 
-    if assembly:
-        if assembly[-9:] != "_assembly": usage()
-
-    boms(target, assembly)
+    boms(target)

scripts/views.py

@@ -161,6 +161,7 @@ def views(target, do_assemblies = None):
     # Find all the scad files
     #
     main_blurb = None
+    main_assembly, main_file = bom.main_assembly(target)
     pngs = []
     for dir in source_dirs(bom_dir):
         if os.path.isdir(dir):
@@ -232,7 +233,7 @@ def views(target, do_assemblies = None):
                                                 update_image(tmp_name, tn_name)
                                     done_assemblies.append(real_name)
                                 else:
-                                    if module == 'main_assembly':
+                                    if module == main_assembly:
                                         main_blurb = blurb.scrape_module_blurb(lines[:line_no])
                         line_no += 1
     #
@@ -246,9 +247,6 @@ def views(target, do_assemblies = None):
         project = ' '.join(word[0].upper() + word[1:] for word in os.path.basename(os.getcwd()).split('_'))
         print('<a name="TOP"></a>', file = doc_file)
         print('# %s' % project, file = doc_file)
-        main_file = bom.find_scad_file('main_assembly')
-        if not main_file:
-            raise Exception("can't find source for main_assembly")
         text = blurb.scrape_blurb(source_dir + '/' + main_file)
         blurbs = blurb.split_blurb(text)
         if len(text):