Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: wireviz/WireViz
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: master
Choose a base ref
...
head repository: laurierloi/WireViz
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
Can’t automatically merge. Don’t worry, you can still create the pull request.

Commits on Jan 19, 2023

  1. Bump version to 0.4-dev

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    4c97195 View commit details
  2. Bump version in generated files

    `.gv` and `.html` files include the version number as a comment.
    Rebuild to avoid diffs during development
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    211ded0 View commit details
  3. Squash feature/mate+autogenerate branch

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    e3fbc91 View commit details
  4. Resolve edge case of empty HTML tables

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    f20f313 View commit details
  5. Copy the full SHA
    def03d1 View commit details
  6. Update syntax description (autogeneration, arrows)

    Moved metadata and options info further down, so that the core functionality (connectors, cables, connection sets) comes first.
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    aa81c18 View commit details
  7. Copy the full SHA
    5cc133c View commit details
  8. Fix duplicates in syntax.md after rebase

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    22e75f9 View commit details
  9. Copy the full SHA
    bc5ef2e View commit details
  10. Simplify code

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    37cd08d View commit details
  11. Refactor functions for harness building

    - Use pin names instead of pin indices, until the last moment when generating the ports for the GraphViz nodes
    - `Harness.add_mate_pin()` now uses pin names
    - Remove unused `if is_arrow()` check from `Harness.connect()`
    - Consolidate calling of `Connector.activate_pin()` to prevent subtle bugs
      - Call it from `connect()` and `add_mate_pin()`
      - No longer call it from `create_graph()`
    - Misc. other tuning
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    d44b649 View commit details
  12. Implement template-based HTML output

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    a839a47 View commit details
  13. Add template metadata to demo02.yml

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    a9c1724 View commit details
  14. Add type hint

    Co-authored-by: kvid <kvid@users.noreply.github.com>
    2 people authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    ea89dd4 View commit details
  15. Apply fontname and bgcolor to output HTML

    Co-authored-by: kvid <kvid@users.noreply.github.com>
    2 people authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    cf5315d View commit details
  16. Copy the full SHA
    928f607 View commit details
  17. Copy the full SHA
    a80192b View commit details
  18. Use regex-based replacement

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    ef69d7e View commit details
  19. Update smart_file_resolve()

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    359cd8d View commit details
  20. Apply suggestions from code review

    Co-authored-by: kvid <kvid@users.noreply.github.com>
    2 people authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    e2f1a4e View commit details
  21. Apply suggestions from code review

    Co-authored-by: kvid <kvid@users.noreply.github.com>
    2 people authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    fd8749b View commit details
  22. Equalize line weights and simplify CSS

    Experiments in exporting PDF using `wkhtmltopdf` utility caused borders to disappear when set to 0.25mm, but 0.35mm renders fine
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    c1494db View commit details
  23. Copy the full SHA
    0192f6d View commit details
  24. Add explanatory comment

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    f78f83c View commit details
  25. Simplify main()

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    095a2a0 View commit details
  26. Simplify and clean up setup.py

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    628c80f View commit details
  27. Copy the full SHA
    ef6af32 View commit details
  28. Implement working proof of concept

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    7121a3e View commit details
  29. Remove unneeded code from wireviz.py

    Re-add `parse_file()` for building examples
    
    bla
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    d0909d4 View commit details
  30. Add CLI help strings

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    0764a8d View commit details
  31. Copy the full SHA
    a98e17b View commit details
  32. Fix entry point

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    f325b69 View commit details
  33. Copy the full SHA
    471a6c3 View commit details
  34. Implement image path resolver

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    a4a89eb View commit details
  35. Do not output .gv files by default

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    b9527a8 View commit details
  36. Fix smart file resolver for images

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    97207e6 View commit details
  37. Remove obsolete comments

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    7638425 View commit details
  38. Add main() to wireviz.py as fallback

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    63be33e View commit details
  39. Add encoding info to wv_cli.py

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    884b982 View commit details
  40. Sort --format flags alphabetically

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    0044997 View commit details
  41. Update README for new CLI commands

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    f87d9ef View commit details
  42. Copy the full SHA
    b8d74ba View commit details
  43. Improve REAME.md

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    8e31768 View commit details
  44. Split file output logic and object return logic

    Use `output_formats` parameter to specify which *files* to output to disk,
    Use `return_types` parameter to specify which objects to return to a calling Python script
    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    23db602 View commit details
  45. Copy the full SHA
    a9eb4f6 View commit details
  46. Add black profile for isort

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    3a18989 View commit details
  47. Apply isort

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    e6f76f9 View commit details
  48. Apply black

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    343cd29 View commit details
  49. Apply some manual fixes, reapply black

    17o2 authored and laurierloi committed Jan 19, 2023
    Copy the full SHA
    a255596 View commit details
  50. Copy the full SHA
    daff23c View commit details
Showing with 5,774 additions and 20,740 deletions.
  1. +3 −3 .github/workflows/main.yml
  2. +25 −10 .gitignore
  3. +1 −0 MANIFEST.in
  4. +3 −0 cleanup.sh
  5. +12 −0 devtools.txt
  6. +1 −0 docs/CONTRIBUTING.md
  7. +78 −30 docs/README.md
  8. +1 −1 docs/buildscript.md
  9. +18 −65 docs/syntax.md
  10. +84 −0 docs/tasks.md
  11. +37 −0 examples/11.yml
  12. +0 −4 examples/demo01.bom.tsv
  13. +0 −184 examples/demo01.gv
  14. +0 −210 examples/demo01.html
  15. BIN examples/demo01.png
  16. +0 −172 examples/demo01.svg
  17. +26 −0 examples/demo01.yml
  18. +0 −13 examples/demo02.bom.tsv
  19. +0 −549 examples/demo02.gv
  20. +0 −613 examples/demo02.html
  21. BIN examples/demo02.png
  22. +0 −512 examples/demo02.svg
  23. +40 −3 examples/demo02.yml
  24. +0 −3 examples/ex01.bom.tsv
  25. +0 −188 examples/ex01.gv
  26. +0 −209 examples/ex01.html
  27. BIN examples/ex01.png
  28. +0 −178 examples/ex01.svg
  29. +0 −5 examples/ex02.bom.tsv
  30. +0 −299 examples/ex02.gv
  31. +0 −306 examples/ex02.html
  32. BIN examples/ex02.png
  33. +0 −261 examples/ex02.svg
  34. +0 −5 examples/ex03.bom.tsv
  35. +0 −255 examples/ex03.gv
  36. +0 −276 examples/ex03.html
  37. BIN examples/ex03.png
  38. +0 −231 examples/ex03.svg
  39. +0 −8 examples/ex04.bom.tsv
  40. +0 −251 examples/ex04.gv
  41. +0 −285 examples/ex04.html
  42. BIN examples/ex04.png
  43. +0 −219 examples/ex04.svg
  44. +3 −4 examples/ex04.yml
  45. +0 −6 examples/ex05.bom.tsv
  46. +0 −317 examples/ex05.gv
  47. +0 −353 examples/ex05.html
  48. BIN examples/ex05.png
  49. +0 −301 examples/ex05.svg
  50. +3 −0 examples/ex05.yml
  51. +0 −6 examples/ex06.bom.tsv
  52. +0 −713 examples/ex06.gv
  53. +0 −713 examples/ex06.html
  54. BIN examples/ex06.png
  55. +0 −661 examples/ex06.svg
  56. +0 −4 examples/ex07.bom.tsv
  57. +0 −129 examples/ex07.gv
  58. +0 −143 examples/ex07.html
  59. BIN examples/ex07.png
  60. +0 −105 examples/ex07.svg
  61. +0 −3 examples/ex08.bom.tsv
  62. +0 −150 examples/ex08.gv
  63. +0 −144 examples/ex08.html
  64. BIN examples/ex08.png
  65. +0 −113 examples/ex08.svg
  66. +0 −4 examples/ex09.bom.tsv
  67. +0 −527 examples/ex09.gv
  68. +0 −562 examples/ex09.html
  69. BIN examples/ex09.png
  70. +0 −524 examples/ex09.svg
  71. +0 −3 examples/ex10.bom.tsv
  72. +0 −302 examples/ex10.gv
  73. +0 −358 examples/ex10.html
  74. BIN examples/ex10.png
  75. +0 −327 examples/ex10.svg
  76. +31 −0 examples/metadata.yml
  77. +2 −0 pyproject.toml
  78. +5 −0 requirements.txt
  79. +37 −33 setup.py
  80. +0 −353 src/wireviz/DataClasses.py
  81. +0 −449 src/wireviz/Harness.py
  82. +4 −4 src/wireviz/__init__.py
  83. +0 −158 src/wireviz/build_examples.py
  84. +31 −0 src/wireviz/hypertext.py
  85. +63 −0 src/wireviz/image.py
  86. +100 −0 src/wireviz/index_table.py
  87. +213 −0 src/wireviz/metadata.py
  88. +35 −0 src/wireviz/notes.py
  89. +76 −0 src/wireviz/numbers.py
  90. +85 −0 src/wireviz/page_options.py
  91. +138 −0 src/wireviz/parse_yaml.py
  92. +205 −0 src/wireviz/partnumber.py
  93. +16 −0 src/wireviz/templates/additional_components.html
  94. +75 −0 src/wireviz/templates/bom.html
  95. +81 −0 src/wireviz/templates/cable.html
  96. +47 −0 src/wireviz/templates/colors_macro.html
  97. +93 −0 src/wireviz/templates/component_table.html
  98. +31 −0 src/wireviz/templates/connector.html
  99. +55 −0 src/wireviz/templates/din-6771.html
  100. +29 −0 src/wireviz/templates/images.html
  101. +70 −0 src/wireviz/templates/index_table.html
  102. +55 −0 src/wireviz/templates/notes.html
  103. +84 −0 src/wireviz/templates/page.html
  104. +21 −0 src/wireviz/templates/simple-connector.html
  105. +26 −0 src/wireviz/templates/simple.html
  106. +204 −0 src/wireviz/templates/titleblock.html
  107. +21 −0 src/wireviz/templates/titlepage.html
  108. +155 −0 src/wireviz/tools/build_examples.py
  109. +323 −233 src/wireviz/wireviz.py
  110. +301 −200 src/wireviz/wv_bom.py
  111. +242 −0 src/wireviz/wv_cli.py
  112. +240 −176 src/wireviz/wv_colors.py
  113. +870 −0 src/wireviz/wv_dataclasses.py
  114. +109 −0 src/wireviz/wv_graphviz.py
  115. +0 −76 src/wireviz/wv_gv_html.py
  116. +433 −0 src/wireviz/wv_harness.py
  117. +91 −0 src/wireviz/wv_harness_quantity.py
  118. +0 −118 src/wireviz/wv_helper.py
  119. +123 −52 src/wireviz/wv_html.py
  120. +223 −0 src/wireviz/wv_output.py
  121. +12 −0 src/wireviz/wv_templates.py
  122. +128 −0 src/wireviz/wv_utils.py
  123. +8 −0 tests/.gitignore
  124. +65 −0 tests/bom/bomqty.yml
  125. +26 −0 tests/rendering/00_minimal.yml
  126. +32 −0 tests/rendering/01_color_single.yml
  127. +35 −0 tests/rendering/02_color_multi.yml
  128. +51 −0 tests/rendering/03_bgcolors.yml
  129. +31 −0 tutorial/metadata.yml
  130. +4 −8 tutorial/readme.md
  131. +0 −3 tutorial/tutorial01.bom.tsv
  132. +0 −164 tutorial/tutorial01.gv
  133. +0 −170 tutorial/tutorial01.html
  134. BIN tutorial/tutorial01.png
  135. +0 −139 tutorial/tutorial01.svg
  136. +0 −3 tutorial/tutorial02.bom.tsv
  137. +0 −169 tutorial/tutorial02.gv
  138. +0 −180 tutorial/tutorial02.html
  139. BIN tutorial/tutorial02.png
  140. +0 −149 tutorial/tutorial02.svg
  141. +0 −3 tutorial/tutorial03.bom.tsv
  142. +0 −187 tutorial/tutorial03.gv
  143. +0 −207 tutorial/tutorial03.html
  144. BIN tutorial/tutorial03.png
  145. +0 −176 tutorial/tutorial03.svg
  146. +0 −4 tutorial/tutorial04.bom.tsv
  147. +0 −340 tutorial/tutorial04.gv
  148. +0 −345 tutorial/tutorial04.html
  149. BIN tutorial/tutorial04.png
  150. +0 −307 tutorial/tutorial04.svg
  151. +0 −6 tutorial/tutorial05.bom.tsv
  152. +0 −189 tutorial/tutorial05.gv
  153. +0 −236 tutorial/tutorial05.html
  154. BIN tutorial/tutorial05.png
  155. +0 −184 tutorial/tutorial05.svg
  156. +1 −2 tutorial/tutorial05.yml
  157. +0 −7 tutorial/tutorial06.bom.tsv
  158. +0 −177 tutorial/tutorial06.gv
  159. +0 −230 tutorial/tutorial06.html
  160. BIN tutorial/tutorial06.png
  161. +0 −171 tutorial/tutorial06.svg
  162. +1 −3 tutorial/tutorial06.yml
  163. +0 −6 tutorial/tutorial07.bom.tsv
  164. +0 −713 tutorial/tutorial07.gv
  165. +0 −713 tutorial/tutorial07.html
  166. BIN tutorial/tutorial07.png
  167. +0 −661 tutorial/tutorial07.svg
  168. +0 −11 tutorial/tutorial08.bom.tsv
  169. +0 −408 tutorial/tutorial08.gv
  170. +0 −468 tutorial/tutorial08.html
  171. BIN tutorial/tutorial08.png
  172. +0 −326 tutorial/tutorial08.svg
  173. +2 −3 tutorial/tutorial08.yml
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.7, 3.8]
python-version: ["3.8", "3.10"]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
@@ -22,11 +22,11 @@ jobs:
python -m pip install --upgrade pip
pip install .
- name: Create Examples
run: PYTHONPATH=$(pwd)/src:$PYTHONPATH cd src/wireviz/ && python build_examples.py
run: PYTHONPATH=$(pwd)/src:$PYTHONPATH && python src/wireviz/tools/build_examples.py
- name: Upload examples, demos, and tutorials
uses: actions/upload-artifact@v2
with:
name: examples-and-tutorials
path: |
examples/
tutorial/
tutorial/
35 changes: 25 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# OS-specific files
.DS_Store
.eggs
__pycache__
.*.swp
*.egg-info
*.pyc
build
data
dist
venv/
desktop.ini
thumbs.db
Thumbs.db

# Development aids
.idea/
temp/
venv/
.venv/

# Build/compile/release artifacts
build/
dist/
*.egg-info
*.pyc

# Other temporary files
__pycache__
.*.swp

# Built examples
examples/*
tutorial/*
outputs/*
!examples/*.yml
!tutorial/*.yml
!tutorial/*.md
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include src/wireviz/templates/*
3 changes: 3 additions & 0 deletions cleanup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
autoflake -i -r --remove-all-unused-imports src/wireviz/
isort src/wireviz/*.py src/wireviz/tools/*.py
black src/wireviz/*.py src/wireviz/tools/*.py
12 changes: 12 additions & 0 deletions devtools.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# The following tools have proven useful during development
# Feel free to install while inside the WireViz virtualenv, using:
# pip install -r devtools.txt

# Code formatting
black # black src/wireviz/*.py
isort # isort src/wireviz/*py

# Development aids
pudb # import pudb; pudb.set_trace()
autoflake # autoflake -i --remove-all-unused-imports src/wireviz/*.py
pyan # pyan3 src/wireviz/*.py -uncge --html > temp/pyan.html
1 change: 1 addition & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -25,6 +25,7 @@ When contributing to this repository, please [submit a new issue](https://github
1. Create a new feature branch on top of the `dev` branch.
1. Commit your code changes to this feature branch.
1. Push the changes to your fork.
1. Please format your code using [`isort`](https://pycqa.github.io/isort/) and [`black`](https://black.readthedocs.io) before submitting.
1. Submit a new pull request, using `dev` as the base branch.
- If your code changes or extends the WireViz YAML syntax, be sure to update the [syntax description document](https://github.com/formatc1702/WireViz/blob/dev/docs/syntax.md) in your PR.
1. Please include in the PR description (and optionally also in the commit message body) a reference (# followed by issue number) to the issue where the suggested changes are discussed.
108 changes: 78 additions & 30 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@
[![PyPI - Version](https://img.shields.io/pypi/v/wireviz.svg?colorB=blue)](https://pypi.org/project/wireviz/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wireviz.svg?)](https://pypi.org/project/wireviz/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/wireviz)](https://pypi.org/project/wireviz/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Summary

@@ -81,71 +82,118 @@ Output file:
[Source](../examples/demo02.yml) - [Bill of Materials](../examples/demo02.bom.tsv)
### Tutorial and example gallery
### Syntax, tutorial and example gallery
See the [tutorial page](../tutorial/readme.md) for sample code,
as well as the [example gallery](../examples/readme.md) to see more of what WireViz can do.
Read the [syntax description](syntax.md) to learn about WireViz' features and how to use them.
See the [tutorial page](../tutorial/readme.md) for sample code, as well as the [example gallery](../examples/readme.md) to see more of what WireViz can do.
## Usage
### Installation
#### Requirements
## Installation
### Requirements
WireViz requires Python 3.7 or later.
WireViz requires Python 3.7 or later (3.8 to support pdf).
WireWiz requires GraphViz to be installed in order to work. See the [GraphViz download page](https://graphviz.org/download/) for OS-specific instructions.
_Note_: Ubuntu 18.04 LTS users in particular may need to separately install Python 3.7 or above, as that comes with Python 3.6 as the included system Python install.
_Note_: Ubuntu 18.04 LTS users in particular may need to separately install Python 3.7 or above, as that comes with Python 3.6 as the included system Python install. The option to generate pdf is not supported for python 3.7, so it might not be possible to use with this version of Ubuntu. If you are forced to use Ubuntu 18.04 for some reason, fill up an issue/MR and I can provide a Docker image to perform the generation.
#### Installing the latest release
#### Debian Dependencies
```
sudo apt install graphviz
```

The latest WireViz release can be downloaded from [PyPI](https://pypi.org/project/wireviz/) with the following command:
#### Fedora Dependencies
```
sudo dnf install graphviz
```

#### Pango (only for weasyprint pdf generation)

See https://pango.gnome.org/


### Installing the latest release

~~The latest WireViz release can be downloaded from [PyPI](https://pypi.org/project/wireviz/) with the following command:~~
```
pip3 install wireviz
```

#### Installing the development version
Note: The https://github.com/laurierloi/WireViz version sadly can't be downloaded from pypi at
this time. If you have this need, submit a MR and it could be added under a different name.

Access to the current state of the development branch can be gained by cloning the repo and installing manually:
### Installing the development version

Access to the current state of the development branch can be gained by cloning the repo and installing manually.

We suggest always installing wireviz within a python virtualenv. This avoids many issues caused by
dependencies management.

#### Installing wireviz within a virtual env
```
git clone <repo url>
cd <working copy>
git checkout dev
pip3 install -e .
# Cloning the repository
git clone git+https://github.com/laurierloi/WireViz
cd WireViz
# Setup virtualenv
python3 -m pip install --user virtualenv
python3 -m virtualenv venv-wireviz
source venv-wireviz/bin/activate
# Installing/Upgrading dependencies
pip install -U pip setuptools wheel
# Installing with local modification tracking
pip install -e .
```

If you would like to contribute to this project, make sure you read the [contribution guidelines](CONTRIBUTING.md)!

## Usage

### How to run
The latest version of wireviz allows the user to create harness documents.
To do so, a shared metadata file (or multiple) must be provided to the wireviz command.
Then, a list of harnesses to include within the document should also be provided.
In the simplest case, 1 harness can be provided.

```
$ wireviz ~/path/to/file/mywire.yml
$ wireviz -d ~/path/to/file/metadata.yml ~/path/to/file/myharness1.yml ~/path/to/file/myharness2.yml
```

This will output the following files
Depending on the options specified, this will output some or all of the following files:

```
titlepage.html Titlepage document. It has links to the different harness for easy navigation
shared_bom.tsv A BOM (bill of materials) for all items within the harness document
myharness{1,2}.gv GraphViz output
myharness{1,2}.svg Wiring diagram as vector image
myharness{1,2}.png Wiring diagram as raster image
myharness{1,2}.bom.tsv BOM (bill of materials) as tab-separated text file
myharness{1,2}.html HTML page with wiring diagram and BOM embedded
```

Wildcars in the file path are also supported to process multiple files at once, e.g.:
```
mywire.gv GraphViz output
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.html HTML page with wiring diagram and BOM embedded
$ wireviz ~/path/to/files/*.yml
```

#### Command line options
To see how to specify the output formats, as well as additional options, run:

```
$ wireviz --help
```

- `--prepend-file <FILE>` to prepend an additional YAML file. Useful for part libraries and templates shared among multiple cables/harnesses.
- `-o <OUTPUT>` or `--output_file <OUTPUT>` to generate output files with a name different from the input file.
- `-V` or `--version` to display the WireViz version.
- `-h` or `--help` to see a summary of the usage help text.
#### Sample run all examples

```
$ wireviz -d examples/metadata.yml examples/ex*.yml
```

### Syntax description
Then open `examples/titlepage.html` to open the document root

A description of the WireViz YAML input syntax can be found [here](syntax.md).


### (Re-)Building the example projects
2 changes: 1 addition & 1 deletion docs/buildscript.md
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ Possible group names:
- `tutorial` to process`tutorial/{readme.md,tutorial*.*}`
- `demos` to process`examples/demo*.*`

Affected filetypes: `.gv`, `.bom.tsv`, `.png`, `.svg`, `.html`
Affected filetypes: `.gv`, `.tsv`, `.png`, `.svg`, `.html`


## Usage hints
Loading