Merge branch 'dev'

.github/workflows/main.yml

@@ -0,0 +1,25 @@
+name: Create Examples
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Setup Graphviz
+      uses: ts-graphviz/setup-graphviz@v1
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+    - name: Create Examples
+      run: PYTHONPATH=$(pwd)/src:$PYTHONPATH cd src/wireviz/ && python build_examples.py

TODO

@@ -1,49 +0,0 @@
-# To-do:
-
-## Support for more connector types
-
-* Inline connectors (IDC)
-  * Possibly join two logical wires into one physical wire, add up length for BOM creation
-  * Designators like W1_1, W1_2 or similar to group them?
-
-## Support for more wire types
-
-* Coax cables
-  * Graphical representation
-* Twisted pairs
-  * Logical representation
-  * Graphical representation
-* Ribbon cables
-  * Folds
-  * Splits
-  * Orientation of IDC connectors
-
-## Support for more links/connections
-
-* Cable splicing
-  * as pseudo-connector?
-* Heatshrink / sheathing
-
-## Visualization
-
-* Parse and render double-colored, striped cables ('RDBU' etc)
-* Display picture of connector underneath (including pin 1 location)
-
-## Export
-
-* Export to PDF with frame, title block, ...
-
-## Other
-
-* Improve tutorial texts
-* Create syntax reference / cheat sheet
-* Set global parameters (show_pins, ...) and allow override on per-item basis
-* Allow custom GraphViz code before/after WireViz-generated code
-* Make "unit tests" for different features/situations
-  * Missing parameters
-  * Connection formats
-    * single wire       1
-    * multiple wires    [1,2,3]
-    * wire ranges       [1-10]
-  * Loops
-  * ...

src/wireviz/wireviz.py

@@ -513,7 +513,7 @@ def parse(yaml_input, file_out=None, generate_bom=False):
     # add connections
     ferrule_counter = 0
     for con in yaml_data['connections']:
-        if len(con) == 3: # format: connector -- cable -- conector
+        if len(con) == 3: # format: connector -- cable -- connector
 
             for c in con:
                 if len(list(c.keys())) != 1: # check that each entry in con has only one key, which is the designator

tutorial/readme.md

@@ -221,7 +221,7 @@ connections:
   - # attach ferrules
     - F1 # no need for list of connections; one ferrule per wire is auto-generated and attached
     - W1: [1-4] # a new ferrule is auto-generated for each wire
-  - # attach connectors (separetely from ferrules)
+  - # attach connectors (separately from ferrules)
     - W1: [1-4]
     - X1: [1-4]
 ```
@@ -262,7 +262,7 @@ ferrules: # ferrules
 
 cables:
   W1:
-    category: bundle # budnle
+    category: bundle # bundle
     length: 0.3
     gauge: 0.5 mm2
     colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit
@@ -271,7 +271,7 @@ connections:
   - # attach ferrules
     - F_05
     - W1: [1,4] # a new ferrule is auto-generated for each wire
-  - # attach connectors (separetely from ferrules)
+  - # attach connectors (separately from ferrules)
     - W1: [1-4]
     - X1: [1-4]
   -

tutorial/tutorial05.yml

@@ -21,6 +21,6 @@ connections:
   - # attach ferrules
     - F1 # no need for list of connections; one ferrule per wire is auto-generated and attached
     - W1: [1-4] # a new ferrule is auto-generated for each wire
-  - # attach connectors (separetely from ferrules)
+  - # attach connectors (separately from ferrules)
     - W1: [1-4]
     - X1: [1-4]

tutorial/tutorial06.yml

@@ -17,7 +17,7 @@ ferrules: # ferrules
 
 cables:
   W1:
-    category: bundle # budnle
+    category: bundle # bundle
     length: 0.3
     gauge: 0.5 mm2
     colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit
@@ -26,7 +26,7 @@ connections:
   - # attach ferrules
     - F_05
     - W1: [1,4] # a new ferrule is auto-generated for each wire
-  - # attach connectors (separetely from ferrules)
+  - # attach connectors (separately from ferrules)
     - W1: [1-4]
     - X1: [1-4]
   -