Added report generation (for design house)

Related to #93

CHANGELOG.md

@@ -60,6 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for `--subst-models` option for KiCad 6's kicad2step. (#137)
 - Added global options to define the PCB details (`pcb_material`,
   `solder_mask_color`, `silk_screen_color` and `pcb_finish`)
+- Report generation (for design house) (#93)
 
 ### Changed
 - Internal BoM: now components with different Tolerance, Voltage, Current

MANIFEST.in

@@ -1,3 +1,4 @@
 include MANIFEST.in
 include LICENSE
 include README.md
+include kibot/report_templates/*.txt

README.md

@@ -1771,6 +1771,25 @@ Next time you need this list just use an alias, like this:
     - `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
     - `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
 
+* Design report
+  * Type: `report`
+  * Description: Generates a report about the design.
+                 Mainly oriented to be sent to the manufacturer or check PCB details.
+  * Valid keys:
+    - `comment`: [string=''] A comment for documentation purposes.
+    - `dir`: [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir.
+    - `disable_run_by_default`: [string|boolean] Use it to disable the `run_by_default` status of other output.
+                                Useful when this output extends another and you don't want to generate the original.
+                                Use the boolean true value to disable the output you are extending.
+    - `extends`: [string=''] Copy the `options` section from the indicated output.
+    - `name`: [string=''] Used to identify this particular output definition.
+    - `options`: [dict] Options for the `report` output.
+      * Valid keys:
+        - `output`: [string='%f-%i%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options.
+        - `template`: [string='full'] Name for one of the internal templates (full, simple) or a custom template file.
+    - `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
+    - `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
+
 * Schematic with variant generator
   * Type: `sch_variant`
   * Description: Creates a copy of the schematic with all the filters and variants applied.

docs/samples/generic_plot.kibot.yaml

@@ -1232,6 +1232,18 @@ outputs:
       # Same result as using the mouse wheel in the 3D viewer
       zoom: 0
 
+  # Design report:
+  # Mainly oriented to be sent to the manufacturer or check PCB details.
+  - name: 'report_example'
+    comment: 'Generates a report about the design.'
+    type: 'report'
+    dir: 'Example/report_dir'
+    options:
+      # [string='%f-%i%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options
+      output: '%f-%i%v.%x'
+      # [string='full'] Name for one of the internal templates (full, simple) or a custom template file
+      template: 'full'
+
   # Schematic with variant generator:
   # This copy isn't intended for development.
   # Is just a tweaked version of the original where you can look at the results.