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://img.shields.io/github/v/tag/daq-tools/wireviz-web.svg https://img.shields.io/pypi/dm/wireviz-web.svg https://img.shields.io/pypi/pyversions/wireviz-web.svg https://img.shields.io/badge/code%20style-black-000000.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 an URL query parameter 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.

Synopsis

Setup:

pip install wireviz-web

Invoke:

# Run server.
wireviz-web

# 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.

Tests

Invoke tests, optionally with coverage report:

poe test
poe coverage

Development

As this project is still in its infancy, we humbly ask for support from the community. Look around, give it a test drive and submit patches. There are always things to do.

Project details


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.2.0.tar.gz (21.0 kB view hashes)

Uploaded Source

Built Distribution

wireviz_web-0.2.0-py3-none-any.whl (32.9 kB view hashes)

Uploaded Python 3

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