Repository files navigation

WireViz-Web is a wrapper around the excellentWireViz byDaniel Rojasfor bringing it to the web.

Originally, it has been conceived within aWireViz fork byJürgen Key.For compatibility withPlantUML, it includes aPlantUML Text Encoding formatdecoder byDyno Fu andRudi Yardley.

Thanks!

WireViz is a tool for easily documenting cables, wiring harnesses and connector pinouts.It takes plain text, YAML-formatted files as input and produces beautiful graphical output(SVG, PNG, ...) thanks toGraphviz.It handles automatic BOM (Bill of Materials) creation and has a lot of extra features.

WireViz-Web wraps WireViz with a REST API using Flask. It also provides specific renderingendpoints for PlantUML.

Install prerequisites:

{apt,brew,dnf,yum,zypper} install python3 graphviz

Install package:

pip install wireviz-web

Run server:

wireviz-web

Invoke requests:

# Acquire WireViz YAML file.wget https://raw.githubusercontent.com/daq-tools/wireviz-web/main/tests/demo01.yaml# Render images.http --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/svg+xmlhttp --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/png# Render HTML page with SVG image and BOM table.http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/html# Render BOM in TSV format.http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/plain# Render BOM in JSON format.http --form http://localhost:3005/render yml_file@demo01.yaml Accept:application/json# Render a PlantUML request.http http://localhost:3005/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==http http://localhost:3005/plantuml/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==

For visiting the Swagger OpenAPI spec, go tohttp://localhost:3005/doc.

Every kind of contribution, feedback, or patch, is much welcome.Create anissue or submit a patch if you think we should include a new feature, or toreport or fix a bug.

In order to follow the general development discussion, please seeBringingWireViz to the Web.

In order to setup a development environment on your workstation, please headover to thedevelopment sandbox documentation. When you see the softwaretests succeed, you should be ready to start hacking.

• Source code repository
• Documentation
• Python Package Index (PyPI)

The project is licensed under the terms of the GNU AGPL license.