Skip to main content

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

Project description

https://github.com/daq-tools/wireviz-web/workflows/Tests/badge.svg https://codecov.io/gh/daq-tools/wireviz-web/branch/main/graph/badge.svg https://img.shields.io/pypi/v/wireviz-web.svg https://pepy.tech/badge/wireviz-web/month https://img.shields.io/pypi/pyversions/wireviz-web.svg https://img.shields.io/pypi/status/wireviz-web.svg https://img.shields.io/github/license/daq-tools/wireviz-web

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

Usage

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+xml
http --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 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

License

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wireviz_web-0.4.1.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

wireviz_web-0.4.1-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file wireviz_web-0.4.1.tar.gz.

File metadata

  • Download URL: wireviz_web-0.4.1.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.11.0 Darwin/19.6.0

File hashes

Hashes for wireviz_web-0.4.1.tar.gz
Algorithm Hash digest
SHA256 56a27a52f94bb9887920dc146f6dd553b674b23e321fabf2e49606f239821f36
MD5 99f9dbea241dc4808fa15a905b125286
BLAKE2b-256 429039a2c39c16a36eb2fe1645f7fc20dae0d65ff5afefc72760fee061af31b6

See more details on using hashes here.

File details

Details for the file wireviz_web-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: wireviz_web-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.11.0 Darwin/19.6.0

File hashes

Hashes for wireviz_web-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1862126cdfce6ddb15e491af0bc408eaecb1ef0285fd285e77b9898aa554c31a
MD5 cebb9dbdab05aa5a15caf54bc71a4cbd
BLAKE2b-256 1332db19018b0dd5515bbae652a7194dbad5bad98d1bc707a72a4a01f2b8dd8b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page