From 69bc20a31e1eb851495ebca1e25fcd86c61b0726 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Sun, 28 Jun 2020 13:16:38 +0200 Subject: [PATCH 1/3] Remove TODO file, move to-do's to GitHub Projects --- TODO | 49 ------------------------------------------------- 1 file changed, 49 deletions(-) delete mode 100644 TODO diff --git a/TODO b/TODO deleted file mode 100644 index 619e1ec..0000000 --- a/TODO +++ /dev/null @@ -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 - * ... From eb65be39dcdf0428c19abcf5a8b0f0ff93855a58 Mon Sep 17 00:00:00 2001 From: Florian Pigorsch Date: Sun, 28 Jun 2020 14:55:09 +0200 Subject: [PATCH 2/3] Fix some typos: budnle, conector, separetely --- src/wireviz/wireviz.py | 2 +- tutorial/readme.md | 6 +++--- tutorial/tutorial05.yml | 2 +- tutorial/tutorial06.yml | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/wireviz/wireviz.py b/src/wireviz/wireviz.py index 85a0361..43b7613 100755 --- a/src/wireviz/wireviz.py +++ b/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 diff --git a/tutorial/readme.md b/tutorial/readme.md index 7b01e5b..dc7bbcb 100644 --- a/tutorial/readme.md +++ b/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] - diff --git a/tutorial/tutorial05.yml b/tutorial/tutorial05.yml index 148879b..e238f30 100644 --- a/tutorial/tutorial05.yml +++ b/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] diff --git a/tutorial/tutorial06.yml b/tutorial/tutorial06.yml index 2f2ab64..f69499c 100644 --- a/tutorial/tutorial06.yml +++ b/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] - From 6cf7178a9f0bea304d637f5aef10dde4d281c0c4 Mon Sep 17 00:00:00 2001 From: Florian Pigorsch Date: Sun, 28 Jun 2020 14:59:29 +0200 Subject: [PATCH 3/3] [ci] Setup Github actions to run 'build_examples.py' as a test on each pull/pull request. (#34) Co-authored-by: Florian Pigorsch --- .github/workflows/main.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..ec26b95 --- /dev/null +++ b/.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 \ No newline at end of file