wireviz-web 0.4.3

A wrapper around WireViz for bringing it to the web. Easily document cables and wiring harnesses.

About

WireViz-Web is a wrapper around the excellent WireViz by Daniel Rojas for bringing it to the web.

Originally, it has been conceived within a WireViz fork by Jürgen Key. For compatibility with PlantUML, it includes a PlantUML Text Encoding format decoder by Dyno Fu and Rudi Yardley.

Thanks!

Details

WireViz

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 to Graphviz. It handles automatic BOM (Bill of Materials) creation and has a lot of extra features.

WireViz-Web

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

Setup

Install prerequisites:

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

Install package:

pip install wireviz-web

Container

Use Docker or Podman:

docker run --rm --publish 3005:3005 ghcr.io/wireviz/wireviz-web:latest --listen 0.0.0.0:3005

Use Docker Compose or Podman Compose:

services:
  wireviz-web:
    image: ghcr.io/wireviz/wireviz-web:latest
    environment:
      WIREVIZ_LISTEN: 0.0.0.0:3005
    ports:
      - "3005:3005"
    healthcheck:
      test: [ "CMD", "curl", "--fail", "http://localhost:3005/status" ]
      start_period: 2s
      interval: 10s

Usage

Run server:

wireviz-web

Run server, listening on all interfaces:

wireviz-web --listen=0.0.0.0:3005

Invoke requests:

# Acquire WireViz YAML file.
wget https://raw.githubusercontent.com/wireviz/wireviz-web/main/tests/demo01.yaml

# Render HTML page with SVG image and BOM table.
http --form http://localhost:3005/render [e-mail] Accept:text/html

# Render images.
http --form http://localhost:3005/render [e-mail] Accept:image/svg+xml
http --form http://localhost:3005/render [e-mail] Accept:image/png

# Render BOM in TSV format.
http --form http://localhost:3005/render [e-mail] Accept:text/plain

# Render BOM in JSON format.
http --form http://localhost:3005/render [e-mail] Accept:application/json

# Render a PlantUML request.
http http://localhost:3005/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==
http http://localhost:3005/plantuml/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==

Note

The http command used in the examples is the excellent HTTPie program.

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

Project information

Contributions

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

In order to follow the general development discussion, please see Bringing WireViz to the Web.

Development

In order to setup a development environment on your workstation, please head over to the development sandbox documentation. When you see the software tests succeed, you should be ready to start hacking.

Resources

• Source code repository

• Documentation

• Python Package Index (PyPI)

License

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